# AI Apply
Source: https://docs.kombo.dev/ai-apply

Learn how you can use AI Apply to apply to any public job posting.

## Overview

AI Apply enables you to turn job posting URLs into an API surface for creating applications.

Our parser converts any application form into a standardized format that can be programmatically rendered and displayed to candidates.
Fields are parsed with all necessary metadata required to render a fully fledged application form.
Fields are categorized to enable auto-matching of common fields.

## Flows

### Creating a Career Site

The career site entity is a collection of job postings.
Create a new career site for each customer that you want to send applications to.

Creating a career site can be done via the [POST Career Sites](https://api.kombo.dev/docs/#/AI%20Apply/PostAiApplyCareerSites) endpoint, or in the dashboard.

### Parsing a Job Posting

Job posting parsing is asynchronous:

1. **Submit job URL**: [POST Job Postings](https://api.kombo.dev/docs/#/AI%20Apply/PostAiApplyPostings) endpoint (or via dashboard)

2. **Wait for processing**: Default concurrency limit of 5 jobs (reach out if you need higher limits)

3. **Receive webhook**: Get notified when parsing completes, or poll via [GET Job Postings](https://api.kombo.dev/docs/#/AI%20Apply/GetAiApplyPostings)

<Tip>
  **Learn about AI Apply webhooks:**

  View our dedicated [AI Apply Webhooks](/ai-apply-webhooks) page for more information on which webhooks are emitted and how to handle them.
</Tip>

Reach out if a job posting fails to parse successfully. We'll investigate and try to fix it as soon as possible.

#### Adding Query Parameters

Query parameters in the job posting URL affect how the application form is generated and should be handled strategically:

**Best Practice:** Include as many query parameters as possible in the original URL during parsing to maintain form consistency. In rare cases query parameters can affect which fields appear in the application form, so keeping them consistent ensures a stable experience for candidates.

For example, `?source=linkedin&utm_campaign=q1` in the parsing URL will:

* Be preserved throughout the application flow
* Potentially affect form field visibility or requirements
* Be combined with any additional parameters added during application submission

In addition, you can add application-specific query parameters (like user tracking IDs) during the `/apply` call. These will be merged with the original URL parameters.

#### Specifying Job Location

When submitting a job posting for parsing, you can optionally include location details such as the country and postal code.

Providing accurate location data ensures that applications submitted through AI Apply use the intended geolocation context. This can help avoid issues with geofencing or region-based restrictions during the submission process.

If your job postings target specific locations, we recommend always including this information to maximize successful application delivery.

**Examples**

For jobs in the US, specifying the postal code ensures state-level geofencing is properly circumvented:

```json theme={null}
{
  "career_site_id": "7pLGzNQ2yECSjFZHgDA6APAu",
  "url": "https://www.mybestjobs.com/job/0622",
  "location": {
    "country": "US",
    "postal_code": "94116"
  }
}
```

For jobs outside of the US, specifying the country itself is usually sufficient:

```json theme={null}
{
  "career_site_id": "FZYx8SKoVQG2Ksvpe5xFp49S",
  "url": "https://www.mybestjobs.com/job/5102",
  "location": {
    "country": "DE"
  }
}
```

### Bulk Imports

If you need to import large volumes of job postings at once, or receive data from third-party providers like recruiting agencies, use Job Feeds. Job Feeds automatically handle creating, updating, and archiving job postings based on your data.

See [Job Feeds and Bulk Imports](/ai-apply-job-feeds) for details.

### Sending Applications

Application submission is asynchronous:

1. **Get form & token**: [POST Inquiries](https://api.kombo.dev/docs/#/AI%20Apply/PostAiApplyPostingsPostingIdInquire) returns the live application form and a one-time submission token. The submission token can be used for one application, and is valid for 2 days

2. **Submit application**: [POST Apply](https://api.kombo.dev/docs/#/AI%20Apply/PostAiApplyApply) with candidate answers (consumes the token if successful)

3. **Receive webhook**

<Warning>
  #### QA Mode

  Applications that fail during the submission process *will not* immediately emit a failure webhook.

  Kombo will QA any failed application and ensure the error does not stem from the submission process. If it does, Kombo will manually submit the application and a success webhook will be emitted.

  Only after manual QA and confirmation that Kombo has no way of submitting the application, will a failure webhook be emitted.

  You can expect the turnaround time of application QA to be less than 24 hours.
</Warning>

#### Query Parameters in Applications

When submitting applications via the [POST Apply](https://api.kombo.dev/docs/#/AI%20Apply/PostAiApplyApply) endpoint, you can include additional query parameters using the `query_params` field. These should be **application-specific parameters only** (such as user IDs or tracking identifiers).

Example use cases for application-time query parameters:

* User tracking IDs (`user_id`)
* Session identifiers
* A/B test variants
* Application source attribution (if not already in parsing URL)

#### Candidate answers

Answers sent with the [POST Apply](https://api.kombo.dev/docs/#/AI%20Apply/PostAiApplyApply) endpoint are expected in the following format:

```json theme={null}
{
  "submission_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "candidate_email": "john.doe@gmail.com",
  "query_params": {
    "user_id": "8e05b4e5-c586-4d42-8606-b45febad3af3"
  },
  "screening_question_answers": [
    {
      "question_id": "A4zHtGQLF823sNmqy4WxoduFH",
      "answer": "John Doe"
    },
    {
      "question_id": "CDEfHvMGSDnM6pq5HECdE2Kg",
      "answer": "EycufwZHfwcVDmE47X7QN8X2"
    },
    {
      "question_id": "3dT5df2PhyVp7Rze76S5NqrW",
      "answer": {
        "name": "john_doe_resume.pdf",
        "content_type": "application/pdf",
        "data": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovT3V0bGluZXMgMiAwIFIKL1BhZ2VzIDMgMCBSCj4+CmVuZG9iag=="
      }
    }
  ]
}
```

View the below table for an in-depth explanation of each expected input type:

| Question type  | type      | Example                                                                                     |
| -------------- | --------- | ------------------------------------------------------------------------------------------- |
| TEXT           | string    | "John Doe"                                                                                  |
| SINGLE\_SELECT | string    | "BsnL4pAhNQc26uSc4JopTP3P" (Selected option ID)                                             |
| MULTI\_SELECT  | string\[] | \["7VMWn39TqeHRT3nW12AXMD9V", "3Mctc15bypfL44i4KgcVrp6s"] (Selected option IDs)             |
| DATE           | string    | "2021-12-31T23:59:59.000Z" (ISO 8601 date)                                                  |
| NUMBER         | number    | 42                                                                                          |
| BOOLEAN        | boolean   | true                                                                                        |
| FILE           | object    | `{ "name": "john_doe_resume.pdf", "content_type": "application/pdf", "data": "BASE64..." }` |

## The Application Form

The form uses a block structure with two types:

* **Question Blocks**: Individual fields with ID, label, type (TEXT, SINGLE\_SELECT, MULTI\_SELECT, DATE, NUMBER, BOOLEAN, FILE), and optional conditional display
* **Section Blocks**: Containers grouping related questions with a `children` array

### Application Form Example

```json theme={null}
[
  {
    "block_type": "SECTION",
    "label": "Personal Information",
    "children": [
      {
        "block_type": "QUESTION",
        "question_id": "6VrjehyBk685vubNydiR1hSn",
        "label": "First name",
        "description": null,
        "required": true,
        "question_type": "TEXT",
        "unified_key": "FIRST_NAME",
        "options": null,
        "display_when": null
      }
    ]
  },
  {
    "block_type": "QUESTION",
    "question_id": "EKaumKPGjeA97cb8ystMmkCe",
    "label": "What is your desired working location?",
    "description": "Select your preferred work arrangement",
    "required": true,
    "question_type": "SINGLE_SELECT",
    "unified_key": null,
    "options": [
      {
        "id": "BsnL4pAhNQc26uSc4JopTP3P",
        "label": "Remote",
        "unified_key": null
      },
      {
        "id": "8T4fcKgzLxbKFUo4saXaoMTG",
        "label": "On-site",
        "unified_key": null
      },
      {
        "id": "2cJDK3dq4WNjovohSG7dSpfd",
        "label": "Hybrid",
        "unified_key": null
      }
    ],
    "display_when": null
  },
  {
    "block_type": "QUESTION",
    "question_id": "2H26BKTbDn2ygN2GfEcCsUP8",
    "label": "What timezone are you in?",
    "description": "This helps us schedule meetings at convenient times",
    "required": true,
    "question_type": "TEXT",
    "unified_key": null,
    "options": null,
    // This question will only be displayed if the candidate selected "Remote" in the previous question
    "display_when": {
      "question_id": "EKaumKPGjeA97cb8ystMmkCe",
      "answer_equals": "BsnL4pAhNQc26uSc4JopTP3P"
    }
  }
]
```

### Unified Keys

Standardized identifiers for common fields enable automatic data pre-population:

<AccordionGroup>
  <Accordion title="Account Information">
    Fields required for creating and managing user accounts, including login credentials and contact information for account access

    | Key     | Label | Expected Type |
    | ------- | ----- | ------------- |
    | `EMAIL` | Email | TEXT          |
  </Accordion>

  <Accordion title="Applicant Residence">
    Fields related to where the candidate currently lives, including full addresses, individual address components, and residence type information

    | Key                     | Label                 | Expected Type | Options                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    | ----------------------- | --------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | `RESIDENCE_TYPE`        | Residence Type        | ENUM          | `HOME`, `WORK`, `MAILING`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
    | `RESIDENCE_FULL_STRING` | Full Residence        | TEXT          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    | `RESIDENCE_COUNTRY`     | Country               | ENUM          | `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, `AT`, `AU`, `AW`, `AX`, `AZ`, `BA`, `BB`, `BD`, `BE`, `BF`, `BG`, `BH`, `BI`, `BJ`, `BL`, `BM`, `BN`, `BO`, `BQ`, `BR`, `BS`, `BT`, `BV`, `BW`, `BY`, `BZ`, `CA`, `CC`, `CD`, `CF`, `CG`, `CH`, `CI`, `CK`, `CL`, `CM`, `CN`, `CO`, `CR`, `CU`, `CV`, `CW`, `CX`, `CY`, `CZ`, `DE`, `DJ`, `DK`, `DM`, `DO`, `DZ`, `EC`, `EE`, `EG`, `EH`, `ER`, `ES`, `ET`, `FI`, `FJ`, `FK`, `FM`, `FO`, `FR`, `GA`, `GB`, `GD`, `GE`, `GF`, `GG`, `GH`, `GI`, `GL`, `GM`, `GN`, `GP`, `GQ`, `GR`, `GS`, `GT`, `GU`, `GW`, `GY`, `HK`, `HM`, `HN`, `HR`, `HT`, `HU`, `ID`, `IE`, `IL`, `IM`, `IN`, `IO`, `IQ`, `IR`, `IS`, `IT`, `JE`, `JM`, `JO`, `JP`, `KE`, `KG`, `KH`, `KI`, `KM`, `KN`, `KP`, `KR`, `KW`, `KY`, `KZ`, `LA`, `LB`, `LC`, `LI`, `LK`, `LR`, `LS`, `LT`, `LU`, `LV`, `LY`, `MA`, `MC`, `MD`, `ME`, `MF`, `MG`, `MH`, `MK`, `ML`, `MM`, `MN`, `MO`, `MP`, `MQ`, `MR`, `MS`, `MT`, `MU`, `MV`, `MW`, `MX`, `MY`, `MZ`, `NA`, `NC`, `NE`, `NF`, `NG`, `NI`, `NL`, `NO`, `NP`, `NR`, `NU`, `NZ`, `OM`, `PA`, `PE`, `PF`, `PG`, `PH`, `PK`, `PL`, `PM`, `PN`, `PR`, `PS`, `PT`, `PW`, `PY`, `QA`, `RE`, `RO`, `RS`, `RU`, `RW`, `SA`, `SB`, `SC`, `SD`, `SE`, `SG`, `SH`, `SI`, `SJ`, `SK`, `SL`, `SM`, `SN`, `SO`, `SR`, `SS`, `ST`, `SV`, `SX`, `SY`, `SZ`, `TC`, `TD`, `TF`, `TG`, `TH`, `TJ`, `TK`, `TL`, `TM`, `TN`, `TO`, `TR`, `TT`, `TV`, `TW`, `TZ`, `UA`, `UG`, `UM`, `US`, `UY`, `UZ`, `VA`, `VC`, `VE`, `VG`, `VI`, `VN`, `VU`, `WF`, `WS`, `YE`, `YT`, `ZA`, `ZM`, `ZW` |
    | `RESIDENCE_CITY`        | City                  | TEXT          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    | `RESIDENCE_STATE`       | State/Province/Region | TEXT          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    | `RESIDENCE_LINE_1`      | Residence Line 1      | TEXT          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    | `RESIDENCE_LINE_2`      | Residence Line 2      | TEXT          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    | `RESIDENCE_ZIP_CODE`    | Postal Code           | TEXT          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
  </Accordion>

  <Accordion title="Consent">
    Fields that require explicit consent or agreement from the candidate, including terms of service, privacy policies, and data usage permissions

    | Key                      | Label                  | Expected Type |
    | ------------------------ | ---------------------- | ------------- |
    | `APPLICANT_POOL_CONSENT` | Candidate Pool Consent | BOOLEAN       |
    | `TERMS_AND_CONDITIONS`   | Terms and Conditions   | BOOLEAN       |
  </Accordion>

  <Accordion title="Personal Information">
    Fields containing basic personal details about the candidate, including names, gender, availability, and personal documents like resumes

    | Key                   | Label               | Expected Type | Options                                         |
    | --------------------- | ------------------- | ------------- | ----------------------------------------------- |
    | `FIRST_NAME`          | First Name          | TEXT          |                                                 |
    | `LAST_NAME`           | Last Name           | TEXT          |                                                 |
    | `FULL_NAME`           | Full Name           | TEXT          |                                                 |
    | `GENDER`              | Gender              | ENUM          | `MALE`, `FEMALE`, `NON_BINARY`, `NOT_SPECIFIED` |
    | `EXPECTED_START_DATE` | Expected Start Date | DATE          |                                                 |
    | `RESUME`              | Resume              | FILE          |                                                 |
    | `BIRTH_DATE`          | Birth Date          | DATE          |                                                 |
  </Accordion>

  <Accordion title="Phone">
    Fields related to phone numbers and telephonic contact information, including phone types, country codes, national numbers, and extensions.

    Keyed fields expect different formats:

    * `FULL_PHONE_NUMBER`: E.164 format
    * `PHONE_NATIONAL_NUMBER`: national phone number format (e.g. 123 456 7890)

      | Key                     | Label                 | Expected Type | Options                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
      | ----------------------- | --------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
      | `PHONE_NUMBER_TYPE`     | Phone Number Type     | ENUM          | `MOBILE`, `LANDLINE`, `WORK`, `HOME`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
      | `FULL_PHONE_NUMBER`     | Full Phone Number     | TEXT          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
      | `PHONE_COUNTRY_CODE`    | Phone Country Code    | ENUM          | `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AO`, `AQ`, `AR`, `AS`, `AT`, `AU`, `AW`, `AX`, `AZ`, `BA`, `BB`, `BD`, `BE`, `BF`, `BG`, `BH`, `BI`, `BJ`, `BL`, `BM`, `BN`, `BO`, `BQ`, `BR`, `BS`, `BT`, `BV`, `BW`, `BY`, `BZ`, `CA`, `CC`, `CD`, `CF`, `CG`, `CH`, `CI`, `CK`, `CL`, `CM`, `CN`, `CO`, `CR`, `CU`, `CV`, `CW`, `CX`, `CY`, `CZ`, `DE`, `DJ`, `DK`, `DM`, `DO`, `DZ`, `EC`, `EE`, `EG`, `EH`, `ER`, `ES`, `ET`, `FI`, `FJ`, `FK`, `FM`, `FO`, `FR`, `GA`, `GB`, `GD`, `GE`, `GF`, `GG`, `GH`, `GI`, `GL`, `GM`, `GN`, `GP`, `GQ`, `GR`, `GS`, `GT`, `GU`, `GW`, `GY`, `HK`, `HM`, `HN`, `HR`, `HT`, `HU`, `ID`, `IE`, `IL`, `IM`, `IN`, `IO`, `IQ`, `IR`, `IS`, `IT`, `JE`, `JM`, `JO`, `JP`, `KE`, `KG`, `KH`, `KI`, `KM`, `KN`, `KP`, `KR`, `KW`, `KY`, `KZ`, `LA`, `LB`, `LC`, `LI`, `LK`, `LR`, `LS`, `LT`, `LU`, `LV`, `LY`, `MA`, `MC`, `MD`, `ME`, `MF`, `MG`, `MH`, `MK`, `ML`, `MM`, `MN`, `MO`, `MP`, `MQ`, `MR`, `MS`, `MT`, `MU`, `MV`, `MW`, `MX`, `MY`, `MZ`, `NA`, `NC`, `NE`, `NF`, `NG`, `NI`, `NL`, `NO`, `NP`, `NR`, `NU`, `NZ`, `OM`, `PA`, `PE`, `PF`, `PG`, `PH`, `PK`, `PL`, `PM`, `PN`, `PR`, `PS`, `PT`, `PW`, `PY`, `QA`, `RE`, `RO`, `RS`, `RU`, `RW`, `SA`, `SB`, `SC`, `SD`, `SE`, `SG`, `SH`, `SI`, `SJ`, `SK`, `SL`, `SM`, `SN`, `SO`, `SR`, `SS`, `ST`, `SV`, `SX`, `SY`, `SZ`, `TC`, `TD`, `TF`, `TG`, `TH`, `TJ`, `TK`, `TL`, `TM`, `TN`, `TO`, `TR`, `TT`, `TV`, `TW`, `TZ`, `UA`, `UG`, `UM`, `US`, `UY`, `UZ`, `VA`, `VC`, `VE`, `VG`, `VI`, `VN`, `VU`, `WF`, `WS`, `YE`, `YT`, `ZA`, `ZM`, `ZW` |
      | `PHONE_NATIONAL_NUMBER` | Phone National Number | TEXT          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
      | `PHONE_EXTENSION`       | Phone Extension       | TEXT          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
  </Accordion>
</AccordionGroup>

### Conditional Rendering

#### Displaying Sections Conditionally

Sections should only be displayed when at least one child question's `display_when` condition is met

The `display_when` field on a question explains what condition needs to be true for the question to be displayed. Only displayed questions will be validated and must be answered.

When `display_when` is null, the field is not conditional and should always be displayed.

#### Supported Question Types

Conditional rendering is only supported by the following question types:

* `BOOLEAN` - Shows/hides fields based on true/false values
* `SINGLE_SELECT` - Shows/hides fields based on selected option ID
* `MULTI_SELECT` - Shows/hides fields when ANY of the specified option IDs are selected

The `answer_equals` property matches the answer format expected in the [POST Apply](https://api.kombo.dev/docs/#/AI%20Apply/PostAiApplyApply) endpoint:

<Accordion title="View examples of when to render a conditional field">
  ```json theme={null}
  // BOOLEAN
  {
    "block_type": "QUESTION",
    "question_id": "has_degree",
    "label": "Do you have a college degree?",
    "question_type": "BOOLEAN"
  },
  {
    "block_type": "QUESTION",
    "question_id": "degree_details",
    "label": "What degree do you have?",
    "question_type": "TEXT",
    "display_when": {
      "question_id": "has_degree",
      "answer_equals": true  // Shows when candidate answers "yes"
    }
  }

  // SINGLE_SELECT
  {
    "block_type": "QUESTION",
    "question_id": "work_location",
    "label": "Preferred work location?",
    "question_type": "SINGLE_SELECT",
    "options": [
      { "id": "remote_id", "label": "Remote" },
      { "id": "office_id", "label": "Office" }
    ]
  },
  {
    "block_type": "QUESTION",
    "question_id": "timezone",
    "label": "Your timezone?",
    "question_type": "TEXT",
    "display_when": {
      "question_id": "work_location",
      "answer_equals": "remote_id"  // Shows only for remote workers
    }
  }

  // MULTI_SELECT
  // For `MULTI_SELECT` questions, the condition is met if the candidate's answer
  // includes **ANY** of the option IDs specified in `answer_equals`. For example,
  // if `answer_equals: ["A", "B"]` and the candidate selects `["B", "C"]`, the
  // condition is satisfied because option "B" is present in both.
  {
    "block_type": "QUESTION",
    "question_id": "skills",
    "label": "Your skills?",
    "question_type": "MULTI_SELECT",
    "options": [
      { "id": "python", "label": "Python" },
      { "id": "javascript", "label": "JavaScript" },
      { "id": "rust", "label": "Rust" }
    ]
  },
  {
    "block_type": "QUESTION",
    "question_id": "web_experience",
    "label": "Web development experience?",
    "question_type": "TEXT",
    "display_when": {
      "question_id": "skills",
      "answer_equals": ["python", "javascript"]  // Shows if either selected
    }
  }
  ```
</Accordion>


# AI Apply: Candidate Account Creation
Source: https://docs.kombo.dev/ai-apply-candidate-account-creation

How our system handles cases when we need to create a candidate account for a job posting.

## Overview

Some job postings require candidates to have an account before they can apply. AI Apply handles this automatically by creating candidate accounts behind the scenes, ensuring applications are submitted successfully without requiring any additional steps from the candidate.

### Account Creation Process

For each application, AI Apply creates a new candidate account in the ATS. This approach ensures that if a candidate applies to multiple job postings from the same employer, each application has its own account and submissions remain independent.

### Email Forwarding

Each application generates a unique email address for the candidate. All emails sent to this address are automatically forwarded to the candidate's actual email address, ensuring they receive all communications from the employer.

### Account Access

After an application is submitted, Kombo sends a confirmation email to the candidate's email address with instructions on how to access their account, including a password reset link.

Kombo doesn't store candidate account passwords. If a candidate wishes to log in directly to their account (for example, their Workday account), they can do so by using the "Reset Password" feature on the Workday login page.


# AI Apply: Job feeds and bulk imports
Source: https://docs.kombo.dev/ai-apply-job-feeds

Learn how you can import high volumes of job postings into AI Apply using Job feeds.

## Overview

<Note>
  General considerations for job postings (query parameters, location, etc.)
  still apply. See the [AI Apply documentation](/ai-apply#parsing-a-job-posting)
  for details.
</Note>

Depending on the number of job postings you want to import into AI Apply, adding them one by one can take a long time.
Additionally, you will have to continually keep job postings in AI Apply up to date, archiving and updating them as required.

With job feeds and bulk imports, we will handle this for you! You can import a large number of postings at once and continually send updates to us as you receive them from your providers.
Creating, archiving, and updating job postings are automatically taken care of.

## Job feeds

Bulk imports are managed through Job Feeds. Each job feed represents a self-contained list of jobs from a single source, for example, a Recruiting agency.

Before you can send data for a job feed, you need to create it in the Kombo Dashboard.

<img alt="Managing job feeds" />

<Tip>
  Choose clear, descriptive names for Job Feeds. Whenever possible, use the data
  source name so you can easily track the origin of imported job postings later.
</Tip>

## How bulk imports work

Each import you send to us includes a newline-separated list of JSON records as a request body. Each record maps to a job posting in AI Apply.

```json theme={null}
{ "url": "https://careers.acme.com/job/1", "career_site_label": "ACME Corp" }
{ "url": "https://careers.acme.com/job/2", "career_site_label": "ACME Corp", "job_code": "ENG-123" }
{ "url": "https://careers.acme.com/job/3", "career_site_label": "ACME Corp", "location": { "country": "US", "postal_code": "94115" } }
```

If any record is invalid or ill-formatted, the import process will be aborted.
You can resume the import at any time after fixing the faulty record by simply re-submitting the request.

The following logic is used to generate career sites, job postings, and job posting statuses from your data:

* Career sites are auto-generated for each unique `career_site_label`.
* Job postings are identified by `url`, `career_site_label`, and `job_code` (same combination means same posting).
* Existing postings are updated; new ones are created and queued for parsing.
* Missing postings are archived automatically (parsed data is preserved for re-import).

<Warning>
  **Note:** Job postings imported through different job feeds are always treated
  as distinct!
</Warning>

You can find the endpoint in our API documentation: [POST Bulk Import](https://api.kombo.dev/docs/#/AI%20Apply/postAiApplyJobFeedsBulkImport)


# AI Apply: Unified API
Source: https://docs.kombo.dev/ai-apply-unified-api

Learn about the alternate way of using AI Apply, compatible with Kombo's Unified API.

<Warning>
  **Deprecation Notice**

  The AI Apply Unified API endpoints are no longer actively supported. We recommend migrating to the [standard AI Apply API](/ai-apply) for all new and existing integrations.
</Warning>

## Overview

Whereas the default AI Apply API is a block-based format designed to render
sections and structure as they appear in the remote job posting, the alternate
Unified API variant matches Kombo's core philosophy of hiding standard fields
and allowing you to provide them via standardized API fields on top of the
screening question answers.

## Why use this API?

For existing Kombo customers, this is the fastest way to test AI Apply. Your
existing screening question rendering and submission logic will work without
modification, as the API response schema is identical.

<Tip>
  Make sure to understand the differences between the two AI Apply APIs before
  choosing one. The default AI Apply API can be found [here](/ai-apply).
</Tip>

## Which API Should You Use?

We recommend the standard [AI Apply API](/ai-apply) for new integrations—it
preserves sections and context, helping candidates better understand questions.
Both APIs support pre-filling data via unified keys.

Use this Unified API variant primarily if you're an existing Kombo customer wanting
compatibility with your current integration. Note that filtering standard fields may
result in a list of screening questions that miss context (e.g. the standard
`FIRST_NAME` and `LAST_NAME` fields are filtered out, leaving an ambiguous middle
name question which is not unified).

## How It Works

Fields that would usually be tagged by `unified_key` in the standard API
(e.g. `FIRST_NAME`) are filtered out and instead provided via the `candidate`
object (e.g. `candidate.first_name`).

Currently, the following fields are filtered out by default:

* **Name fields** (`FIRST_NAME`, `LAST_NAME`, `FULL_NAME`) → Provided via
  `candidate.first_name` and `candidate.last_name`
* **Email** (`EMAIL`) → Provided via `candidate.email_address`
* **Phone** (`PHONE_*` fields) → Provided via `candidate.phone_number` as international format
* **Resume** (`RESUME`) → Provided via `attachments` with type `CV`

When you fetch jobs, these fields are automatically removed from the screening
questions.

<Note>
  The filtered fields are configurable to suit your product's need. E.g. if you
  only collect first name and last name, you can configure the API to only
  filter out the `FIRST_NAME`, `LAST_NAME`, `FULL_NAME` fields, while the
  remaining fields are provided via the `screening_question_answers` field.

  Reach out to us for setting this up.
</Note>

## API Endpoints

### Get Jobs

Use the [GET jobs](https://api.kombo.dev/docs/#/AI%20Apply/GetAiApplyUnifiedApiJobs)
to retrieve an array of jobs and their screening questions (with unified fields
filtered out as described above).

### Create Applications

Submit applications using the [POST applications](https://api.kombo.dev/docs/#/AI%20Apply/PostAiApplyUnifiedApiJobsJobIdApplications)
endpoint. The filtered fields must be provided via the `candidate`/`attachments`
object as described above, with remaining screening questions in the
`screening_question_answers` array.

#### Query Parameters

Unique to AI Apply, you may want to include query parameters in your request
which get used when opening the job posting URL and submitting the application.
For example, you may want to specify a specific user ID to be used for tracking
purposes.

These can be specified in the top-level `query_params` property of the
application submission object. This property is unique to the AI Apply Unified
API, and not available in our core Unified API.

<Info>
  Please make sure to read through our general AI Apply query parameters
  documentation to understand which parameters should be added during the [parse
  process](/ai-apply#adding-query-parameters), and which parameters should be
  added during the [application
  process](/ai-apply#query-parameters-in-applications).
</Info>

#### Example Submission

```json theme={null}
{
  "candidate": {
    "first_name": "John", // Used for fields of type `FIRST_NAME`, `FULL_NAME`
    "last_name": "Doe", // Used for fields of type `LAST_NAME`, `FULL_NAME`
    "email_address": "john.doe@example.com", // Used for fields of type `EMAIL`
    "phone_number": "+12345678900" // Used for fields of type `PHONE_*`
  },
  "query_params": {
    "user_id": "8e05b4e5-c586-4d42-8606-b45febad3af3"
  },
  "attachments": [
    {
      "data_url": "https://example.com/resume.pdf", // Used for fields of type `RESUME`
      "name": "John Doe's Resume",
      "type": "CV"
    }
  ],
  // Screening questions are provided as-usual for any non-filtered fields
  "screening_question_answers": [
    {
      "question_id": "1",
      "answer": "I've been working as a software engineer for the past 10 years."
    },
    {
      "question_id": "2",
      "answer": "I am allowed to work in the US."
    }
  ]
}
```

## Ready to start using AI Apply?

Getting started with AI Apply is straightforward. Here's what you need to do:

1. **Parse your job postings**: Send the URLs of jobs you want to enable AI Apply for to the [parse job postings endpoint](https://api.kombo.dev/docs/#/AI%20Apply/PostAiApplyPostings).

2. **Retrieve screening questions**: Continue using the standard [Unified API get jobs endpoint](/ats/v1/get-jobs) in addition to the [AI Apply-compatible get jobs endpoint](https://api.kombo.dev/docs/#/AI%20Apply/GetAiApplyUnifiedApiJobs) to retrieve the jobs from both APIs.

3. **Submit applications**: For jobs that you have parsed via AI Apply, use the [AI Apply-compatible create application endpoint](https://api.kombo.dev/docs/#/AI%20Apply/PostAiApplyUnifiedApiJobsJobIdApplications) instead of the standard [create application endpoint](/ats/v1/post-jobs-job-id-applications).


# AI Apply: Webhooks
Source: https://docs.kombo.dev/ai-apply-webhooks

Receive high-signal status updates for Job Postings and Applications.

## Overview

AI Apply is asynchronous by design (form parsing and applications are long-running processes that run in the background).

To keep your system in sync without polling, we emit webhooks whenever a resource reaches a meaningful outcome.

<Tip>
  **First time implementing Kombo webhooks?**

  View our general [Webhooks guide](/hris/guides/webhooks) for more information on delivery, signature validation, and other generic behaviors.
</Tip>

## Job Posting Updated Webhook

### Lifecycle

| Status        | Emits webhook? | Description                                                                |
| ------------- | -------------- | -------------------------------------------------------------------------- |
| `PENDING`     | ❌              | Parsing is queued/processing                                               |
| `APPLYABLE`   | ✅              | Kombo has successfully parsed the job posting. You can submit applications |
| `UNAVAILABLE` | ✅              | Parsing the job posting failed                                             |
| `ARCHIVED`    | ✅              | The job was taken offline or manually archived                             |

<Tip>
  If a parse attempt fails but a previous successful revision still exists, the
  posting remains `APPLYABLE`.
</Tip>

### Payload

The payload matches the job posting schema you receive from the [get job posting endpoint](https://api.kombo.dev/docs/#/AI%20Apply/GetAiApplyPostings).

**Examples**

1. A job posting was successfully parsed.

```json theme={null}
{
  "id": "2Cv6VeT4efBfzvQRudprNx5z",
  "type": "ai-apply-job-posting-status-updated",
  "data": {
    "id": "9QGNv3B98kL3hyELE1qsZ86s",
    "career_site": { "id": "Chc4dua5asAQ48KUERDVF1bs", "label": "Acme" },
    "url": "https://careers.acme.com/jobs/fullstack-engineer-ai-infra-14102",
    "job_code": "ACME_13",
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-03-02T23:12:32.000Z",
    "archived_at": null,
    "archived_reason": null,
    "availability": "APPLYABLE"
  }
}
```

2. A job posting failed to parse.

```json theme={null}
{
  "id": "2Cv6VeT4efBfzvQRudprNx5z",
  "type": "ai-apply-job-posting-status-updated",
  "data": {
    "id": "9QGNv3B98kL3hyELE1qsZ86s",
    "career_site": { "id": "Chc4dua5asAQ48KUERDVF1bs", "label": "Acme" },
    "url": "https://careers.acme.com/jobs/fullstack-engineer-ai-infra-14102",
    "job_code": "ACME_13",
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-03-02T23:12:32.000Z",
    "archived_at": null,
    "archived_reason": null,
    "availability": "UNAVAILABLE"
  }
}
```

3. A job posting was taken offline.

```json theme={null}
{
  "id": "2Cv6VeT4efBfzvQRudprNx5z",
  "type": "ai-apply-job-posting-status-updated",
  "data": {
    "id": "9QGNv3B98kL3hyELE1qsZ86s",
    "career_site": { "id": "Chc4dua5asAQ48KUERDVF1bs", "label": "Acme" },
    "url": "https://careers.acme.com/jobs/fullstack-engineer-ai-infra-14102",
    "job_code": "ACME_13",
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-03-02T23:12:32.000Z",
    "archived_at": "2025-03-10T08:15:00.000Z",
    "archived_reason": "JOB_POSTING_TAKEN_OFFLINE",
    "availability": "ARCHIVED"
  }
}
```

### Handling job posting availability changes

A job posting's `availability` field may switch from being non-applyable to applyable, and vice versa.

As soon as this changes, you should update your UI accordingly.

We recommend either hiding the job from the list of jobs you display to candidates or showing the job URL directly for the candidate to apply on the career site.

<Info>
  Most transitions from being applyable to non-applyable are caused by a job
  posting being archived. In rare cases, a job posting's application form may
  change, triggering a re-parse.
</Info>

## Application Updated Webhook

### Lifecycle

| Status      | Emits webhook? | Description                                                                  |
| ----------- | -------------- | ---------------------------------------------------------------------------- |
| `PENDING`   | ❌              | Our automated system is applying or the application is pending manual review |
| `SUBMITTED` | ✅              | The application was successfully submitted                                   |
| `FAILED`    | ✅              | The application was deemed impossible to submit after human review           |

<Note>
  **When can an application be marked as `FAILED`?**

  If the candidate input is fundamentally invalid, and Kombo has no chance to
  submit the application in the candidate's name without the candidate providing
  more information, the application will be marked as failed. In the future, Kombo
  may support flows of following up with the candidate to collect remaining data
  in an automated manner.

  In rare edge cases, when a job is taken offline while an application is
  in-flight, the application will also be marked as failed.
</Note>

### Payload

The payload follows the application schema you receive from the [get application endpoint](https://api.kombo.dev/docs/#/AI%20Apply/GetAiApplyApplications).

**Examples**

1. Application is automatically submitted

```json theme={null}
{
  "id": "2Cv6VeT4efBfzvQRudprNx5z",
  "type": "ai-apply-application-status-updated",
  "data": {
    "id": "ADbmw5XSkeCSE1fAucoxEGnwZ",
    "job_posting_id": "JDn252PEYa4rMhKbJBjtn3ng",
    "status": "SUBMITTED",
    "candidate_email": "candidate@example.com",
    "proxy_email": "candidate@proxied.com",
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-03-02T23:12:32.000Z"
  }
}
```

2. Application is submitted after Kombo QA

```json theme={null}
{
  "id": "2Cv6VeT4efBfzvQRudprNx5z",
  "type": "ai-apply-application-status-updated",
  "data": {
    "id": "ADbmw5XSkeCSE1fAucoxEGnwZ",
    "job_posting_id": "JDn252PEYa4rMhKbJBjtn3ng",
    "status": "SUBMITTED",
    "candidate_email": "candidate@example.com",
    "proxy_email": null,
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-03-03T10:41:02.000Z"
  }
}
```

3. Application is marked as failed by Kombo QA (e.g., invalid candidate input)

```json theme={null}
{
  "id": "2Cv6VeT4efBfzvQRudprNx5z",
  "type": "ai-apply-application-status-updated",
  "data": {
    "id": "ADbmw5XSkeCSE1fAucoxEGnwZ",
    "job_posting_id": "JDn252PEYa4rMhKbJBjtn3ng",
    "status": "FAILED",
    "candidate_email": "candidate@example.com",
    "proxy_email": null,
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-03-10T08:15:00.000Z"
  }
}
```


# Available Assessment Connectors
Source: https://docs.kombo.dev/assessment/connectors

Browse all available Assessment connectors integrated with Kombo

Through Kombo's Unified Assessment API, you can integrate with 19+ Assessment systems.

<Note>
  Please note that this page only lists connectors for Kombo's **Assessment API**. You can also browse our [HRIS connectors](/hris/connectors) and [ATS connectors](/ats/connectors) and [LMS connectors](/lms/connectors).
</Note>

<CardGroup>
  <Card title="Ashby" icon="https://storage.googleapis.com/kombo-assets/integrations/ashby/icon.svg" href="/assessment/connectors/ashby">
    Assessment connector
  </Card>

  <Card title="Avature" icon="https://storage.googleapis.com/kombo-assets/integrations/avature/icon.svg" href="/assessment/connectors/avature">
    Assessment connector
  </Card>

  <Card title="Bullhorn" icon="" href="/assessment/connectors/bullhorn">
    Assessment connector
  </Card>

  <Card title="Eightfold" icon="https://storage.googleapis.com/kombo-assets/integrations/eightfold/icon.svg" href="/assessment/connectors/eightfold">
    Assessment connector
  </Card>

  <Card title="Greenhouse" icon="https://storage.googleapis.com/kombo-assets/integrations/greenhouse/icon.svg" href="/assessment/connectors/greenhouse">
    Assessment connector
  </Card>

  <Card title="iCIMS" icon="" href="/assessment/connectors/icims">
    Assessment connector
  </Card>

  <Card title="JazzHR" icon="https://storage.googleapis.com/kombo-assets/integrations/jazzhr/icon.svg" href="/assessment/connectors/jazzhr">
    Assessment connector
  </Card>

  <Card title="Jobvite" icon="https://storage.googleapis.com/kombo-assets/integrations/jobvite/icon.svg" href="/assessment/connectors/jobvite">
    Assessment connector
  </Card>

  <Card title="Jobylon" icon="https://storage.googleapis.com/kombo-assets/integrations/jobylon/icon.svg" href="/assessment/connectors/jobylon">
    Assessment connector
  </Card>

  <Card title="Kombo Sandbox" icon="https://storage.googleapis.com/kombo-assets/integrations/sandbox/icon.svg" href="/assessment/connectors/sandbox">
    Assessment connector
  </Card>

  <Card title="Lever" icon="https://storage.googleapis.com/kombo-assets/integrations/lever/icon.svg" href="/assessment/connectors/lever">
    Assessment connector
  </Card>

  <Card title="Oracle Recruiting Cloud" icon="https://storage.googleapis.com/kombo-assets/integrations/oraclerecruiting/icon.svg" href="/assessment/connectors/oraclerecruiting">
    Assessment connector
  </Card>

  <Card title="PageUp People" icon="https://storage.googleapis.com/kombo-assets/integrations/pageup/icon.svg" href="/assessment/connectors/pageup">
    Assessment connector
  </Card>

  <Card title="SAP SuccessFactors" icon="https://storage.googleapis.com/kombo-assets/integrations/successfactors/icon.svg" href="/assessment/connectors/successfactors">
    Assessment connector
  </Card>

  <Card title="SmartRecruiters" icon="https://storage.googleapis.com/kombo-assets/integrations/smartrecruiters/icon.svg" href="/assessment/connectors/smartrecruiters">
    Assessment connector
  </Card>

  <Card title="Teamtailor" icon="https://storage.googleapis.com/kombo-assets/integrations/teamtailor/icon.svg" href="/assessment/connectors/teamtailor">
    Assessment connector
  </Card>

  <Card title="Tellent Recruitee" icon="https://storage.googleapis.com/kombo-assets/integrations/recruitee/icon.svg" href="/assessment/connectors/recruitee">
    Assessment connector
  </Card>

  <Card title="UKG Pro" icon="https://storage.googleapis.com/kombo-assets/integrations/ukgpro/icon.svg" href="/assessment/connectors/ukgpro">
    Assessment connector
  </Card>

  <Card title="Workday" icon="https://storage.googleapis.com/kombo-assets/integrations/workday/icon.svg" href="/assessment/connectors/workday">
    Assessment connector
  </Card>
</CardGroup>

## Missing something?

We're always expanding our offering of integrations, so if there's a solution that's missing, [let's talk](https://www.kombo.dev/demo)! If you're an existing Kombo customer, please [reach out to support](mailto:support@kombo.dev).


# Ashby Assessment Integration
Source: https://docs.kombo.dev/assessment/connectors/ashby

Ashby connector for Kombo's Assessment API

<Note>This connector requires a partnership with Ashby. Please contact us to get access.</Note>

The Ashby Assessment integration allows you to sync Assessment data between Ashby and your application through Kombo's unified API. The tool slug for this connector is `ashby`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/29648032780689">
    Step-by-step instructions to connect your Ashby account to Kombo.
  </Card>

  <Card title="How assessment works in Ashby" icon="book" href="https://help.kombo.dev/hc/en-us/articles/33846462227217">
    Additional documentation and guides for Ashby.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Candidates">
      | Field         | Notes |
      | ------------- | ----- |
      | remote\_id    |       |
      | first\_name   |       |
      | last\_name    |       |
      | email         |       |
      | phone\_number |       |
    </Accordion>

    <Accordion title="Applications">
      | Field      | Notes |
      | ---------- | ----- |
      | remote\_id |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | name        |       |
      | job\_code   |       |
      | description |       |
      | location    |       |
    </Accordion>

    <Accordion title="Hiring Team Members">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | first\_name |       |
      | last\_name  |       |
      | email       |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Update order result">
      | Input Field               | Notes |
      | ------------------------- | ----- |
      | assessment\_order\_id     |       |
      | status                    |       |
      | result\_url               |       |
      | completed\_at             |       |
      | score                     |       |
      | max\_score                |       |
      | attachments.name          |       |
      | attachments.content\_type |       |
      | attachments.data\_url     |       |
      | attachments.data          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature         | Notes |
    | --------------- | ----- |
    | API Passthrough |       |
    | Scope Testing   |       |
    | End User Flow   |       |
    | Manual Trigger  |       |
    | Bulk Invite     |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Ashby

For **Ashby**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Ashby ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/ashby/icon.svg" href="/ats/connectors/ashby">
    Ashby for the ATS category
  </Card>
</CardGroup>


# Avature Assessment Integration
Source: https://docs.kombo.dev/assessment/connectors/avature

Avature connector for Kombo's Assessment API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Avature Assessment integration allows you to sync Assessment data between Avature and your application through Kombo's unified API. The tool slug for this connector is `avature`.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Candidates">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | first\_name |       |
      | last\_name  |       |
      | email       |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field      | Notes |
      | ---------- | ----- |
      | remote\_id |       |
      | name       |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Update order result">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | assessment\_order\_id |       |
      | status                |       |
      | result\_url           |       |
      | completed\_at         |       |
      | score                 |       |
      | max\_score            |       |
    </Accordion>
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Avature

For **Avature**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Avature ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/avature/icon.svg" href="/ats/connectors/avature">
    Avature for the ATS category
  </Card>
</CardGroup>


# Bullhorn Assessment Integration
Source: https://docs.kombo.dev/assessment/connectors/bullhorn

Bullhorn connector for Kombo's Assessment API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Bullhorn Assessment integration allows you to sync Assessment data between Bullhorn and your application through Kombo's unified API. The tool slug for this connector is `bullhorn`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/41830236337425">
    Step-by-step instructions to connect your Bullhorn account to Kombo.
  </Card>

  <Card title="How assessment works in Bullhorn" icon="book" href="https://help.kombo.dev/hc/en-us/articles/41930966811537">
    Additional documentation and guides for Bullhorn.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Candidates">
      | Field         | Notes |
      | ------------- | ----- |
      | remote\_id    |       |
      | first\_name   |       |
      | last\_name    |       |
      | email         |       |
      | phone\_number |       |
    </Accordion>

    <Accordion title="Applications">
      | Field      | Notes |
      | ---------- | ----- |
      | remote\_id |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | name        |       |
      | description |       |
      | location    |       |
    </Accordion>

    <Accordion title="Hiring Team Members">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | first\_name |       |
      | last\_name  |       |
      | email       |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Update order result">
      | Input Field               | Notes |
      | ------------------------- | ----- |
      | assessment\_order\_id     |       |
      | status                    |       |
      | result\_url               |       |
      | completed\_at             |       |
      | score                     |       |
      | max\_score                |       |
      | attachments.name          |       |
      | attachments.content\_type |       |
      | attachments.data\_url     |       |
      | attachments.data          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature         | Notes |
    | --------------- | ----- |
    | OAuth           |       |
    | API Passthrough |       |
    | End User Flow   |       |
    | Manual Trigger  |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Bullhorn

For **Bullhorn**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Bullhorn ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/bullhorn/icon.svg" href="/ats/connectors/bullhorn">
    Bullhorn for the ATS category
  </Card>
</CardGroup>


# Eightfold Assessment Integration
Source: https://docs.kombo.dev/assessment/connectors/eightfold

Eightfold connector for Kombo's Assessment API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Eightfold Assessment integration allows you to sync Assessment data between Eightfold and your application through Kombo's unified API. The tool slug for this connector is `eightfold`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/40900569736593">
    Step-by-step instructions to connect your Eightfold account to Kombo.
  </Card>

  <Card title="How assessment works in Eightfold" icon="book" href="https://help.kombo.dev/hc/en-us/articles/40406654451857">
    Additional documentation and guides for Eightfold.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Candidates">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | first\_name |       |
      | last\_name  |       |
      | email       |       |
    </Accordion>

    <Accordion title="Applications">
      | Field      | Notes |
      | ---------- | ----- |
      | remote\_id |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field      | Notes |
      | ---------- | ----- |
      | remote\_id |       |
      | name       |       |
    </Accordion>

    <Accordion title="Hiring Team Members">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | first\_name |       |
      | last\_name  |       |
      | email       |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Update order result">
      | Input Field               | Notes |
      | ------------------------- | ----- |
      | assessment\_order\_id     |       |
      | status                    |       |
      | result\_url               |       |
      | completed\_at             |       |
      | score                     |       |
      | max\_score                |       |
      | attachments.name          |       |
      | attachments.content\_type |       |
      | attachments.data\_url     |       |
      | attachments.data          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature       | Notes |
    | ------------- | ----- |
    | Scope Testing |       |
    | End User Flow |       |
    | Bulk Invite   |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Eightfold

For **Eightfold**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Eightfold ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/eightfold/icon.svg" href="/ats/connectors/eightfold">
    Eightfold for the ATS category
  </Card>
</CardGroup>


# Greenhouse Assessment Integration
Source: https://docs.kombo.dev/assessment/connectors/greenhouse

Greenhouse connector for Kombo's Assessment API

<Note>This connector requires a partnership with Greenhouse. Please contact us to get access.</Note>

The Greenhouse Assessment integration allows you to sync Assessment data between Greenhouse and your application through Kombo's unified API. The tool slug for this connector is `greenhouse`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/26793130970897">
    Step-by-step instructions to connect your Greenhouse account to Kombo.
  </Card>

  <Card title="How assessment works in Greenhouse" icon="book" href="https://help.kombo.dev/hc/en-us/articles/38397711950097">
    Additional documentation and guides for Greenhouse.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Candidates">
      | Field         | Notes |
      | ------------- | ----- |
      | remote\_id    |       |
      | first\_name   |       |
      | last\_name    |       |
      | email         |       |
      | phone\_number |       |
    </Accordion>

    <Accordion title="Applications">
      | Field      | Notes |
      | ---------- | ----- |
      | remote\_id |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field      | Notes |
      | ---------- | ----- |
      | remote\_id |       |
      | name       |       |
      | job\_code  |       |
    </Accordion>

    <Accordion title="Hiring Team Members">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | first\_name |       |
      | last\_name  |       |
      | email       |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Update order result">
      <Note>
        Greenhouse will only display the result of an assessment order' *"result URL"* once the assessment has been completed. This means you may not update an order with the `status` of `OPEN` in Greenhouse. Greenhouse requires the `result_url` to be a valid, publicly accessible link when updating an assessment result. If the URL is invalid or unreachable (for example, localhost or a private network address), Greenhouse will not display any result information provided via the **"Update order result"** [endpoint](`docs.kombo.dev/assessment/v1/put-orders-assessment-order-id-result`).
      </Note>

      | Input Field               | Notes |
      | ------------------------- | ----- |
      | assessment\_order\_id     |       |
      | status                    |       |
      | result\_url               |       |
      | completed\_at             |       |
      | score                     |       |
      | max\_score                |       |
      | attachments.name          |       |
      | attachments.content\_type |       |
      | attachments.data\_url     |       |
      | attachments.data          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature         | Notes |
    | --------------- | ----- |
    | API Passthrough |       |
    | Scope Testing   |       |
    | End User Flow   |       |
    | Manual Trigger  |       |
    | Bulk Invite     |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Greenhouse

For **Greenhouse**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Greenhouse (V1) ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/greenhouse/icon.svg" href="/ats/connectors/greenhouse">
    Greenhouse (V1) for the ATS category
  </Card>
</CardGroup>


# iCIMS Assessment Integration
Source: https://docs.kombo.dev/assessment/connectors/icims

iCIMS connector for Kombo's Assessment API

<Note>This connector is in closed beta. Please contact us to get access.</Note>

The iCIMS Assessment integration allows you to sync Assessment data between iCIMS and your application through Kombo's unified API. The tool slug for this connector is `icims`.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Candidates">
      | Field         | Notes |
      | ------------- | ----- |
      | remote\_id    |       |
      | first\_name   |       |
      | last\_name    |       |
      | email         |       |
      | phone\_number |       |
    </Accordion>

    <Accordion title="Applications">
      | Field      | Notes |
      | ---------- | ----- |
      | remote\_id |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | name        |       |
      | job\_code   |       |
      | description |       |
      | location    |       |
    </Accordion>

    <Accordion title="Hiring Team Members">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | first\_name |       |
      | last\_name  |       |
      | email       |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Update order result">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | assessment\_order\_id |       |
      | status                |       |
      | result\_url           |       |
      | score                 |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature         | Notes |
    | --------------- | ----- |
    | OAuth           |       |
    | API Passthrough |       |
    | End User Flow   |       |
    | Bulk Invite     |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** iCIMS

For **iCIMS**, we also offer the following other connector variants:

<CardGroup>
  <Card title="iCIMS ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/icims/icon.svg" href="/ats/connectors/icims">
    iCIMS for the ATS category
  </Card>
</CardGroup>


# JazzHR Assessment Integration
Source: https://docs.kombo.dev/assessment/connectors/jazzhr

JazzHR connector for Kombo's Assessment API

<Note>This connector is in closed beta. Please contact us to get access.</Note>

<Note>This connector requires a partnership with JazzHR. Please contact us to get access.</Note>

The JazzHR Assessment integration allows you to sync Assessment data between JazzHR and your application through Kombo's unified API. The tool slug for this connector is `jazzhr`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/48800799800721">
    Step-by-step instructions to connect your JazzHR account to Kombo.
  </Card>

  <Card title="How assessment works in JazzHR" icon="book" href="https://help.kombo.dev/hc/en-us/articles/48796119104145">
    Additional documentation and guides for JazzHR.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Candidates">
      | Field       | Notes |
      | ----------- | ----- |
      | first\_name |       |
      | last\_name  |       |
      | email       |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Update order result">
      <Note>
        Results description which are too long(>50 characters after having applied our formatting) will be truncated. This is due to a limitation in how JazzHR handles the results description.
      </Note>

      | Input Field           | Notes |
      | --------------------- | ----- |
      | assessment\_order\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature        | Notes |
    | -------------- | ----- |
    | End User Flow  |       |
    | Manual Trigger |       |
    | Bulk Invite    |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** JazzHR

For **JazzHR**, we also offer the following other connector variants:

<CardGroup>
  <Card title="JazzHR ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/jazzhr/icon.svg" href="/ats/connectors/jazzhr">
    JazzHR for the ATS category
  </Card>
</CardGroup>


# Jobvite Assessment Integration
Source: https://docs.kombo.dev/assessment/connectors/jobvite

Jobvite connector for Kombo's Assessment API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Jobvite Assessment integration allows you to sync Assessment data between Jobvite and your application through Kombo's unified API. The tool slug for this connector is `jobvite`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/43291589037969">
    Step-by-step instructions to connect your Jobvite account to Kombo.
  </Card>

  <Card title="How assessment works in Jobvite" icon="book" href="https://help.kombo.dev/hc/en-us/articles/43291385872529">
    Additional documentation and guides for Jobvite.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Candidates">
      | Field         | Notes |
      | ------------- | ----- |
      | remote\_id    |       |
      | first\_name   |       |
      | last\_name    |       |
      | email         |       |
      | phone\_number |       |
    </Accordion>

    <Accordion title="Applications">
      | Field      | Notes |
      | ---------- | ----- |
      | remote\_id |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | name        |       |
      | job\_code   |       |
      | description |       |
      | location    |       |
    </Accordion>

    <Accordion title="Hiring Team Members">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | first\_name |       |
      | last\_name  |       |
      | email       |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Update order result">
      | Input Field               | Notes |
      | ------------------------- | ----- |
      | assessment\_order\_id     |       |
      | status                    |       |
      | result\_url               |       |
      | completed\_at             |       |
      | score                     |       |
      | attachments.name          |       |
      | attachments.content\_type |       |
      | attachments.data\_url     |       |
      | attachments.data          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature         | Notes |
    | --------------- | ----- |
    | API Passthrough |       |
    | Scope Testing   |       |
    | End User Flow   |       |
    | Bulk Invite     |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Jobvite

For **Jobvite**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Jobvite ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/jobvite/icon.svg" href="/ats/connectors/jobvite">
    Jobvite for the ATS category
  </Card>
</CardGroup>


# Jobylon Assessment Integration
Source: https://docs.kombo.dev/assessment/connectors/jobylon

Jobylon connector for Kombo's Assessment API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

<Note>This connector requires a partnership with Jobylon. Please contact us to get access.</Note>

The Jobylon Assessment integration allows you to sync Assessment data between Jobylon and your application through Kombo's unified API. The tool slug for this connector is `jobylon`.

## Guides and Resources

<CardGroup>
  <Card title="How assessment works in Jobylon" icon="book" href="https://help.kombo.dev/hc/en-us/articles/36618716006033">
    Additional documentation and guides for Jobylon.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Candidates">
      | Field         | Notes |
      | ------------- | ----- |
      | remote\_id    |       |
      | first\_name   |       |
      | last\_name    |       |
      | email         |       |
      | phone\_number |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | name        |       |
      | job\_code   |       |
      | description |       |
    </Accordion>

    <Accordion title="Hiring Team Members">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | first\_name |       |
      | last\_name  |       |
      | email       |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Update order result">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | assessment\_order\_id |       |
      | status                |       |
      | result\_url           |       |
      | completed\_at         |       |
      | score                 |       |
      | max\_score            |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature        | Notes |
    | -------------- | ----- |
    | End User Flow  |       |
    | Manual Trigger |       |
    | Bulk Invite    |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Jobylon

For **Jobylon**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Jobylon ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/jobylon/icon.svg" href="/ats/connectors/jobylon">
    Jobylon for the ATS category
  </Card>
</CardGroup>


# Lever Assessment Integration
Source: https://docs.kombo.dev/assessment/connectors/lever

Lever connector for Kombo's Assessment API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Lever Assessment integration allows you to sync Assessment data between Lever and your application through Kombo's unified API. The tool slug for this connector is `lever`.

## Guides and Resources

<CardGroup>
  <Card title="How assessment works in Lever" icon="book" href="https://help.kombo.dev/hc/en-us/articles/33816891739153">
    Additional documentation and guides for Lever.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Candidates">
      | Field         | Notes |
      | ------------- | ----- |
      | remote\_id    |       |
      | first\_name   |       |
      | last\_name    |       |
      | email         |       |
      | phone\_number |       |
    </Accordion>

    <Accordion title="Applications">
      | Field      | Notes |
      | ---------- | ----- |
      | remote\_id |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | name        |       |
      | job\_code   |       |
      | description |       |
      | location    |       |
    </Accordion>

    <Accordion title="Hiring Team Members">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | first\_name |       |
      | last\_name  |       |
      | email       |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Update order result">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | assessment\_order\_id |       |
      | status                |       |
      | result\_url           |       |
      | completed\_at         |       |
      | score                 |       |
      | max\_score            |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature         | Notes |
    | --------------- | ----- |
    | OAuth           |       |
    | API Passthrough |       |
    | End User Flow   |       |
    | Manual Trigger  |       |
    | Bulk Invite     |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Lever

For **Lever**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Lever ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/lever/icon.svg" href="/ats/connectors/lever">
    Lever for the ATS category
  </Card>
</CardGroup>


# Oracle Recruiting Cloud Assessment Integration
Source: https://docs.kombo.dev/assessment/connectors/oraclerecruiting

Oracle Recruiting Cloud connector for Kombo's Assessment API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Oracle Recruiting Cloud Assessment integration allows you to sync Assessment data between Oracle Recruiting Cloud and your application through Kombo's unified API. The tool slug for this connector is `oraclerecruiting`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/28654968462865">
    Step-by-step instructions to connect your Oracle Recruiting Cloud account to Kombo.
  </Card>

  <Card title="How assessment works in Oracle Recruiting Cloud?" icon="book" href="https://help.kombo.dev/hc/en-us/articles/29071838957329">
    Additional documentation and guides for Oracle Recruiting Cloud.
  </Card>

  <Card title="How background check works in Oracle Recruiting Cloud" icon="book" href="https://help.kombo.dev/hc/en-us/articles/48227296967441">
    Additional documentation and guides for Oracle Recruiting Cloud.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Candidates">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | first\_name |       |
      | last\_name  |       |
      | email       |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | name        |       |
      | description |       |
      | location    |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Update order result">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | assessment\_order\_id |       |
      | status                |       |
      | result\_url           |       |
      | completed\_at         |       |
      | score                 |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature         | Notes |
    | --------------- | ----- |
    | API Passthrough |       |
    | Scope Testing   |       |
    | End User Flow   |       |
    | Manual Trigger  |       |
    | Bulk Invite     |       |
    | Dedicated BCM   |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Oracle Recruiting Cloud

For **Oracle Recruiting Cloud**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Oracle Recruiting Cloud ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/oraclerecruiting/icon.svg" href="/ats/connectors/oraclerecruiting">
    Oracle Recruiting Cloud for the ATS category
  </Card>
</CardGroup>


# PageUp People Assessment Integration
Source: https://docs.kombo.dev/assessment/connectors/pageup

PageUp People connector for Kombo's Assessment API

<Note>This connector is in closed beta. Please contact us to get access.</Note>

The PageUp People Assessment integration allows you to sync Assessment data between PageUp People and your application through Kombo's unified API. The tool slug for this connector is `pageup`.

## Guides and Resources

<CardGroup>
  <Card title="How assessment works in PageUp People" icon="book" href="https://help.kombo.dev/hc/en-us/articles/47396020517393">
    Additional documentation and guides for PageUp People.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Candidates">
      | Field         | Notes |
      | ------------- | ----- |
      | remote\_id    |       |
      | first\_name   |       |
      | last\_name    |       |
      | email         |       |
      | phone\_number |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field      | Notes |
      | ---------- | ----- |
      | remote\_id |       |
      | name       |       |
    </Accordion>

    <Accordion title="Hiring Team Members">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | first\_name |       |
      | last\_name  |       |
      | email       |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Update order result">
      | Input Field               | Notes |
      | ------------------------- | ----- |
      | assessment\_order\_id     |       |
      | status                    |       |
      | result\_url               |       |
      | completed\_at             |       |
      | score                     |       |
      | attachments.name          |       |
      | attachments.content\_type |       |
      | attachments.data\_url     |       |
      | attachments.data          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature         | Notes |
    | --------------- | ----- |
    | API Passthrough |       |
    | End User Flow   |       |
    | Manual Trigger  |       |
    | Bulk Invite     |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** PageUp People

For **PageUp People**, we also offer the following other connector variants:

<CardGroup>
  <Card title="PageUp People ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/pageup/icon.svg" href="/ats/connectors/pageup">
    PageUp People for the ATS category
  </Card>
</CardGroup>


# Tellent Recruitee Assessment Integration
Source: https://docs.kombo.dev/assessment/connectors/recruitee

Tellent Recruitee connector for Kombo's Assessment API

<Note>This connector requires a partnership with Tellent Recruitee. Please contact us to get access.</Note>

The Tellent Recruitee Assessment integration allows you to sync Assessment data between Tellent Recruitee and your application through Kombo's unified API. The tool slug for this connector is `recruitee`.

## Guides and Resources

<CardGroup>
  <Card title="How assessment works in Recruitee" icon="book" href="https://help.kombo.dev/hc/en-us/articles/39932023235729">
    Additional documentation and guides for Tellent Recruitee.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Candidates">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | first\_name |       |
      | last\_name  |       |
      | email       |       |
    </Accordion>

    <Accordion title="Applications">
      | Field      | Notes |
      | ---------- | ----- |
      | remote\_id |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | name        |       |
      | job\_code   |       |
      | description |       |
      | location    |       |
    </Accordion>

    <Accordion title="Hiring Team Members">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | first\_name |       |
      | last\_name  |       |
      | email       |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Update order result">
      <Note>
        Recruitee requires the `result_url` to be a valid, publicly accessible link when updating an assessment result. If the URL is invalid or unreachable (for example, localhost or a private network address), Recruitee will reject the request for updating an order's result. Recruitee's API only accepts a single result attachment. This means we will only submit the first attachment and omit the rest when we send back the results.
      </Note>

      | Input Field               | Notes |
      | ------------------------- | ----- |
      | assessment\_order\_id     |       |
      | status                    |       |
      | result\_url               |       |
      | completed\_at             |       |
      | score                     |       |
      | max\_score                |       |
      | attachments.name          |       |
      | attachments.content\_type |       |
      | attachments.data\_url     |       |
      | attachments.data          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature         | Notes |
    | --------------- | ----- |
    | API Passthrough |       |
    | Scope Testing   |       |
    | End User Flow   |       |
    | Manual Trigger  |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Tellent Recruitee

For **Tellent Recruitee**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Tellent Recruitee ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/recruitee/icon.svg" href="/ats/connectors/recruitee">
    Tellent Recruitee for the ATS category
  </Card>
</CardGroup>


# Kombo Sandbox Assessment Integration
Source: https://docs.kombo.dev/assessment/connectors/sandbox

Kombo Sandbox connector for Kombo's Assessment API

The Kombo Sandbox Assessment integration allows you to sync Assessment data between Kombo Sandbox and your application through Kombo's unified API. The tool slug for this connector is `sandbox`.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Candidates">
      | Field         | Notes |
      | ------------- | ----- |
      | remote\_id    |       |
      | first\_name   |       |
      | last\_name    |       |
      | email         |       |
      | phone\_number |       |
    </Accordion>

    <Accordion title="Applications">
      | Field      | Notes |
      | ---------- | ----- |
      | remote\_id |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | name        |       |
      | job\_code   |       |
      | description |       |
      | location    |       |
    </Accordion>

    <Accordion title="Hiring Team Members">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | first\_name |       |
      | last\_name  |       |
      | email       |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Update order result">
      <Note>
        Submitted result attachments are not displayed in the ***"Assessment UI"***.
      </Note>

      | Input Field               | Notes |
      | ------------------------- | ----- |
      | assessment\_order\_id     |       |
      | status                    |       |
      | result\_url               |       |
      | completed\_at             |       |
      | score                     |       |
      | max\_score                |       |
      | attachments.name          |       |
      | attachments.content\_type |       |
      | attachments.data\_url     |       |
      | attachments.data          |       |
    </Accordion>
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Kombo Sandbox

For **Kombo Sandbox**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Kombo Sandbox ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/sandbox/icon.svg" href="/ats/connectors/sandbox">
    Kombo Sandbox for the ATS category
  </Card>

  <Card title="Kombo Sandbox HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/sandbox/icon.svg" href="/hris/connectors/sandbox">
    Kombo Sandbox for the HRIS category
  </Card>

  <Card title="Kombo Sandbox LMS" icon="https://storage.googleapis.com/kombo-assets/integrations/sandbox/icon.svg" href="/lms/connectors/sandbox">
    Kombo Sandbox for the LMS category
  </Card>
</CardGroup>


# SmartRecruiters Assessment Integration
Source: https://docs.kombo.dev/assessment/connectors/smartrecruiters

SmartRecruiters connector for Kombo's Assessment API

<Note>This connector requires a partnership with SmartRecruiters. Please contact us to get access.</Note>

The SmartRecruiters Assessment integration allows you to sync Assessment data between SmartRecruiters and your application through Kombo's unified API. The tool slug for this connector is `smartrecruiters`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/27157766640785">
    Step-by-step instructions to connect your SmartRecruiters account to Kombo.
  </Card>

  <Card title="How assessment works in Smartrecruiters" icon="book" href="https://help.kombo.dev/hc/en-us/articles/33885353094033">
    Additional documentation and guides for SmartRecruiters.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Candidates">
      | Field         | Notes |
      | ------------- | ----- |
      | remote\_id    |       |
      | first\_name   |       |
      | last\_name    |       |
      | email         |       |
      | phone\_number |       |
    </Accordion>

    <Accordion title="Applications">
      | Field      | Notes |
      | ---------- | ----- |
      | remote\_id |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | name        |       |
      | job\_code   |       |
      | description |       |
      | location    |       |
    </Accordion>

    <Accordion title="Hiring Team Members">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | first\_name |       |
      | last\_name  |       |
      | email       |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Update order result">
      <Note>
        SmartRecruiters' API requires a test's score and the test's maximum score to be submitted if you wish to write a score for the assessment order. Therefore, we will not submit a score unless you provide **both** the `score` and `max_score` fields. SmartRecruiters' API expects integer values for the `score` and `max_score` fields. If you are submitting floating-point numbers for those fields, we will round them to their nearest integers.
      </Note>

      | Input Field               | Notes |
      | ------------------------- | ----- |
      | assessment\_order\_id     |       |
      | status                    |       |
      | result\_url               |       |
      | completed\_at             |       |
      | score                     |       |
      | max\_score                |       |
      | attachments.name          |       |
      | attachments.content\_type |       |
      | attachments.data\_url     |       |
      | attachments.data          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature         | Notes |
    | --------------- | ----- |
    | OAuth           |       |
    | API Passthrough |       |
    | End User Flow   |       |
    | Manual Trigger  |       |
    | Bulk Invite     |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** SmartRecruiters

For **SmartRecruiters**, we also offer the following other connector variants:

<CardGroup>
  <Card title="SmartRecruiters ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/smartrecruiters/icon.svg" href="/ats/connectors/smartrecruiters">
    SmartRecruiters for the ATS category
  </Card>
</CardGroup>


# SAP SuccessFactors Assessment Integration
Source: https://docs.kombo.dev/assessment/connectors/successfactors

SAP SuccessFactors connector for Kombo's Assessment API

The SAP SuccessFactors Assessment integration allows you to sync Assessment data between SAP SuccessFactors and your application through Kombo's unified API. The tool slug for this connector is `successfactors`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/16225034050961">
    Step-by-step instructions to connect your SAP SuccessFactors account to Kombo.
  </Card>

  <Card title="Import Assessment Packages" icon="book" href="https://help.kombo.dev/hc/en-us/articles/26435142103057">
    Additional documentation and guides for SAP SuccessFactors.
  </Card>

  <Card title="Set up Webhooks" icon="book" href="https://help.kombo.dev/hc/en-us/articles/26452629064209">
    Additional documentation and guides for SAP SuccessFactors.
  </Card>

  <Card title="Set up a Job Requisition for Assessments" icon="book" href="https://help.kombo.dev/hc/en-us/articles/26447656191121">
    Additional documentation and guides for SAP SuccessFactors.
  </Card>

  <Card title="Set up Background Check integration" icon="book" href="https://help.kombo.dev/hc/en-us/articles/45705437906449">
    Additional documentation and guides for SAP SuccessFactors.
  </Card>

  <Card title="How assessment works in SuccessFactors" icon="book" href="https://help.kombo.dev/hc/en-us/articles/36845251399313">
    Additional documentation and guides for SAP SuccessFactors.
  </Card>

  <Card title="How background check works in SuccessFactors" icon="book" href="https://help.kombo.dev/hc/en-us/articles/45739852897553">
    Additional documentation and guides for SAP SuccessFactors.
  </Card>
</CardGroup>

## General Notes

* SuccessFactors does not allow us to upload assessment test packages via the API. *(**NOTE**: This is **NOT** an issue if you're using SuccessFactors' Background Check module)*. This means the assessment test packages you have set in Kombo need to be uploaded into the SAP Provisioning environment via a CSV file by your customer. You can find the instructions [here](https://help.kombo.dev/hc/en-us/articles/26435142103057-SAP-SuccessFactors-How-do-I-set-up-assessment-test-packages#Enable%20the%20assessment%20integration:~:text=Enable%20the%20assessment%20integration).

**NOTE**: We have implemented a utility to generate an ***"Import Assessment Vendor Packages"*** template pre-populated with the packages that you have set in Kombo for a given linked account. You can find the utility under the ***"Generate Import Vendor Assessment Packages File Template"*** section in the ***"Settings"*** page of any given SuccessFactors Assessment linked account.

* Unfortunately, SuccessFactors' UI will not display any information of the assessment submitted in their assessment portlet unless the assessment is marked as `COMPLETED`. This means the `result_url` or any attributes will not show up in SuccessFactors' UI if you are updating the orders' result with the `status` of `OPEN`

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Candidates">
      | Field         | Notes |
      | ------------- | ----- |
      | remote\_id    |       |
      | first\_name   |       |
      | last\_name    |       |
      | email         |       |
      | phone\_number |       |
    </Accordion>

    <Accordion title="Applications">
      | Field      | Notes |
      | ---------- | ----- |
      | remote\_id |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | name        |       |
      | job\_code   |       |
      | description |       |
    </Accordion>

    <Accordion title="Hiring Team Members">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | first\_name |       |
      | last\_name  |       |
      | email       |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Update order result">
      | Input Field               | Notes |
      | ------------------------- | ----- |
      | assessment\_order\_id     |       |
      | status                    |       |
      | result\_url               |       |
      | completed\_at             |       |
      | score                     |       |
      | max\_score                |       |
      | attachments.name          |       |
      | attachments.content\_type |       |
      | attachments.data\_url     |       |
      | attachments.data          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature           | Notes |
    | ----------------- | ----- |
    | API Passthrough   |       |
    | Additional Scopes |       |
    | Scope Testing     |       |
    | End User Flow     |       |
    | Bulk Invite       |       |
    | Dedicated BCM     |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** SAP SuccessFactors

For **SAP SuccessFactors**, we also offer the following other connector variants:

<CardGroup>
  <Card title="SAP SuccessFactors ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/successfactors/icon.svg" href="/ats/connectors/successfactors">
    SAP SuccessFactors for the ATS category
  </Card>

  <Card title="SAP SuccessFactors HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/successfactors/icon.svg" href="/hris/connectors/successfactors">
    SAP SuccessFactors for the HRIS category
  </Card>

  <Card title="SAP SuccessFactors LMS" icon="https://storage.googleapis.com/kombo-assets/integrations/successfactors/icon.svg" href="/lms/connectors/successfactors">
    SAP SuccessFactors for the LMS category
  </Card>
</CardGroup>


# Teamtailor Assessment Integration
Source: https://docs.kombo.dev/assessment/connectors/teamtailor

Teamtailor connector for Kombo's Assessment API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

<Note>This connector requires a partnership with Teamtailor. Please contact us to get access.</Note>

The Teamtailor Assessment integration allows you to sync Assessment data between Teamtailor and your application through Kombo's unified API. The tool slug for this connector is `teamtailor`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/27477190410769">
    Step-by-step instructions to connect your Teamtailor account to Kombo.
  </Card>

  <Card title="How assessment works in Teamtailor" icon="book" href="https://help.kombo.dev/hc/en-us/articles/42861708392977">
    Additional documentation and guides for Teamtailor.
  </Card>

  <Card title="Teamtailor Assessment: How do I become a partner?" icon="book" href="https://help.kombo.dev/hc/en-us/articles/43277775470609">
    Additional documentation and guides for Teamtailor.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Candidates">
      | Field         | Notes |
      | ------------- | ----- |
      | remote\_id    |       |
      | first\_name   |       |
      | last\_name    |       |
      | email         |       |
      | phone\_number |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | name        |       |
      | description |       |
      | location    |       |
    </Accordion>

    <Accordion title="Hiring Team Members">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | first\_name |       |
      | last\_name  |       |
      | email       |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Update order result">
      <Note>
        Teamtailor's grading system scales from 0 to 100.
      </Note>

      | Input Field               | Notes |
      | ------------------------- | ----- |
      | assessment\_order\_id     |       |
      | status                    |       |
      | result\_url               |       |
      | completed\_at             |       |
      | score                     |       |
      | attachments.name          |       |
      | attachments.content\_type |       |
      | attachments.data\_url     |       |
      | attachments.data          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature       | Notes |
    | ------------- | ----- |
    | End User Flow |       |
    | Bulk Invite   |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Teamtailor

For **Teamtailor**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Teamtailor ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/teamtailor/icon.svg" href="/ats/connectors/teamtailor">
    Teamtailor for the ATS category
  </Card>
</CardGroup>


# UKG Pro Assessment Integration
Source: https://docs.kombo.dev/assessment/connectors/ukgpro

UKG Pro connector for Kombo's Assessment API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

<Note>This connector requires a partnership with UKG Pro. Please contact us to get access.</Note>

The UKG Pro Assessment integration allows you to sync Assessment data between UKG Pro and your application through Kombo's unified API. The tool slug for this connector is `ukgpro`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/32607774039313">
    Step-by-step instructions to connect your UKG Pro account to Kombo.
  </Card>

  <Card title="How assessment works in UKG Pro" icon="book" href="https://help.kombo.dev/hc/en-us/articles/35402264867089">
    Additional documentation and guides for UKG Pro.
  </Card>

  <Card title="How background check works in UKG Pro" icon="book" href="https://help.kombo.dev/hc/en-us/articles/43716565383441">
    Additional documentation and guides for UKG Pro.
  </Card>
</CardGroup>

## General Notes

* UKG Pro only supports inline assessment flow. Please refer to Kombo's [documentation](https://docs.kombo.dev/assessment/features/inline-assessment) on how to handle inline assessments.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Candidates">
      | Field         | Notes |
      | ------------- | ----- |
      | remote\_id    |       |
      | first\_name   |       |
      | last\_name    |       |
      | email         |       |
      | phone\_number |       |
    </Accordion>

    <Accordion title="Applications">
      | Field      | Notes |
      | ---------- | ----- |
      | remote\_id |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | name        |       |
      | job\_code   |       |
      | description |       |
      | location    |       |
    </Accordion>

    <Accordion title="Hiring Team Members">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | first\_name |       |
      | last\_name  |       |
      | email       |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Update order result">
      <Note>
        UKG Pro only accepts assessment `score`s in the inclusive range of `0` to `100`. Please ensure the `score` you pass is within the required range.
      </Note>

      | Input Field           | Notes |
      | --------------------- | ----- |
      | assessment\_order\_id |       |
      | status                |       |
      | result\_url           |       |
      | completed\_at         |       |
      | score                 |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature         | Notes                                                                                                              |
    | --------------- | ------------------------------------------------------------------------------------------------------------------ |
    | Scope Testing   |                                                                                                                    |
    | Per Model Tests |                                                                                                                    |
    | End User Flow   |                                                                                                                    |
    | Bulk Invite     | UKG Pro only support inline assessment. This means the candidates will be assessed during the application process. |
    | Dedicated BCM   |                                                                                                                    |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** UKG Pro

For **UKG Pro**, we also offer the following other connector variants:

<CardGroup>
  <Card title="UKG Pro ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/ukgpro/icon.svg" href="/ats/connectors/ukgpro">
    UKG Pro for the ATS category
  </Card>

  <Card title="UKG Pro HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/ukgpro/icon.svg" href="/hris/connectors/ukgpro">
    UKG Pro for the HRIS category
  </Card>
</CardGroup>


# Workday Assessment Integration
Source: https://docs.kombo.dev/assessment/connectors/workday

Workday connector for Kombo's Assessment API

The Workday Assessment integration allows you to sync Assessment data between Workday and your application through Kombo's unified API. The tool slug for this connector is `workday`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/14350938170897">
    Step-by-step instructions to connect your Workday account to Kombo.
  </Card>

  <Card title="Import Assessment Packages" icon="book" href="https://help.kombo.dev/hc/en-us/articles/19259541378193">
    Additional documentation and guides for Workday.
  </Card>

  <Card title="How assessment works in Workday" icon="book" href="https://help.kombo.dev/hc/en-us/articles/33852492497297">
    Additional documentation and guides for Workday.
  </Card>

  <Card title="How background check works in Workday" icon="book" href="https://help.kombo.dev/hc/en-us/articles/39144821826321">
    Additional documentation and guides for Workday.
  </Card>
</CardGroup>

## General Notes

* Workday's Assessment module does not allow us to upload assessment test packages via the API *(**NOTE**: This is **NOT** an issue if you're using Workday's Background Check module)*. This means the assessment test packages you have set in Kombo need to be manually entered into Workday by your customer. You can find the instructions [here](https://help.kombo.dev/hc/en-us/articles/19259541378193).

**NOTE**: Once you have set packages for a given linked account in Kombo for a given Workday Assessment linked account, you can generate a CSV that contains a list of packages with their Test Name and Reference ID Value. You can then give the generated file to your customer to help them set up the Assessment tests within their Workday instance. You can find the utility under the ***"Generate Available Packages List"*** section in the ***"Settings"*** page of any given Workday Assessment linked account.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Candidates">
      | Field         | Notes |
      | ------------- | ----- |
      | remote\_id    |       |
      | first\_name   |       |
      | last\_name    |       |
      | email         |       |
      | phone\_number |       |
    </Accordion>

    <Accordion title="Applications">
      | Field      | Notes |
      | ---------- | ----- |
      | remote\_id |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | name        |       |
      | job\_code   |       |
      | description |       |
      | location    |       |
    </Accordion>

    <Accordion title="Hiring Team Members">
      | Field       | Notes |
      | ----------- | ----- |
      | remote\_id  |       |
      | first\_name |       |
      | last\_name  |       |
      | email       |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Update order result">
      | Input Field               | Notes |
      | ------------------------- | ----- |
      | assessment\_order\_id     |       |
      | status                    |       |
      | result\_url               |       |
      | completed\_at             |       |
      | score                     |       |
      | attachments.name          |       |
      | attachments.content\_type |       |
      | attachments.data\_url     |       |
      | attachments.data          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature           | Notes |
    | ----------------- | ----- |
    | API Passthrough   |       |
    | Additional Scopes |       |
    | Scope Testing     |       |
    | End User Flow     |       |
    | Manual Trigger    |       |
    | Bulk Invite       |       |
    | Dedicated BCM     |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Workday

For **Workday**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Workday ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/workday/icon.svg" href="/ats/connectors/workday">
    Workday for the ATS category
  </Card>

  <Card title="Workday HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/workday/icon.svg" href="/hris/connectors/workday">
    Workday for the HRIS category
  </Card>

  <Card title="Workday LMS" icon="https://storage.googleapis.com/kombo-assets/integrations/workday/icon.svg" href="/lms/connectors/workday">
    Workday for the LMS category
  </Card>
</CardGroup>


# FAQ
Source: https://docs.kombo.dev/assessment/faq

Frequently Asked Questions

#### Do I have to wait for the first sync to complete?

Yes, during the first sync, customers will need to wait for the process to complete before accessing the latest data. The duration of the first sync depends on the amount of data being synchronized and the efficiency of the data transfer process. Kombo's system will handle the sync and can notify you when it's finished via a webhook.

#### How long does the first sync take?

The duration of the first sync can vary based on factors such as the volume of data (which is influenced by [your scopes](./features/scopes)), network conditions, and the bulk export capabilities of the target system's API.

Generally, you can expect initial syncs to take **just a few minutes** for most integrations. A major exception to this are syncs involving large amounts of historical data. If you, for example, connect a large ATS instance with hundreds of thousands of applications, an initial sync might take **up to several hours** depending on the system.

In these cases, we'd recommend thinking about whether you can reduce the data points you're syncing and [adapting your scope config](./features/scopes). As a job board, you might, for example, only need to [access the applications that you created](/ats/features/application-status-tracking#syncing-only-created-candidates).

#### What should I show my customers during the first sync?

During the very first sync, you should display an informative message to users about the ongoing data update and reassure them that the app is actively fetching and updating data with a loading state or progress indicator.

#### What happens when I change my Kombo scope configuration?

The [Kombo scope configuration](./features/scopes) lets you control the data you read from your customers' systems and communicate this information when they are setting up their integrations.

But once the connection is established, your customer will **not** be forced to accept new changes you made to the scope config. That's because changes to the scope config will often be made for purely technical reasons, like enabling a single new field we expose. In these cases, we don't want to force hundreds of end customers to reconnect their systems.

Thus, when planning to make significant changes to your Kombo scopes, you should communicate this with your customers in advance and give them enough time to react.

**Important note:** Most systems allow specifying specific permissions on the API credentials. If the API credentials don't grant permissions to a specific data point, changing the Kombo scope config can't expose any more data (but it will often make Kombo syncs fail because of authorization errors). In that case, you will actually have to ask your customer to enable the missing permissions on their API credentials to allow you reading those data points.

#### What time zone and format does Kombo use for times and dates?

We return times and dates in the UTC time zone and in the standard UTC format (ISO 8601).


# Assessment UI
Source: https://docs.kombo.dev/assessment/features/assessment-ui

View assessment packages and orders from the Kombo dashboard.

## Overview

The Assessment UI is a visual interface in the Kombo dashboard that allows you to view assessment packages, track orders, and inspect order details for your assessment integrations.

This makes it easy to debug issues, monitor assessment order statuses, and
verify that your integration is working correctly.

<Frame>
  <img />
</Frame>

## Features

Below are the key features available in the Assessment UI.

<Tabs>
  <Tab title="View packages and orders">
    The Assessment UI displays all assessment packages for an integration in a
    sidebar. Clicking on a package will reveal its orders organised by their
    `status`.

    <Frame>
      <img />
    </Frame>
  </Tab>

  <Tab title="View order details">
    Clicking an order opens a sliding drawer that contains the order's details
    including the data points contained in the order, the coverage status of the
    models and their data points, and the order's result.

    <Frame>
      <img />
    </Frame>
  </Tab>

  <Tab title="View activity logs">
    Each order displays an activity timeline showing all interactions (create
    and update events). Each activity entry will link you to Kombo's
    [Logs](/assessment/features/logs) page.

    <Frame>
      <img />
    </Frame>

    <Warning>Interaction logs are only stored for 30 days.</Warning>
  </Tab>
</Tabs>

## Where to Find the Assessment UI

The Assessment UI is located within individual integration pages in the Kombo
dashboard:

1. **Go to Integrations**: Navigate to the [Integrations page](https://app.kombo.dev/integrations) in your dashboard.
2. **Select an Integration**: Click on any connected assessment integration.
3. **Access Assessment UI**: Click the ***"Assessment UI"*** tab in the integration interface.

<Frame>
  <img />
</Frame>

# Sandbox Integration

The sandbox integration is built on top of the Assessment UI, and it aims to speed up your development by testing Kombo’s Assessment API end-to-end without needing access to a real ATS.

<Tip>
  Use the Assessment Sandbox as your primary development environment to iterate
  quickly and test the full lifecycle: creating packages, receiving orders via
  webhooks, and submitting results.
</Tip>

### Development Flow

<Steps>
  <Step title="Register webhook configuration">
    In the Kombo dashboard's [Configuration
    page](https://app.kombo.dev/configuration/webhooks), create an [Assessment
    Order Received](/assessment/guides/webhooks#assessment-order-received)
    webhook configuration.

    <Frame>
      <img />
    </Frame>
  </Step>

  <Step title="Connect the Sandbox">
    Go to the [Kombo dashboard](https://app.kombo.dev/) (development
    environment), create a new integration, and select the Assessment Sandbox.

    <Frame>
      <img />
    </Frame>
  </Step>

  <Step title="Create packages">
    Click the ***"Add Package"*** button to open the package creation form.

    <Frame>
      <img />
    </Frame>

    <Note>
      You can also create packages programmatically via the [Set
      Packages](/assessment/v1/put-packages) endpoint. This is useful when you
      want to automate your test setup.
    </Note>
  </Step>

  <Step title="Trigger orders">
    Select a package, and click the ***"Create Order"*** button to open the
    order form.

    <Frame>
      <img />
    </Frame>

    Creating an order triggers the [Assessment Order
    Received](/assessment/guides/webhooks#assessment-order-received) webhook,
    which you should have configured in the dashboard. This is the same webhook
    you will receive from a real ATS integration, so you can develop your
    webhook handler against it with confidence.
  </Step>

  <Step title="Process order and update result">
    Once an order is triggered through the UI, your application should receive
    the new order webhook, process the order, and call the [Update Order
    Result](/assessment/v1/put-orders-assessment-order-id-result) endpoint to
    submit the result.
  </Step>

  <Step title="Inspect the result">
    After the result is submitted, open the order's details drawer to verify the
    result looks correct.

    <Frame>
      <img />
    </Frame>
  </Step>
</Steps>


# Audit Logs
Source: https://docs.kombo.dev/assessment/features/audit-logs

Audit sensitive changes to your Kombo environment.

## Use Case

Audit logs are essential for maintaining compliance and security within your
organization. They provide a detailed record of actions taken within your
Kombo environment, helping you track changes, identify unusual activity,
and ensure accountability.

## Accessing Audit Logs

You can access audit logs through the
[Audit Logs section in the Dashboard](https://app.kombo.dev/audit-logs).
Logs are environment-specific, so make sure to select the appropriate environment.
The dashboard allows you to query logs using the provided filter functionality.

<Frame>
  <img alt="Audit Logs Screenshot" />
</Frame>

## Limitations

Audit logs are available only on and above the scale plan and are retained for
one year, with retention periods of up to three years available on higher plans.
Custom retention policies and automated access to logs are
available on larger plans. If you require these customizations,
please contact Customer Success for assistance.


# Custom Fields
Source: https://docs.kombo.dev/assessment/features/custom-fields

Learn how to extend Kombo's unified data models with additional fields.

## What are Kombo custom fields?

Kombo's unified models cover the fields that are standard across HR, ATS, and other business systems. When your product needs additional read-side data, custom fields let you extend those models with your own stable field keys.

For example, you might add `t_shirt_size` to employees, `benefit_eligibility` to employments, or `source_campaign` to applications. Once a custom field is configured and mapped, Kombo returns it in the `custom_fields` object of the relevant API response.

This makes custom fields a good fit whenever you need a data point that is not part of Kombo's standard unified model, but you still want to read it in an integration-agnostic way.

<Info>
  Custom fields are for **reading** additional data from connected systems.
  Looking to **write** extra data when creating candidates or applications? See
  [Remote Fields](/extending-the-model#remote-fields). For a full comparison of
  all extension mechanisms, see [Extending the Model](/extending-the-model).
</Info>

## How mappings work

A Kombo custom field is the target field that appears in your API response. A field from the connected system is the source field that provides the value for a specific integration.

The source field can be anything Kombo can discover from the connected system: a standard field in that system, a niche provider-specific field, or a custom field that your customer created in their HR or ATS tool.

For example:

* A Personio employee attribute called **"Favorite Color"** can be mapped to your Kombo custom field `favorite_color`.
* A provider-specific employee field for cost center, employment type, or benefit eligibility can be mapped to a Kombo custom field if your product needs that value and Kombo's standard model does not expose it exactly the way you need.
* Different customers can use different field names, such as **"Favorite Color"** and **"Favourite Colour"**, while your API integration always reads the same Kombo key.

## Setting up custom fields in Kombo

### Create the Kombo custom field

Open [the Dashboard](https://app.kombo.dev/) and click on **Configuration** in the sidebar, then on the **Custom Fields** tab.

<Frame>
  <img
    alt="Custom fields empty
state"
  />
</Frame>

Find the relevant data model on the page. In this example, we want to add a field to employees, so click **Add custom field** in the **Employees** section.

<Frame>
  <img
    alt="Create custom field
dialog"
  />
</Frame>

Enter the field key that should appear in the API response. Let's call it `favorite_color`. The field key you choose here becomes the key in the `custom_fields` object of every mapped record.

### Prepare the field in the connected system

Sometimes the field you want to map already exists in the connected system. In other cases, your customer may first need to create or expose it there.

Let's take Personio as an example where the source field is a custom attribute in the HR system.

Under **Settings > Employee Information**, you can add new attributes or entire sections to employee profiles. We will add a new attribute called **"Favorite Color"** to the **"Public Profile"** section.

<Frame>
  <img alt="image" />
</Frame>

If we now go to the profile of an employee, we can see the new field. Let's set a value for it.

<Frame>
  <img alt="image" />
</Frame>

In the case of Personio, we need to let the API key know that we want to expose the new attribute. Go to **Settings > API Credentials**, click on the API key you used to connect to Kombo, then open the **"Readable employee attributes"** section and select the field.

<Frame>
  <img alt="image" />
</Frame>

Don't forget to click **save**.

### Map fields manually

To map a field manually, open the overview for the integration. Kombo discovers available fields during syncs, so run a sync first if the field is new or has not appeared yet.

After the sync is finished, open the custom field dropdown for the relevant model and select the field from the connected system that should fill your Kombo custom field.

<Frame>
  <img
    alt="Custom field mapping
dropdown"
  />
</Frame>

Don't forget to click **Save changes** to save your changes. After creating the mapping, the next sync will read the source value and return it under your Kombo custom field key.

<a />

### Map fields based on live data

For supported integrations, the custom field dropdown also includes a recommended option to **Identify field using live data** (see screenshot above). Click **Open Custom Field Explorer** to search the connected system directly and find the field based on real records.

<Frame>
  <img alt="Custom Field Explorer" />
</Frame>

This is useful when the field name is unclear, or when you know an example value but not the exact field key. For example, you can search for an employee with the value **"Large"** to find the field that stores T-shirt size, then map that field to your Kombo custom field.

If the Explorer is not available for an integration yet, use the regular dropdown mapping flow described above.

### Add automatic mapping rules

On the custom field detail page, you can see how many integrations use the field and which **automatic mapping rules** are defined for it.

Automatic mapping rules tell Kombo which fields of new integrations should automatically be mapped to this Kombo custom field. Each rule matches against a field key or label and can optionally be scoped to a connector. You can add as many rules as you need.

Click **Add rule** to create a new automatic mapping rule.

<Frame>
  <img
    alt="Automatic mapping rules empty
state"
  />
</Frame>

In the dialog, choose whether the rule should apply to one connector or every integration in the category. Then choose whether Kombo should match against the remote field's key or label, and enter the value to match.

<Frame>
  <img
    alt="Create automatic mapping rule
dialog"
  />
</Frame>

Whenever a sync discovers a field in an integration whose key or label matches one of your rules, its value is automatically mapped to your Kombo custom field. Going back to the Personio example: if you had set up a rule for **"Favorite Color"** scoped to Personio, the next Personio sync would have automatically mapped the value to `favorite_color`.

## Self-Serve Custom Field Configuration

To simplify the mapping process, you can allow your customers to map fields themselves using our self-serve **Setup Flow**. This is especially useful when your customer knows best which field in their system contains the value your Kombo custom field should receive.

Custom fields can be mapped as part of the connection, reducing the need for manual setup.

[Learn more about enabling self-serve field mapping here.](./setup-flow/introduction)

## Accessing custom fields in the API

Each model that supports custom fields has a `custom_fields` attribute. This attribute is a JSON object containing all mapped Kombo custom fields for that record.

When you query the API, you receive mapped custom field values in the `custom_fields` attribute. In this example, we query the [GET /employees](/hris/v1/get-employees) endpoint.

The value of a custom field mirrors what is returned by the underlying API. It is not always a string; it can also be a number, boolean, object, or array.

```json {7-17} theme={null}
{
  "status": "success",
  "data": {
    "results": [
      {
        ...
        "custom_fields": {
          "favorite_color": "blue",
          "manager": {
            "name": "Frank"
          },
          "reports": [
            {
              "name": "Tom"
            }
          ]
        }
      }
    ]
  }
}
```


# Deletion Policy
Source: https://docs.kombo.dev/assessment/features/deletion-policy

Understand how Kombo deletes data.

## General

Kombo prioritizes privacy and security by cleaning up any data that is no longer
used. We do that by following the deletion policies below. Kombo will not store
any sensitive data for longer than needed.

## Integration Data

### Case: an entry is not found anymore

When Kombo can't find an entry during a sync, we will mark it with
`remote_deleted_at` and 14 days later set all the fields to `null`.

### Case: an integration has been deleted

Kombo will delete all the data of an integration **14 days** after the integration
was deleted via API or UI.

### Case: scope config changed

**Field is turned off:** While running the next sync, Kombo will overwrite
the turned-off field for all entries with the value `null`.

**Model is turned off:** When a model gets turned off, Kombo will mark all entries with `remote_deleted_at`
and delete the entries after **14 days**.

***

## Logs

Kombo will delete statistics about syncs and write actions after **60 days**.

On all plans but the enterprise plan, Kombo will delete request data in the logs,
including the request and the response after **30 days**.


# Inline Assessment
Source: https://docs.kombo.dev/assessment/features/inline-assessment

How to handle inline assessment webhooks

In an inline assessment flow, the candidate will be assessed immediately after applying to a job via a career page. The ATS expects a URL to your platform so that the candidate can be redirected to your product to take the test.

### Reacting to new inline assessment orders

Unlike the default assessment flow, we will send out an `inline-assessment:order-received` webhook when we receive an order. The webhook will contain the following payload:

```json inline-assessment:order-received theme={null}
{
  "id": "8KNLzKfRXjJ3Xjfaz5FkgdPA",
  "type": "inline-assessment:order-received",
  "data": {
    "id": "B5KQKhAgTv6ZwzrfAbqbhipd",
    "integration_id": "workday:CBNMt7dSNCzBdnRTx87dev4E",
    "package_id": "typescript_test",
    "status": "OPEN",
    "candidate": {
      "remote_id": "12345",
      "email": "john.doe@gmail.com",
      "first_name": "John",
      "last_name": "Doe",
      "phone": "+1 123 456 7890"
    },
    "application": {
      "remote_id": "54321"
    },
    "job": {
      "remote_id": "67890",
      "name": "Bottle Opener",
      "job_code": "BO-2024-01",
      "description": "<p>We are looking for a skilled and energetic individual to join our team as the chief bottle open officer. This unique role requires precision, attention to detail, and the ability to handle a high volume of beverage bottles in a fast-paced environment. The ideal candidate will ensure bottles are opened swiftly and safely while maintaining hygiene standards.</p>",
      "location": {
        "street_1": "Lohmühlenstraße 65",
        "city": "Berlin",
        "state": "Berlin",
        "zip_code": "12435",
        "country": "DE",
        "raw": "Berlin, Germany"
      },
      "hiring_team": [
        {
          "first_name": "Jane",
          "last_name": "Doe",
          "remote_id": "78901",
          "email": "jane.doe@gmail.com",
          "hiring_team_roles": ["RECRUITER"]
        }
      ]
    }
  }
}
```

It is required that you respond with a body that contains a link to your platform where the candidate will be assessed:

```json theme={null}
{
  "assessment_url": "https://app.acme.com/assessment/:test_id"
}
```

<Warning>
  Most ATSs will terminate their request for an assessment after 15 to 30
  seconds, this means you should respond to us as soon as possible to ensure the
  order is created successfully.
</Warning>


# Integration Fields
Source: https://docs.kombo.dev/assessment/features/integration-fields

Learn how to use integration fields to read additional data properties from your customer's systems.

<Warning>
  The Integration Fields API was built for a very specific niche use case. This
  is likely not what you want to use. See [Custom Fields](./custom-fields)
  instead.
</Warning>

## What is an integration field

An integration field is a field returned from the raw response of the remote system.

## Setting up integration fields in Kombo

Before we set up the integration field in Kombo, let's talk about how you will receive the data.

Each model that supports integration fields has an `integration_fields` attribute. This attribute is an Array of JSON objects that contains all selected integration fields. We will discuss how to select integration fields in a [later step](#selecting-an-integration-field).

### View available integration fields

To list which integration fields are available for a specific integration, you should use our [GET integration-fields](../v1/get-integrations-integration-id-integration-fields) endpoint.

Example response:

```JSON theme={null}
{
    "status": "success",
    "data": {
        "results": [
            {
                "id": "123AbcDEFG4hijK5Lmn67OPq",
                "key": "dynamic_5487319",
                "model": "hris_employees",
                "type": "CUSTOM",
                "label": "Name of health insurance",
                "is_passthrough_enabled": false
            },
            ...
        ]
    },
    "next_cursor": null
}
```

If your array is empty or does not contain the values that you are looking for, double check if "integration fields" is enabled for the specific model in your [scope config](https://app.kombo.dev/scope-config).

<Note>
  Please note that this endpoint is paginated, featuring a default page size of
  250 and a maximum page size of 2000 (specified via the `page_size` parameter).
</Note>

### Selecting an integration field

To select an integration field to be passed through, use the [PATCH integration-fields](../v1/patch-integrations-integration-id-integration-fields-integration-field-id) endpoint.

An example payload would look like this:

```JSON theme={null}
{
    "enable_passthrough": true
}
```

Example response:

```JSON theme={null}
{
    "status": "success",
    "data": {
        "id": "123AbcDEFG4hijK5Lmn67OPq",
        "key": "dynamic_5487319",
        "model": "hris_employees",
        "type": "CUSTOM",
        "label": "Name of health insurance",
        "is_passthrough_enabled": true
    }
}
```

After successfully enabling passthrough on an integration field, the **next sync** will collect the values for the selected field and save them. These values then become part of our API response as follows:

## Getting integration fields as part of the API response

When you query the API, you will receive any selected integration fields in the `integration_fields` attribute. In this case, we query the [GET /employees](/hris/v1/get-employees) endpoint.
The value of an integration field mirrors what is returned by the underlying API (i.e. it's not always a `string` but can be a `number` or even an `object` too).

```JSON theme={null}
{
  "status": "success",
  "data": {
    "results": [
      {
        "first_name": "Frank",
        ...,
        "integration_fields": [
          {
            "id": "123AbcDEFG4hijK5Lmn67OPq",
            "key": "dynamic_5487319",
            "type": "CUSTOM",
            "value": "National Health",
            "label": "Name of health insurance"
          }
        ],
        ...
      }
    ]
  }
}
```


# Issue types
Source: https://docs.kombo.dev/assessment/features/issue-types

All customer-visible issue types Kombo can raise, and when they are created and resolved.

Kombo [raises an issue](./issues) when a condition is true and resolves it when that condition clears. This page lists every customer-visible type. Internal-only types are not included.

`issue.type` on the [`issue-status-changed`](../guides/webhooks#issue-status-changed) webhook is the identifier shown under each heading. We add types over time, so your handler should treat `issue.type` as an open set and not fail on unknown values.

## Authentication failed

Type: `integration.authentication_failed`

Raised when Kombo cannot authenticate with the connected tool. That happens when a sync's connection test fails with an authentication error, or when a scheduled OAuth credential refresh fails because the credentials are invalid. Rate limits during a sync do not raise this issue.

Resolved when a later sync successfully tests the connection, or when OAuth credentials refresh successfully.

## Action failing

Type: `integration.action_failing`

Raised when at least 50% of the finished calls for a specific action on an integration have failed in the last 24 hours, and there have been at least 5 finished calls in that window. Kombo checks this after each action call.

Resolved when a later check finds fewer than 5 finished calls in the window, or a failure rate below 50%. If the action is not called again, the issue also resolves 24 hours after it was last raised.

## Incoming webhooks failing

Type: `integration.incoming_webhook_failing`

Raised when at least 50% of the incoming webhooks for an integration have failed in the last 6 hours, and there have been at least 5 incoming webhooks in that window. Kombo checks this after it receives a webhook from the tool.

Resolved when at least 5 incoming webhooks in the last 6 hours have a failure rate below 50%. It stays open if webhooks stop, or if fewer than 5 have arrived in the window.


# Issues
Source: https://docs.kombo.dev/assessment/features/issues

See which integrations need attention, and how long the problem has been going on.

When an integration starts failing, you want to know about it before your customer does. Issues put those problems on the dashboard as soon as Kombo observes them, so you can act before the end customer complains.

<Frame>
  <img alt="Issues column on the integrations list" />
</Frame>

The integrations list shows an issue count on any integration that currently has an open issue. Hover the count to see the title and how long Kombo has been observing it.

Open the integration to read what is wrong and what to do next.

<Frame>
  <img alt="Issue details on an integration" />
</Frame>

## What an issue is

Kombo's issues track a problem of an integration over time. Kombo raises them when a condition is true (for example, authentication is failing) and keeps it open while that condition is still observed. When the condition clears, the issue resolves on its own.

Each issue tells you:

* what is broken
* how to investigate or fix it
* when Kombo first observed it, and when it last saw it again

See [all issue types](./issue-types) for when each one is raised and resolved. More types will follow.

## What to do when you see one

1. Open the integration from the list.
2. Read the issue. Follow the linked [logs](./logs) if you need the underlying requests.
3. If credentials are invalid, [reconnect the integration](../guides/connect/reconnection).

The [integration state](../guides/integration-states) on the same page is the current snapshot (`Active`, `Sync failing`, `Authentication failing`). The issue is the durable record that the problem is still happening, and for how long.

You can snooze an issue to hide it in the Kombo dashboard for a while. Snoozing only affects the UI. The issue stays open, Kombo keeps observing it, and it does not send an [`issue-status-changed`](../guides/webhooks#issue-status-changed) webhook.

Subscribe to that webhook to get raised and resolved events as they happen. Slack notifications will follow.

<CardGroup>
  <Card title="Issue types" icon="list" href="./issue-types">
    When each issue type is raised and resolved.
  </Card>

  <Card title="Logs" icon="scroll" href="./logs">
    Inspect the requests behind a failing sync or action.
  </Card>

  <Card title="Reconnecting" icon="arrow-rotate-right" href="../guides/connect/reconnection">
    Restore credentials when authentication has failed.
  </Card>

  <Card title="Integration states" icon="traffic-light" href="../guides/integration-states">
    Read the current operational status of an integration.
  </Card>

  <Card title="Webhooks" icon="webhook" href="../guides/webhooks#issue-status-changed">
    Get raised and resolved issue events as they happen.
  </Card>
</CardGroup>


# Komboman
Source: https://docs.kombo.dev/assessment/features/komboman

Test and troubleshoot both Kombo API and passthrough API calls with our built-in API client.

## Overview

Komboman is a powerful API testing tool built directly into the Kombo dashboard that allows you to test, explore, and troubleshoot both Kombo's unified API endpoints and integration-specific passthrough API calls. It provides a convenient way to interact with APIs without requiring you to provide any authentication credentials.

<img alt="Komboman" />

## Key Benefits

* **Test Kombo API Endpoints**: Validate Kombo's unified API responses and test data models directly
* **Test Passthrough Functionality**: Quickly verify the functionality of integration-specific API endpoints
* **Troubleshoot Data Quality Issues**: Identify and resolve data format or content issues directly
* **Self-Service Debugging**: Diagnose and resolve API issues independently
* **Request History**: Save and revisit previous API requests for reference and troubleshooting
* **Simplified Authentication**: No need to manage API keys or tokens separately - we handle the authentication

## Supported API Types

### Kombo API

Test Kombo's unified API endpoints directly from the dashboard, including all HRIS, ATS, and general endpoints like `/hris/employees`, `/ats/jobs`, `/ats/applications`, `/integrations/{integration_id}`, etc. Automatic authentication and audit logging are included.

### Passthrough APIs

Test integration-specific APIs for connected tools to access native functionality not covered by unified endpoints and debug integration-specific issues.

## How It Works

Komboman provides an intuitive interface for working with both API types:

1. **Select API Type**: Choose between "kombo" (unified API) or integration-specific passthrough APIs
2. **Configure Request**: Set the HTTP method, path, query parameters, and body for your request
3. **Send and View Responses**: Instantly see the API response, including status codes and data
4. **Save Request History**: Automatically save your requests for future reference

## Where to Find Komboman

Komboman is located within individual integration pages in the Kombo dashboard:

1. **Go to Integrations**: Navigate to the [Integrations page](https://app.kombo.dev/integrations) in your dashboard
2. **Select an Integration**: Click on any connected integration from your list
3. **Access Komboman**: Click the "Komboman" tab in the integration interface

<img alt="Komboman" />

## Getting Started

To use Komboman:

1. Select the desired API from the dropdown:
   * **"kombo"** - Test Kombo's unified API endpoints for the selected integration.
   * **Integration-specific APIs** - Test passthrough functionality
2. Configure your request with the appropriate method, path, and payload
3. Send your request and analyze the response

### Testing Kombo API Endpoints

When testing Kombo API endpoints, select "kombo" from the API dropdown and enter the endpoint path (e.g., `/employees`, `/jobs`, `/applications`). Refere to our API reference for all available endpoints. All requests are automatically authenticated and audit logged.

### Testing Passthrough APIs

When testing integration-specific passthrough APIs, select the appropriate passthrough API from the dropdown and configure the request according to the integration's native API documentation which is linked on the selected API.

Komboman works directly with our [Passthrough API](./passthrough-api), which enables you to interact with the native APIs of specific integrations while we handle the authentication.

## Access Permissions

Komboman is available to:

* **Production Environment**: Users with admin role
* **Development Environment**: Users with admin or developer role


# Logs
Source: https://docs.kombo.dev/assessment/features/logs

Learn how Kombo's logs allow you to monitor and troubleshoot your integrations.

## Overview

Our logs enable you to dig deeper into what is happening behind your integrations. Depending on the type of interaction, different logs are available.

You can find the logs in the [sidebar of the Kombo dashboard](https://app.kombo.dev/logs).

<Frame>
  <img alt="logs-overview" />
</Frame>

### Available Log types

| Log Type             | Description                                                                                                                                                                   | Features                                                                 |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| **Sync**             | Created for each recurring sync of an integration                                                                                                                             | [Sync Metrics](#sync-metrics), [Request Logs](#request-logs)             |
| **Connection Flow**  | Created for each connection flow interaction                                                                                                                                  | [Event Logs](#connection-flow-event-logs), [Request Logs](#request-logs) |
| **Action**           | Created whenever Kombo receives an API request which triggers Kombo to make external API requests to a tool. E.g. [create application](/ats/v1/post-jobs-job-id-applications) | [Request Logs](#request-logs)                                            |
| **Passthrough**      | Created for each [passthrough](./passthrough-api) request made                                                                                                                | [Request Logs](#request-logs)                                            |
| **Incoming Webhook** | Created whenever a tool sends an API request to Kombo                                                                                                                         | [Request Logs](#request-logs)                                            |

### Filters

Use filters to narrow your search and find exactly what you're searching for.

We additionally make sure to link back to any logs from relevant dashboard pages. For example, you can instantly query an integration's logs by clicking "logs" on the integration's details page.

<Frame>
  <img alt="log-filters" />
</Frame>

## Request Logs

Request logs help you see any API requests that Kombo is making to the integrated tool, and debug any issues. If an integration is having issues, request logs let you deep dive into understanding which endpoints are causing problems, such as finding requests returning `403` status codes for missing permissions.

<Frame>
  <img alt="request-logs" />
</Frame>

### Viewing Details

Click on a row to view details of the API request. Kombo will redact any sensitive data.

You can view the response of the request by clicking on **Open response**.

<Frame>
  <img alt="request-log-details" />
</Frame>

### Retention

By default, Kombo stores logs for 30 days. Longer retentions are available upon request on the enterprise plan.

## Connection Flow Event Logs

We store any decisive events that happen throughout the connection flow to enable you to understand exactly what your customer is experiencing. This visibility lets you detect what is preventing your customers from connecting their tool, and ultimately reach out to them with the right help to complete the integration.

<Frame>
  <img alt="connection-flow-logs" />
</Frame>

View your current connection flow logs in the [Kombo dashboard](https://app.kombo.dev/logs?kind=CONNECTION_FLOW).

### Identifying User Sessions

The logs are grouped by user sessions, with a 'broken' line indicating a break between two sessions. Viewing sessions allows you to gain insights on when a user exited and/or re-entered the connection flow.

<Frame>
  <img alt="flow-log-sessions" />
</Frame>

## Sync Metrics

The sync metrics tab allows you to gain insights into which data was read and whether any issues occurred. Use this to quickly verify that the expected data is being synced without having to make any API calls.

<Frame>
  <img alt="sync-metrics" />
</Frame>


# Passthrough API
Source: https://docs.kombo.dev/assessment/features/passthrough-api

Implement any edge case feature with our passthrough API.

## Overview

The Passthrough API lets you call the native API of any connected integration directly, while Kombo handles authentication for you. This bridges the gap between the unified API and integration-specific requirements — you get the consistency of Kombo's auth layer with the flexibility of the underlying tool's full API surface.

## When to Use It

Use the Passthrough API when you need integration-specific data or actions that the unified API does not cover. Common examples:

* Reading provider-specific resources (e.g., HiBob work history, Workday compensation plans)
* Calling write endpoints that Kombo doesn't offer as a unified action
* Accessing tool-specific configuration (e.g., ATS picklists, custom templates)

<Tip>
  For reading additional fields on standard models, prefer [custom
  fields](./custom-fields) — they're simpler and work across integrations.
  [Integration fields](./integration-fields) cover a narrow niche and are rarely
  the right choice. The Passthrough API is best for accessing entirely different
  endpoints or performing writes that aren't part of the unified API.
</Tip>

## How It Works

1. **Authentication**: Authenticate with your Kombo API key as usual. Kombo forwards the request with the correct tool-specific credentials.
2. **Choose the API**: Find the API identifier for your integration in the [passthrough endpoint reference](../v1/post-passthrough-tool-api).
3. **Build your request**: Specify the HTTP method, endpoint path, headers, query parameters, and request body — exactly as the tool's native API expects.

## The `api_options` Parameter

Most integrations don't require `api_options` — simply set the `path` and Kombo routes to the right API.

However, some integrations have multiple underlying APIs or services that share the same authentication but use different base URLs or protocols. For these, `api_options` tells Kombo which specific service to target.

Integrations that use `api_options` document the required fields directly on their passthrough endpoint specification. Common examples:

* **Workday REST**: requires `service_name` (e.g., `"staffing"`, `"compensation"`) and optionally `version` to select the correct REST service
* **Workday SOAP**: requires `service_name` (e.g., `"Staffing"`, `"Recruiting"`) and optionally `service_version` to target the right SOAP service
* **SOAP-based tools** (Nmbrs, HR Office, Taleo): require `service_name` or `operation_name` to route to the correct SOAP service

If an integration doesn't document `api_options`, you don't need to provide it.

## Testing with Komboman

Use [Komboman](./komboman), the built-in API client in the Kombo dashboard, to test passthrough calls interactively. It handles authentication automatically and saves request history, making it easy to experiment with native API endpoints.

Find the full passthrough endpoint specification [here](../v1/post-passthrough-tool-api).


# Remapping array fields
Source: https://docs.kombo.dev/assessment/features/remapping/array-remapping

Learn how to use the remapping feature to adjust Kombo array fields based on fields in your customer's systems.

## Remapping an array field

Array fields in the Kombo data model can have multiple entries per entity. For example our HRIS employee can have multiple `bank_accounts` and an ATS candidate can have multiple `email_addresses`.
These fields will offer two mapping modes: `Replace` and `Append`

<Frame>
  <img alt="image" />
</Frame>

This will decide wether you would like to persist the Kombo default mappings in
the array or replace the array entirely.

After deciding on the mapping mode you can start adding entries to the array. Please note that all required fields for an entry need to be mapped.

<Frame>
  <img alt="image" />
</Frame>

For `bank_accounts` you need to select an account type before the fields show up. You can mix multiple types in the array.

<Frame>
  <img alt="image" />
</Frame>

## Fallbacks

Fallbacks are not available for these fields. Instead you can add multiple values to the array. If any required field (marked with red asterix) of single entry is missing, the entry will not be added to the array.

<Frame>
  <img alt="image" />
</Frame>


# Remapping date fields
Source: https://docs.kombo.dev/assessment/features/remapping/date-remapping

Learn how to use the remapping feature to adjust Kombo date fields based on fields in your customer's systems.

## Remapping a date field

1. Select the source field of the date. It can bei either a string or number.
   <Frame>
     <img alt="image" />
   </Frame>
2. Pick a date format from our presets or choose `Custom format`.
   <Frame>
     <img alt="image" />
   </Frame>
3. (optional) If you have custom field examples enabled we will display a validation section below. Adjust the format until the dates are parsed as desired.
   <Frame>
     <img alt="image" />
   </Frame>
4. Press the `Save configuration` button on the bottom right.
   <Frame>
     <img alt="image" />
   </Frame>


# Remapping enum fields
Source: https://docs.kombo.dev/assessment/features/remapping/enum-remapping

Learn how to use the remapping feature to adjust Kombo enum fields based on fields in your customer's systems.

## Remapping an enum field

1. Select the source field to map the enum from.
   <Frame>
     <img alt="image" />
   </Frame>
2. Define a default value. This will be the result in case the value is not mapped or null. If you want to use `fallbacks` make sure to select `None (null)` here.
   <Frame>
     <img alt="image" />
   </Frame>
3. Define an enum map. For this you first input the source string on the left. Then click the `Add mapping` button.
   <Frame>
     <img alt="image" />
   </Frame>
   After adding the source string, select one of the Kombo enum values.
   <Frame>
     <img alt="image" />
   </Frame>


# Introduction
Source: https://docs.kombo.dev/assessment/features/remapping/introduction

Learn how to use the remapping feature to adjust Kombo default fields based on fields in your customer's systems.

## Prerequisits

The remapping UI is located on each individual integration right next to the "Custom Field Mappings" tab.

<Frame>
  <img alt="image" />
</Frame>

1. Your scope config for the integration will need either `custom_fields` or `integration_fields` **enabled for each model** you wish to remapp.
   <Frame>
     <img alt="image" />
   </Frame>
2. The initial sync has **finished successfully** and the integration is **not in QA mode**.
   <Frame>
     <img alt="image" />
   </Frame>
3. (optional) To improve your mapping experience we recommend enabling custom field examples for new integrations. The setting can be found under `Configuration` in the left sidebar.
   <Frame>
     <img alt="image" />
   </Frame>

We offer different user interfaces to accomedate the complexity that comes with each specific field:

1. [Simple string/number/boolean fields](./simple-remapping)
2. [Enum fields](./enum-remapping)
3. [Date fields](./date-remapping)
4. [Address fields](./struct-remapping)
5. [Reference fields](./reference-remapping)
6. [Array fields](./array-remapping)

Additionally, you can use the [Kombo Default Fallback](./kombo-default-fallback) to include Kombo's standard mapping logic as a priority in your fallback chain — available for simple, enum, and date fields.


# Kombo default fallback
Source: https://docs.kombo.dev/assessment/features/remapping/kombo-default-fallback

Learn how to use Kombo's standard mapping logic as a fallback priority in your remapping configuration, giving you full control over the mapping order.

## What is the Kombo Default Fallback?

When you [override a field mapping](./introduction), you replace Kombo's built-in mapping logic with your own custom configuration. This is powerful, but sometimes you don't want to *replace* Kombo's logic entirely — you want to **combine** your custom mapping with Kombo's standard logic in a specific priority order.

The **Kombo Default Fallback** lets you insert Kombo's standard mapping logic as one of the priorities in your fallback chain. This means you can:

* Use a custom integration field as the primary source, and **fall back to Kombo's default** if that field is empty
* Use Kombo's default mapping as the **primary value**, but override it with a custom field when Kombo's value is empty
* Place Kombo's default logic **between** two custom field sources in a multi-level fallback chain

<Note>
  The Kombo Default Fallback is available for **simple** (string, number,
  boolean), **enum**, and **date** field remappings. It is not available for
  address, reference, or array field types.
</Note>

## When should you use it?

Consider using the Kombo Default Fallback when:

* **Kombo's default mapping works well in most cases**, but a small number of your customer's records store the value in a different field. You can set Kombo's default as Priority 1 and your custom field as a fallback.
* **A custom field is your preferred source**, but it isn't always populated. By adding Kombo's default as a fallback, you ensure no data is lost when the custom field is empty.
* **You want to experiment with a custom mapping** without losing the safety net of Kombo's proven default logic. If your custom source produces `null`, Kombo's standard mapping takes over automatically.

## How it works

The remapping engine evaluates your fallback chain **from top to bottom** (Priority 1 first, then Priority 2, and so on). For each record (employee, candidate, job, etc.), it checks each priority in order and **stops as soon as a valid, non-empty value is found**.

When the engine reaches a "Default Kombo value" entry in the chain, it uses the value that Kombo's standard mapping logic would have produced for that field — exactly as if no remapping had been configured.

### Example: Custom field with Kombo default as safety net

Suppose you want to map the `first_name` field from a custom integration field called `preferred_name`, but not every record has a preferred name set.

| Priority | Source                               | Behavior                                                                           |
| -------- | ------------------------------------ | ---------------------------------------------------------------------------------- |
| 1        | `preferred_name` (integration field) | Used when the field has a value                                                    |
| 2        | Default Kombo value                  | Falls back to Kombo's standard `first_name` mapping when `preferred_name` is empty |

**Result**: Records with a `preferred_name` get that value. Records without it seamlessly fall back to whatever Kombo would have mapped by default.

### Example: Kombo default with a custom override

You trust Kombo's mapping for most records, but for a few edge cases you know a specific integration field has better data.

| Priority | Source                             | Behavior                                               |
| -------- | ---------------------------------- | ------------------------------------------------------ |
| 1        | Default Kombo value                | Used when Kombo's standard mapping produces a value    |
| 2        | `backup_field` (integration field) | Only used when Kombo's default mapping produces `null` |

**Result**: Kombo's default logic runs first. Only when it returns nothing does the system check `backup_field`.

## Adding a Kombo Default Fallback

1. Open the remapping modal for the field you want to configure (see [simple](./simple-remapping), [enum](./enum-remapping), or [date](./date-remapping) remapping for details on how to open the modal).
2. At the bottom of the modal, click the **Fallback to Kombo's mapping** button.
   <Frame>
     <img alt="image" />
   </Frame>
3. A new priority entry will appear showing **"Default Kombo value"** with the description *"Uses Kombo's standard mapping logic for this field."*
   <Frame>
     <img alt="image" />
   </Frame>
4. You can **reorder** priorities by removing and re-adding entries. The Kombo Default Fallback can be placed at any position in the fallback chain — it does not have to be last.
5. Click **Save** to apply the configuration. Remember that **a sync is required** for saved changes to take effect.

## Combining with other fallbacks

You can freely mix Kombo Default entries with custom integration field entries. For example, a three-level fallback chain for an enum field might look like:

| Priority | Source                                                      |
| -------- | ----------------------------------------------------------- |
| 1        | `custom_status_field` (integration field) with enum mapping |
| 2        | Default Kombo value                                         |
| 3        | `legacy_status_field` (integration field) with enum mapping |

The engine will try `custom_status_field` first. If it's empty, it falls back to Kombo's default enum mapping. If even that produces `null`, it tries `legacy_status_field` as a last resort.

<Tip>
  If the **only** entry in your fallback chain is a Kombo Default, the
  configuration is equivalent to having no remapping at all. In this case, the
  system will automatically clear the remapping configuration when you save.
</Tip>

## Supported field types

| Field type                                             | Kombo Default Fallback supported |
| ------------------------------------------------------ | -------------------------------- |
| [Simple](./simple-remapping) (string, number, boolean) | Yes                              |
| [Enum](./enum-remapping)                               | Yes                              |
| [Date](./date-remapping)                               | Yes                              |
| [Address](./struct-remapping)                          | No                               |
| [Reference](./reference-remapping)                     | No                               |
| [Array](./array-remapping)                             | No                               |


# Remapping reference fields
Source: https://docs.kombo.dev/assessment/features/remapping/reference-remapping

Learn how to use the remapping feature to adjust Kombo reference fields based on fields in your customer's systems.

## Remapping an reference field

Reference fields are fields that reference related entities. For example our employee model has three reference fields: manager\_id, legal\_entity\_id and work\_location.
These fields can offer up to two mapping types.

<Frame>
  <img alt="image" />
</Frame>

## Refernce existing record

1. When choosing `Refernce existing record` the model will be linked to an already existing record.
2. You will need to select a field that contains the same remote id as the model you wish to reference.
   <Frame>
     <img alt="image" />
   </Frame>
   If the referenced record does not exist, it will be created but all other
   fields except the id will be `null`.

## Create new record with mapped data

1. When choosing `Create new record with mapped data` the model will be linked to a new record. You will be able to create a new work location, legal entity, etc.
2. Fill the the remote id with the unique identifier you want to use for the new record.
3. Then fill the rest of the properties.
   <Frame>
     <img alt="image" />
   </Frame>

You will be able to receive the new record on both the `/employees` endpoint, as well as the relations own endpoint (`/work-locations`, `/legal-entities`).
Note: This option is not available for all reference fields.


# Remapping simple fields
Source: https://docs.kombo.dev/assessment/features/remapping/simple-remapping

Learn how to use the remapping feature to adjust simple Kombo default fields based on fields in your customer's systems.

## Remapping a simple string/number/boolean field

To start the remapping process open the remapping UI and click on the `Override default Kombo value` button of the field you want to remapp.

<Frame><img alt="image" /></Frame>A new popup will
appear allowing you to configure the remapping for the individual field.

<Frame>
  <img alt="image" />
</Frame>

Under `Priority 1` you can select the source field you would like to use for the
remapping. You can search in the selection box, see the example values and even
use our custom field explorer feature.

<Frame>
  <img alt="image" />
</Frame>

After selecting the field, you can press the `Save` button to save the
configuration.

<Frame>
  <img alt="image" />
</Frame>

If this is your first remapping, a popup will appear, which reminds you that **a
sync is required** for the saved changes to show their effect.

<Frame>
  <img alt="image" />
</Frame>

## Fallbacks

In case the selected field is removed (`undefined`), `null` or changes it's structure (`string` => `array`), the remapping will result in `null` as output.
For these cases it makes sense to define one or multiple fallback values, when configuring a remapping. You can do so by clicking the `Add fallback` button in the configuration UI.

<Frame>
  <img alt="image" />
</Frame>

We will execute the remapping top to bottom. This means the remapping stops for
each the entity (employee, candidate, job...) has soon as valid value is found.

<Frame>
  <img alt="image" />
</Frame>

You can also use the **Fallback to Kombo's mapping** button to include Kombo's standard mapping logic as one of the priorities in your fallback chain. This is useful when your custom field is not always populated and you want to fall back to what Kombo would have mapped by default. Learn more in the [Kombo Default Fallback](./kombo-default-fallback) guide.


# Remapping address fields
Source: https://docs.kombo.dev/assessment/features/remapping/struct-remapping

Learn how to use the remapping feature to adjust Kombo address fields based on fields in your customer's systems.

## Remapping an address field

1. An address in Kombo consists out of multiple fields. Select an integration field for each field you wish to fill. Unfilled will result in `null` for the respective property.
   <Frame>
     <img alt="image" />
   </Frame>
2. You might need to scroll to see all available fields.

Note: English country names will get automatically resolved to the ISO 3166-1 alpha-2 country code.

## Fallbacks

Fallbacks are only executed if **all fields** in the priority above are missing (`undefined`), `null` or empty (`''`).


# Extend write endpoints
Source: https://docs.kombo.dev/assessment/features/remote-fields

Learn how Kombo allows you to write additional, otherwise unsupported fields with unified write actions.

## Overview

Kombo supports a feature called **Remote Fields** for many write endpoints. This
feature solves a similar problem as the [passthrough API](./passthrough-api) while still allowing you
to use the unified Kombo API.

## How does it help you

While we always try to solve even niche use cases with our unified API, there are cases
where an integration requires particular data (for example, because your customer
uses required custom fields or customizes their system a lot). In these cases, the
remote fields feature allows you to pass this data to the connected system.

Remote fields also allow you to customize specific endpoints even more, as it
would be out of scope for the unified model.

If you need to read additional data from connected systems instead, use
[custom fields](./custom-fields).

## How to use it

Write actions that support this feature support have a property called `remote_fields`
on the root level request body. This object follows a record structure where the
key is the name of the tool (e.g., `greenhouse`), and the value is an object
highly specific to the tool. On a high level, most available fields are documented in the endpoint specification.

A good example of a write endpoint supporting this feature is [the ATS API endpoint to create a new application](/ats/v1/post-jobs-job-id-applications) (search for 'remote fields').

### Example

A SuccessFactors instance requires the nationality of applicants as an attribute.
`nationality` isn't an attribute that is ordinarily supported by our
'Create application' endpoint. Because application creation generally works the
same otherwise, you can use `remote_fields` to extend the requests that we send
to SuccessFactors with the `nationality` field.

### Remote fields in practice

You will likely find out about any required remote fields during testing.
You may try to submit a dummy candidate, however, you receive an error message like the
following:

```
{'status': 'error', 'error': {'message': {'remote_http_status': 500, 'remote_error': {'error': {'code': 'COE_GENERAL_SERVER_FAILURE', 'message': {'lang': 'en-US', 'value': '[COE0019]Unexpected error occurred: custNationality required for external candidate, custFutSponsor required for external candidate as per field override,  for templateId 579 ,  with the index 0'}}}}}}
```

For example, for the above error message, you would then need to add the following fields to your create candidate call for the parameter `remote_fields`:

```
{
    "successfactors": {
        "Candidate": {
            "custNationality": "some-nationality",
            "custFutSponsor": "some-sponsor"
        }
    }
}
```

You can then use an iterative process based on the error messages
("trial-and-error") to tell whether you are now submitting the correct remote fields.

### Help

Don't hesitate to contact us if you have any questions about this feature
or you need help with a specific use case.


# Scopes
Source: https://docs.kombo.dev/assessment/features/scopes

Scopes allow you to customize what data is being synced by Kombo.

By default, Kombo syncs all available data from connected systems. This can be
pretty convenient for exploring what's available during development, but as soon
as you take Kombo into production, you'll likely want to restrict what data is
extracted and stored for privacy and security reasons.

For this purpose, Kombo provides what we call "Scopes." These allow you to
configure precisely which models and data points are being extracted and stored.
Scopes can, for example, be used to anonymize data by removing all personal
identifiable information from the data we store.

## Configuring scopes

To get started configuring scopes, log into the
[Kombo Dashboard](https://app.kombo.dev) and open the "Scope Config" page. It
should look something like this:

<Frame>
  <img alt="1464" />
</Frame>

### Configure scope config

When editing your scope configs or creating a new one, a page similar to this
one will open:

<Frame>
  <img alt="1464" />
</Frame>

All of Kombo's Data Models are listed here, and you can disable, enable or
mark an entire Data Model as optional.
We do not sync data from disabled data models. Optional Data Models aren't
synced if your customer opts out of having the field exposed. Enabled
models are always synced.

We recommend turning all Data Models off that you are not interested in. For example,
if you want to sync employee, employment and organization data
but are not interested in absences, turning off the absence type, absences and
time off balance Data Models is recommended. This will simplify the setup for your customer, improve sync times, and
not expose any data that does not need to be exposed.

### Configuring fields

If you only want to turn off individual model fields, you can expand
each model in the edit page. You will now see all the fields it supports:

<Frame>
  <img alt="1426" />
</Frame>

For example, if you don't want to sync sensitive data like SSNs or Tax IDs,
you can turn them off here. Similarly, if you would like to read
personal identifiable information but it is not required for your use-case,
consider marking the field as optional. This will give your customers the choice
of whether they want to expose it or not.

## Building trust with your customers

Some of the systems we help you integrate contain very sensitive data (like
personal addresses or tax IDs of employees). That's why
communicating which data points you access and which you don't is critical to
building trust and eradicating concerns during the sales process.

To help you with this, we're exposing your scope config to the end user as part
of our connection flow:

<Frame>
  <img alt="1002" />
</Frame>

This way, your customers can see exactly which data points you're accessing.


# Setup Flow
Source: https://docs.kombo.dev/assessment/features/setup-flow/introduction

Let your customers configure their integration end-to-end.

<img alt="Setup Flow" />

The [Connection Flow](/kombo-connect) lets your customers authenticate and
validate their credentials. The Setup Flow covers everything that comes after:
any additional configuration the integration needs before it can sync the right
data. It is presented to your customers as a self-serve UI inside the Kombo
Connect SDK, so they can complete it without you building anything yourself.

## What appears in the Setup Flow

Each integration decides which steps it actually needs. The most common ones
are:

* **[Field mapping](../custom-fields#self-serve-custom-field-configuration)**,
  where customers connect your custom fields to fields in their tool. Available
  for any category as long as you've defined custom fields.
* **[Employee filtering](/hris/features/filtering/introduction)**, where HRIS
  customers choose which employees Kombo should sync.
* **Tool-specific steps**, surfaced automatically by some connectors (for
  example Greenhouse, Teamtailor, or SCIM) to handle one-time configuration that
  the tool itself requires, like activating webhooks or providing additional
  credentials.

Steps only show up when they are relevant. If a customer connects a tool that
does not support filtering, the filtering step is hidden even when the feature
is enabled on the integration.

## Enabling Setup Flow steps

Field mapping and employee filtering are opt-in per integration. Tool-specific
steps require no configuration on your side, they appear automatically when
needed.

### When creating a new integration

In the Dashboard, open the [Integrations
page](https://app.kombo.dev/integrations) and toggle the steps you want at the
bottom of the create-link form.

<img
  alt="Integration Creation Form Setup Flow
Toggles"
/>

You can do the same via the API by setting `enable_field_mapping` and/or
`enable_filtering` (HRIS only) to `true` on the [Create Connection Link
endpoint](../../v1/post-connect-create-link).

### For an existing integration

Open the integration in the Dashboard and use the toggles in the **Integration
Settings** tab.

<img alt="Integration Settings Setup Flow Toggles" />

## Showing the Setup Flow to your customers

Setup Flow steps run automatically as part of the [Connection
Flow](/kombo-connect) the first time a customer connects a tool, so the
embedded flow you already have in place will pick them up without any changes.

To send customers back into the Setup Flow later, for example to update field
mappings or change which employees are synced, create a setup link with the
[Create Setup Flow link
endpoint](../../v1/post-integrations-integration-id-setup-link) and pass it to
`showKomboConnect` from the [Kombo Connect
SDK](../../guides/connect/embedded-flow#opening-the-flow), the same way you do
with a connection link.

You can also generate a setup link from the Integration Details page in the
Dashboard if you'd rather not wire up the API yourself.


# Overview
Source: https://docs.kombo.dev/assessment/getting-started

Let's get you up and running with our API!

<Note>
  This guide assumes you already have a Kombo account. If that's not the case,
  visit [our website](https://www.kombo.dev/) to learn more and get access.
</Note>

# Getting started

There are a few simple steps that you should follow to get started with our API.

1. [Get access to a sandbox integration](./getting-started/sandbox-integrations)
2. [Create an integration](./getting-started/create-integrations)
3. [Call our API](./getting-started/authentication)
4. [Querying the API](./getting-started/querying-api)
5. [Fetching Data](./getting-started/fetching-data)


# Authentication
Source: https://docs.kombo.dev/assessment/getting-started/authentication

Learn how to authenticate with the Kombo API and manage API keys securely.

## Authentication

You need to get an API key from the Kombo dashboard to call our API.
You can create one on the [Secrets page](https://app.kombo.dev/secrets).

You might have multiple environments in your Kombo account. Each API key is
specific to an environment.

This will allow you to call some general endpoints that are not
integration-specific. For example, try calling the following test API key endpoint:

```bash theme={null}
curl --request GET \
  --url https://api.kombo.dev/v1/check-api-key \
  --header 'Authorization: Bearer <YOUR_API_KEY>'
```

## Calling Integration Endpoints

To call integration-specific endpoints, you need the integration ID. An integration ID identifies a specific
instance of a tool connected to Kombo. If you haven't created an integration yet,
read the [creating integrations guide](./create-integrations).
Get the integration ID from the details of integration on the [integrations dashboard page](https://app.kombo.dev/integrations).

Pass the integration ID with the `X-Integration-Id` header in your API requests. For example:

```bash theme={null}
curl --request GET \
  --url https://api.kombo.dev/v1/hris/employees \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'X-Integration-Id: <integration_id>'
```

<Note>
  Find out more about the integration-specific endpoints for
  [HRIS](/hris/getting-started) or [ATS](/ats/getting-started)
</Note>

## API Key Security

Kombo provides several features to help you manage API keys securely.

### Key Scoping

Each API key is scoped to a single [environment](../guides/environments) (Production or Development). Keys created in Production cannot access Development data and vice versa. The key prefix reflects the environment: `ks_prod_...` for production, `ks_dev_...` for development.

### Expiration

When creating an API key, you can set an optional expiration date. Once expired, any request using the key will return an authentication error. To rotate keys without downtime, you must overlap the old and new keys: create a new key, migrate all of your services to use it, and only then let the old key expire (or revoke it).

### IP Allowlisting

You can restrict each API key to a set of IP addresses or CIDR ranges. When an allowlist is configured, requests from non-listed IPs are rejected. An empty allowlist (the default) permits any IP. You can update the allowlist at any time without recreating the key.

### Revocation

API keys can be individually disabled from the dashboard. Disabling a key takes effect immediately — all subsequent requests using that key will fail. Disabled keys cannot be re-enabled; create a new key instead.

### Audit Trail

All key operations — creation, disabling, and IP allowlist changes — are recorded in the [audit log](../features/audit-logs).


# Creating Integrations
Source: https://docs.kombo.dev/assessment/getting-started/create-integrations

Learn how to connect tools to Kombo.

<Note>
  This guide assumes you already have a Kombo account. If that's not the case,
  visit [our website](https://www.kombo.dev/) to learn more and get access.
</Note>

## Ways of Creating Integrations

There are three ways of creating integrations in Kombo:

1. **For you in development**: Use the Kombo Dashboard and enter the integration credentials yourself.
   This is the easiest way to get started if you want to test out Kombo.
2. **For customers with a magic link**: Create a magic link and send that to your customer to create the integration.
   This is the simplest way to launch integrations for selected customers (for example, as a POC).
3. **For customers with Kombo embedded**: Embedding Kombo into your application and allowing the customer to create the integration there.
   This will give your customer the best experience and is generally recommended when rolling out Kombo to your customers.

If you are testing Kombo or developing the integration to us, make sure to
select the development environment in the top left corner.
This will not count against your billing and will have useful features like saving
the credentials that you entered and filled out some fields by default.

# Creating Integrations in the Dashboard

<Tip>Recommended for development purposes.</Tip>

Go to the [dashboard integrations page](https://app.kombo.dev/integrations) and
click on the "Create Integration" button. Select `Create the integration yourself`.

<Frame>
  <img alt="image" />
</Frame>

Select a category and continue (if you use the development environment,
the organization and email will be auto-filled). Select a tool that you have
access to and enter the credentials. The flow will explain, in most cases, what
you need to do to get the credentials out of the tool.

# Creating a magic link

<Info>Use this to get started immediately with a selected customer.</Info>

Open the [dashboard integrations page](https://app.kombo.dev/integrations) and
click on the "Create Integration" button. Select *Let your customer create the integration*.

Select the category and fill out the organization name and email address.
This data is only for you to identify who created the integration and will be used
as a label in the dashboard.

Features that you can use with the embedded flow are:

* Pre-defining a tool
* Defining a language

# Embedding Kombo into your Application

<Info>
  This is only necessary if you want to allow your customer to create
  integrations completely on their own.
</Info>

Embedding Kombo in your application requires implementing the Kombo API into your product.
Embedding Kombo allows you to provide a better experience to your customers and customize the
connection flow the most.

Features that you can use with the embedded flow are:

* Pre-defining a tool
* Defining a language
* Specifying the `remote_environment` (for using sandbox credentials with some tools)
* Using a scope config template
* Setting the `origin_id` (id of the customer in your system)

<Note>
  Read more about embedding Kombo into your application
  [here](../guides/connect/embedded-flow).
</Note>


# Querying the API
Source: https://docs.kombo.dev/assessment/getting-started/querying-api

Learn how to filter and paginate the Kombo `GET` endpoints. This will help you implement incremental fetching and more.

## SDKs

You can use our officially supported SDKs to interact with our API. For more information, see the [Libraries and SDKs](/libraries-and-sdks) section.

## General Response Format

All *GET* endpoints of Kombo follow the same principle. All of them return a list
of results and a next cursor. All results follow the same basic structure with the
following properties:

* `id`: An ID generated by Kombo, also referred to throughout the documentation as "Kombo ID".
* `remote_id`: The ID of the object in the remote system. This can be null for some objects.
* `changed_at`: Part of Kombo's change tracking — this is the timestamp of the last change that was detected by Kombo.
* `remote_deleted_at`: Part of Kombo's change tracking — this is the timestamp where the object was not found anymore in the remote system.

*Other properties are model-specific.*

### A note on Kombo IDs and their uniqueness

We generate the Kombo ID by referencing the remote ID and the integration ID.

This results in the following statements being true:

* A Kombo ID is unique across all integrations for *the same model*.
  * This is because we reference the integration ID itself when generating the Kombo ID.
* A Kombo ID is *not* unique across different models for the same integration.
  * This will occur for remote systems that follow a sequential ID pattern. For example, both the first employee and department have the ID `1`. As the integration ID is the same, so will the Kombo ID.

## Pagination

Each request returns either a value on the `next` field or `null`. The
value will be a cursor which you can use to get the next page of results. Use
the `cursor` query parameter to request the next page. (Please note that you
still need to add the relevant filters while paginating.)

In addition, you can use the `page_size` parameter to specify the number of results per page.

```bash theme={null}
curl --request GET \
  --url 'https://api.kombo.dev/v1/hris/employees?cursor=eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0&page_size=100' \
  --header 'Authorization: Bearer <YOUR_API_KEY>'
```

## Filtering

All models provide the same filters in addition to some model-specific filters.
The following filters apply to all models:

* `updated_after`: Only return objects where the `changed_at` value is after
  the given timestamp. This can be used to fetch data incrementally.
  This filter also includes all expanded relations — so if only they have
  changed (but none of the primary attributes of the object), this will still
  count as the object having changed and it will still be returned.
* `include_deleted`: By default, all values with a `remote_deleted_at` value are
  not returned. If you want to include them, set this to `true`. This is helpful
  if you want to remove them from your database.
* `ids`: List of comma-separated ids. Only return objects with these IDs.
* `remote_ids`: List of comma-separated remote ids. Only return objects with
  these remote IDs.

## Error Codes

When the Kombo API encounters an error, it returns a structured error response with a specific `code` for programmatic handling.
For a complete list of error codes and detailed explanations see the [Error Handling guide](/guides/errors).

```json theme={null}
{
  "status": "error",
  "error": {
    "code": "REMOTE.INPUT_INVALID",
    "title": "The remote system returned validation errors.",
    "message": "Candidate field 'email' must be a valid email address for Greenhouse"
  }
}
```

## Rate limiting

The rate limiter restricts the number of API requests you can send to Kombo. Currently, we permit 300 requests over 60 seconds **per environment** (i.e., PROD or DEV environment). After the time window has passed, the limit is reset. If you need a higher quota, reach out to the Kombo team.

Independent of this cap, [concurrency limiting](../guides/concurrency-limiting) limits how many unified actions can run at the same time per integration.

This information is exposed as headers on the response of every authenticated API request:

| Header              | Sample Value | Description                                           |
| ------------------- | ------------ | ----------------------------------------------------- |
| ratelimit-limit     | 300          | The maximum number of requests permitted              |
| ratelimit-remaining | 298          | The remaining number of requests permitted            |
| ratelimit-reset     | 57           | The remaining seconds until the rate limiter is reset |

When exceeded, you will receive a failed response with the [error `code`](/guides/errors) of `PLATFORM.RATE_LIMIT_EXCEEDED`:

```json theme={null}
{
  "status": "error",
  "error": {
    "code": "PLATFORM.RATE_LIMIT_EXCEEDED",
    "title": "Rate limit exceeded.",
    "message": "Maximum requests are 300 every 60 seconds. Try again in 57 seconds.",
    "log_url": null
  }
}
```

### Concurrency limiting

In addition to rate limiting, Kombo applies [concurrency limiting](../guides/concurrency-limiting) to unified actions. While rate limiting caps total requests over a time window, concurrency limiting caps simultaneous in-flight unified actions per integration to prevent backpressure buildup on downstream tools. Endpoints for reading synced model data are not affected by concurrency limiting.

### Handling 429 responses

Both rate limiting and concurrency limiting return HTTP `429`, but they have different error codes and require different responses:

* **`PLATFORM.RATE_LIMIT_EXCEEDED`** -- You've sent too many requests in the current time window. This applies to all endpoints. Wait for `ratelimit-reset` seconds or retry with exponential backoff.
* **`PLATFORM.CONCURRENCY_LIMIT_EXCEEDED`** -- Too many unified actions are in flight for this integration. The underlying tool can't keep up. Retry the failed request after a short backoff (e.g., 1s, 2s, 4s). You likely still have rate limit quota remaining, so waiting for `ratelimit-reset` is unnecessary. See the [concurrency limiting guide](../guides/concurrency-limiting) for details.


# Remote Data
Source: https://docs.kombo.dev/assessment/getting-started/remote-data

Learn how to use remote data to access any available field.

Remote data is a feature exposing the raw, unchanged data
that we receive from the APIs, allowing you to read data that might
not be available in our unified API model.

It is disabled by default because it has compliance implications
(we need to store all data we receive, not just the data points selected in the
scope configs) and because you will need to write parsing logic for each
integration/tool.

It is mainly used to read data that might not be available in our unified Data Models.
Some customers are for example interested in some specific government-issued
company IDs, which are currently not part of our Data Model, but can be extracted
from these raw responses. An example response might be:

```json theme={null}
{
  "status": "success",
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "first_name": "John",
        "last_name": "Doe",
        ...
        "remote_data": {
          "EmployeeData": {
            "Names": {
              "FirstName": "John",
              "LastName": "Doe"
            },
            "Company": {
              "GovernmentID": "123456789"
            }
          }
        }
      }
    ]
  }
}
```

<Info>
  `remote_data` gives you the raw API response from the connected system. If you
  need **structured** extra fields for reading, see [Custom
  Fields](../features/custom-fields). If you need to **write** additional data
  when creating records, see [Remote
  Fields](/extending-the-model#remote-fields).
</Info>

## When to use remote data

Remote data should be used when our unified Data Model does not offer specific
fields that you are interested in. Note that we do not unify remote data, so the
data structure might differ between tools and might even differ between
individual integrations of the same tool.

## When not to use remote data

Remote data might potentially expose sensitive data, even if your customers
opt out of it. We might, for example, always receive personally identifiable
information (e.g. emails, names and addresses). If your customers opt out of
these data fields, we will discard this data and never store it.
If remote data is active, however, we will expose the raw responses and therefore
information that should optimally not be stored.

We also offer [custom fields](../features/custom-fields), which are a more versatile and compliant variant
of remote data.

## How to use remote data

Remote data can be enabled on a per-model basis in the scope config. To enable
it, please contact us.


# Sandbox Integrations
Source: https://docs.kombo.dev/assessment/getting-started/sandbox-integrations

Learn how to access tools you can connect to Kombo for development purposes.

If you wish to get started as quickly as possible, use our built-in **Sandbox Integration (HRIS/ATS/LMS)**.
You can find it in the **"Integrations"** section in the Kombo dashboard. The sandbox integration
is only available in your [development environment](../guides/environments#development).

<Card title="Sandbox Integration" icon="flask" href="../connectors/sandbox">
  Connect the built-in sandbox to start exploring the API right away — no
  credentials required.
</Card>

### What the sandbox covers

The sandbox requires **no credentials** and can be set up in minutes. It
provides a representative dataset that covers common edge cases you'll encounter
in production — including active, terminated, and pending employees, multiple
currencies, and various bank account formats.

**Read data** — the sandbox includes data for all major models:

* **HRIS**: Employees, employments, groups, locations, legal entities, absences,
  absence types, time-off balances, timesheets, performance reviews, skills,
  and employee skill proficiency ratings
* **ATS**: Candidates, applications, jobs, job posts, stages, offers,
  interviews, rejection reasons, users
* **LMS**: Users, courses, skills, providers, progress records

**Write actions** — all major write operations work against the sandbox:

* **HRIS**: Create employees, create/delete absences, upsert employee skill
  proficiency ratings
* **ATS**: Create candidates (with applications), move applications to stages,
  add attachments, add/remove tags, add notes
* **LMS**: Enroll users, mark completions, create and manage courses

The sandbox dataset is **deterministic** — syncs always return the same base
data, making it well-suited for automated testing with stable assertions.
Records created through write actions persist in Kombo's database and appear in
subsequent API calls, but don't modify the base dataset.

### Third-party sandboxes

Some tools also offer free demo accounts that you can use to test out Kombo.

We recommend the following tools, as they provide great coverage and are broadly used:

* When testing HRIS integrations, we recommend using [Personio](https://www.personio.com/free-trial/).
* When testing ATS integrations, we recommend using [Recruitee](https://auth.recruitee.com/sign-up). If you want to gain access to a sandbox instead of using the free trial, please fill out [this form](https://www.tellent.com/technology-partner-application). In the section “Please describe the use case for this integration on a high-level”, mention “Referred by Kombo”.

Additionally, here are some more tools that offer free trials or test accounts: [BambooHR (HRIS)](https://www.bamboohr.com/signup/), [Sage HR (HRIS/ATS)](https://sage.hr/register), [Deel (HRIS)](https://app.deel.com/signup), [CharlieHR (HRIS)](https://www.charliehr.com/join), [Planday (HRIS)](https://www.planday.com/signup/), [Factorial (HRIS)](https://factorialhr.com/get-started), [Humaans (HRIS)](https://app.humaans.io/signup), [BreezyHR (ATS)](https://breezy.hr/signup), [Jazzhr (ATS)](https://info.jazzhr.com/free-trial.html), [Join (ATS)](https://join.com/auth/signup/recruiter), [Teamtailor (ATS)](https://tt.teamtailor.com/users/new?locale=en), [Workable (ATS)](https://www.workable.com/free-trial)

### Enterprise tools

Enterprise tools like Workday, SAP SuccessFactors, or SmartRecruiters usually
don't offer free sandbox access. However, for customers on the enterprise plan,
we offer joint testing sessions with these enterprise tools.


# Concurrency Limiting
Source: https://docs.kombo.dev/assessment/guides/concurrency-limiting

Concurrency limiting caps simultaneous in-flight unified actions per integration, giving you fast feedback instead of slow timeouts.

## What is concurrency limiting?

When you invoke unified actions in Kombo (e.g., creating a candidate, moving
an application, reading attachments), each call is forwarded to the underlying HR or ATS tool.
These tools have their own rate limits, which are often significantly lower than
what Kombo allows.

If many unified actions run in parallel, they all compete for limited
downstream throughput. Completion times grow, your HTTP clients may hit
timeouts while work is still in flight, and retries can overlap with operations
that are still running.

Concurrency limiting solves this by capping how many unified actions
can be processed simultaneously per integration. When the cap is
reached, additional requests are immediately rejected with a `429` status code.
This gives you a fast, clear signal to retry with backoff instead of stacking
unbounded in-flight work that might eventually time out on your side.

<Note>
  Concurrency limiting only applies to unified actions (calls that run work
  against the underlying tool). Model endpoints for reading synced data are not
  affected.
</Note>

<Frame>
  <img alt="Two-panel diagram comparing overload (client timeout before completion, ambiguous retries) with concurrency limiting (429 and controlled in-flight work)." />
</Frame>

## How it differs from rate limiting

For Kombo-wide request volume over time, see [Rate limiting](../getting-started/querying-api#rate-limiting).

|                    | Rate Limiting                  | Concurrency Limiting                  |
| ------------------ | ------------------------------ | ------------------------------------- |
| **What it caps**   | Total requests per time window | Simultaneous in-flight requests       |
| **Scope**          | All API requests               | Unified actions only                  |
| **When it resets** | After the time window elapses  | As in-flight requests complete        |
| **Error code**     | `PLATFORM.RATE_LIMIT_EXCEEDED` | `PLATFORM.CONCURRENCY_LIMIT_EXCEEDED` |

Both return HTTP `429`, but with different error codes and headers.

## Response headers

When concurrency limiting is active, every unified action response includes two headers:

| Header                  | Example | Description                                                                             |
| ----------------------- | ------- | --------------------------------------------------------------------------------------- |
| `Concurrency-Limit`     | `30`    | The maximum number of concurrent in-flight unified actions allowed for this integration |
| `Concurrency-Remaining` | `12`    | How many additional concurrent unified actions can be accepted right now                |

The limit may vary per integration. Sensitive integrations (e.g.,
reverse-engineered APIs) may have significantly lower limits. Use the response
headers to discover the actual limit rather than assuming a specific number. The
default limit is 30.

These headers appear on both successful responses and `429` rejections, so you can monitor utilization proactively.

## Handling concurrency limit errors

When you exceed the concurrency limit, you receive a `429` response with the error code `PLATFORM.CONCURRENCY_LIMIT_EXCEEDED`. The response includes both concurrency and rate limit headers:

```
HTTP/1.1 429
concurrency-limit: 30
concurrency-remaining: 0
ratelimit-limit: 1000
ratelimit-remaining: 834
ratelimit-reset: 44
```

```json theme={null}
{
  "status": "error",
  "error": {
    "code": "PLATFORM.CONCURRENCY_LIMIT_EXCEEDED",
    "title": "Concurrency limit exceeded.",
    "message": "Maximum concurrent action requests per integration is 30. Currently 30 in flight."
  }
}
```

Notice how the rate limit headers show remaining quota (`ratelimit-remaining: 834`) while the concurrency headers show no remaining slots (`concurrency-remaining: 0`). This tells you:

* The underlying tool is at capacity for this integration, not Kombo itself.
* You still have rate limit quota, so waiting for `ratelimit-reset` is unnecessary.
* Slots free up quickly as in-flight requests complete, so a short retry is effective.

### How to retry

For `PLATFORM.CONCURRENCY_LIMIT_EXCEEDED`, retrying the same request is
expected and does not run the unified action twice. Kombo rejects the call
before the unified action runs (no concurrency slot was acquired). That differs
from failures where the outcome is unclear, e.g., a timeout after a write may
still have succeeded, so retries need extra care.

1. Retry the failed request with exponential backoff: start with a short delay (e.g., 1s) and increase on repeated `429`s (2s, 4s, 8s, ...).
2. Optionally, throttle proactively: check `Concurrency-Remaining` on successful responses to slow down before hitting the limit.

## What this means for your integration

Concurrency limiting does not cap steady-state throughput below what the
downstream tool can sustain. The integrated system still bounds how fast work
completes. The limit turns that constraint into immediate `429` responses
instead of long waits and unbounded in-flight unified actions.


# Embedded flow
Source: https://docs.kombo.dev/assessment/guides/connect/embedded-flow

Embed Kombo Connect into your app for the most seamless experience.

If you've gone through the general [Kombo Connect](./introduction) documentation,
you'll know there are
[different ways of using the flow](./introduction#getting-started). Our embedded flow
provides the most seamless experience to your customers but also involves some
engineering on your side. In this guide, we'll go over what that means exactly.

## Implementing the flow

The embedded flow requires you to:

* Add an **endpoint** to your back-end for initiating the flow
* Add a **button** to your frontend to show the flow to your user using the SDK
* React to a flow being completed through the "activation token" returned by the SDK or by listening to a webhook

Let's go over each of these steps in detail.

### Adding the endpoints

Both endpoints are mostly just wrappers around endpoints of the Kombo API and
mainly exist for security reasons (so that malicious actors can't set up
arbitrary integrations in your Kombo environment).

#### Initiating the flow

The first one initializes the flow by calling the Kombo API and returns a link
that we then use in the frontend:

```js Node.js (Express + Axios) theme={null}
app.post('/integrations/kombo/init', async (req, res) => {
  // TODO: Get user details from your database
  const user = await getUser()

  const response = await axios.post(
    'https://api.kombo.dev/v1/connect/create-link',
    {
      end_user_email: user.email,
      end_user_organization_name: user.company.name,
      end_user_origin_id: user.company.id,

      integration_category: 'HRIS',
    },
    {
      headers: {
        authorization: `Bearer ${KOMBO_API_KEY}`,
      },
    },
  )

  res.send({ link: response.data.data.link })
})
```

The `end_user_*` fields identify which of your customers an integration belongs to:

* **`end_user_email`** (required): Contact email for this end user. Used as a label in the dashboard and included in webhooks.
* **`end_user_organization_name`** (required): Company name. Used as a label in the dashboard and included in webhooks.
* **`end_user_origin_id`** (optional): Your internal ID for this customer. Echoed back in webhooks and API responses so you can map integrations to your own records.

These fields are metadata — they do not affect integration identity. Changing the email or organization name in a subsequent `create-link` call with the same `end_user_origin_id` does **not** update an existing integration; it creates a new flow link.

<Warning>
  Kombo does **not** deduplicate integrations based on these fields. Each
  completed flow creates a new integration. You are responsible for preventing
  customers from connecting the same tool twice. Use the [reconnection
  link](../../v1/post-integrations-integration-id-relink) if a customer needs to
  update their credentials for an existing integration.
</Warning>

#### Reacting to the flow being completed

After your user completes the flow, you can retrieve the integration details and store them in your database for future use. There are two ways to achieve this:

1. By using the ["Get integration by token" endpoint](../../v1/get-connect-integration-by-token-token)
2. By listening to the `integration-created` webhook

**Option 1: Using the endpoint**

The activation token is returned from the frontend after the user completes the integration flow. You can use this token to retrieve the integration details via the ["Get integration by token" endpoint](../../v1/get-connect-integration-by-token-token) and store them in your database.

Here's how you might implement the activation endpoint:

```js Node.js (Express + Axios) theme={null}
app.post('/integrations/kombo/activate', async (req, res) => {
  const response = await axios.get(
    `https://api.kombo.dev/v1/connect/integration-by-token/${req.body.token}`,
    {
      headers: {
        authorization: `Bearer ${KOMBO_API_KEY}`,
      },
    },
  )

  const integrationId = response.data.data.id

  // TODO: Store the integration ID in your database

  res.sendStatus(200)
})
```

**Option 2: Listening to the `integration-created` Webhook**

Alternatively, you can set up a webhook endpoint on your backend to listen for the `integration-created` event that Kombo sends when a new integration is created. This webhook contains the integration ID and other relevant details, allowing you to associate the integration with your user in your database.

Here's how you might set up the webhook endpoint:

```js Node.js (Express) theme={null}
app.post('/webhooks/kombo/integration-created', async (req, res) => {
  const integration = req.body.data

  // TODO: Verify the webhook signature for security purposes

  // TODO: Store the integration ID in your database

  res.sendStatus(200)
})
```

* Make sure to [verify the webhook signature](../../guides/webhooks#validate-the-data) to ensure that the request comes from Kombo.
* Make sure to set up the webhook in the [dashboard](https://app.kombo.dev/configuration/webhooks).

### Adding the button

For now, we're all set on the back-end side, so let's switch to the front-end:

Here we'll have to add a button that lets your users start the flow. Most of our
customers already have an "Integrations" page within their product's settings.
If you do, too, then that's the perfect place to add the button.

How exactly you're going to do this will depend on your tech stack, but it's
probably going to look something like this:

<CodeGroup>
  ```jsx React theme={null}
  <button onClick={() => connectHris()}>Connect HRIS</button>
  ```

  ```jsx Vue.js theme={null}
  <button @click="connectHris()">
    Connect HRIS
  </button>
  ```

  ```html HTML theme={null}
  <button onclick="connectHris()">Connect HRIS</button>
  ```
</CodeGroup>

<br />

<Note>
  Right now, we require you to specify the integration category when
  initializing the flow, so you'll likely want to label your button accordingly
  (e.g., "Connect HRIS" or "Connect ATS").
</Note>

When a user clicks on the button, two things need to happen:

* An integration link has to be retrieved through your endpoint
* The embedded flow has to be started

#### Getting a link

Here's what the first part might look like:

```js JavaScript theme={null}
async function getKomboConnectLink() {
  // Note: The URL below points to *your* API and could be different
  const response = await fetch('/integrations/kombo/init')
  const data = await response.json()

  return data.link
}
```

#### Opening the flow

Now it's time to actually show the flow to the user. This can be through
[the @kombo-api/connect JavaScript library](https://www.npmjs.com/package/@kombo-api/connect).
It's tiny (about 50 lines of JavaScript as of now) and basically just
initializes an `<iframe>` to display the flow.

<Note>
  **Important:** Since the Kombo Connect flow is displayed in an iframe, you'll need to ensure your Content-Security-Policy allows it. Add `frame-src https://connect.kombo.dev` to your CSP header:

  ```
  Content-Security-Policy: frame-src https://connect.kombo.dev;
  ```
</Note>

Let's, first of all, add it as a dependency to our front-end:

<CodeGroup>
  ```bash npm theme={null}
  npm install @kombo-api/connect
  ```

  ```bash yarn theme={null}
  yarn add @kombo-api/connect
  ```

  ```bash pnpm theme={null}
  pnpm add @kombo-api/connect
  ```
</CodeGroup>

Then, import it like so:

```js JavaScript theme={null}
import { showKomboConnect } from '@kombo-api/connect'
```

##### Can't use npm packages or imports?

You can also load the library from the unpkg CDN:

```html HTML theme={null}
<script src="https://unpkg.com/@kombo-api/connect@1/dist/index.js"></script>
```

This makes the library available globally as `KomboConnect`.

#### Reacting to the flow being completed

After the user completes the flow, you'll receive an activation token. This token can be used to retrieve the integration details from Kombo. Depending on the method you choose (activation endpoint or webhook), you'll handle this token differently.

If you're using the activation endpoint, send the token to your backend:

```js JavaScript theme={null}
async function activateKomboIntegration(token) {
  // Note: The URL below points to *your* API and could be different
  const response = await fetch('/integrations/kombo/activate', {
    method: 'POST',
    body: JSON.stringify({ token }),
  })
}
```

If you're using the webhook method, you don't need to handle the activation token on the frontend. Instead, the webhook will notify your backend when a new integration is created.

### Putting all together

Now it's time to put it all together:

```js JavaScript theme={null}
// You can call this whatever you want (just attach this to your button)
async function connectHris() {
  // We wrote this function earlier (make sure to import/include it)
  const link = await getKomboConnectLink()

  const activationToken = await showKomboConnect(link)

  // Not necessary if you're reacting to the `integration-created` webhook
  await activateKomboIntegration(activationToken)
}
```

<Info>
  **What if the user doesn't finish?** No integration is created until the user
  completes the entire flow. Abandoned or closed flows leave no orphan records
  in Kombo. You can safely generate a new link via `POST /connect/create-link`
  for the user to retry. To avoid duplicate integrations for users who *do*
  complete the flow, track completed `integration_id`s on your side, ideally via
  webhook.
</Info>

And that's it! You've successfully embedded Kombo Connect!


# Introduction
Source: https://docs.kombo.dev/assessment/guides/connect/introduction

Our interactive embeddable connection flow.

<img alt="1376" />

We know that the experience of setting up new integrations is just as core to
your application as the integrations themselves, so we've put special care into
making this as easy and user-friendly as possible for your customers.

*The best part:* **Kombo Connect** — that's what we call our interactive
connection flow — can be
[fully embedded within your own application](./embedded-flow).

## How it works

To get a better idea of how Kombo Connect fits into your application, let's take
a look at the typical flow a customer will go through:

1. They **initiate the flow** within your app (e.g., through a "Connect HRIS"
   button)
2. They are **presented with the Kombo Connect UI** where they can:
   * Select the tool they want to connect (e.g., Factorial)
   * Get an overview of the requested data points (see [Scopes](../../features/scopes))
   * Grant access to the requested data points
   * See which credentials are required to set up the tool and how to get them
   * Enter the necessary credentials (e.g., an API key)
3. They **return to your app**, and their integration has been set up

## Getting started

The flow described above applies to the situation where you've
[*embedded* the Kombo Connect flow](./embedded-flow) into your own app. This
provides the most seamless experience but isn't the quickest way to get started.

If you just want to try out Kombo quickly and **onboard selected customers**,
consider these other options that **don't require any changes to your app**:

<CardGroup>
  <Card title="Manual setup" icon="wrench" href="./manual-setup">
    Perfect when you *already have* the relevant credentials from your customer
    and just want to add the integration to Kombo
  </Card>

  <Card title="Magic links" icon="wand-magic-sparkles" href="./magic-links">
    Similar in that they also don't require any code, but they still allow your
    customers to go through the flow and enter the credentials themselves.
  </Card>
</CardGroup>


# Magic links
Source: https://docs.kombo.dev/assessment/guides/connect/magic-links

Let your customers set up integrations without changing your app.

When you're just getting started with Kombo, you might not want to invest in the
time into building a proper integration with [Kombo Connect](./introduction) yet.
Because of that, we allow you to send what we call "Magic links" to your
customers that allow them to go through the connection flow without you having
to change anything about your application.

## Setting up an integration

To get started, open up [the dashboard](https://app.kombo.dev) and click on "New
integration":

<Frame>
  <img alt="1448" />
</Frame>

Then, select "Let your customer create the integration":

<Frame>
  <img alt="764" />
</Frame>

In the next step, select the integration category (e.g., HRIS) and which
customer it's for:

<Frame>
  <img alt="1762" />
</Frame>

After clicking "Continue," you'll get a link that you can share with your
customer:

<Frame>
  <img alt="786" />
</Frame>

Clicking on this link will take your customer to a special version of the Kombo
Connect flow hosted by us:

<Frame>
  <img alt="1376" />
</Frame>

After they've gone through the flow, the integration will be set up and we will
send you a [webhook](../webhooks). You can then start using our unified API. To
learn more about that, check out
[our general Getting Started guide](../../getting-started).


# Manual setup
Source: https://docs.kombo.dev/assessment/guides/connect/manual-setup

Manually set up integrations on behalf of your customers.

When you're just getting started with Kombo, you might not want to invest the
time into building a proper integration with [Kombo Connect](./introduction) yet.
Because of that, we allow you to *manually* set up integrations through the
Kombo Dashboard.

## Setting up an integration

To get started, open up [the dashboard](https://app.kombo.dev) and click on "New
integration":

<Frame>
  <img alt="1448" />
</Frame>

Then, select "Create the integration yourself":

<Frame>
  <img alt="758" />
</Frame>

In the next step, select the integration category (e.g., HRIS) and which
customer it's for:

<Frame>
  <img alt="1762" />
</Frame>

After clicking "Continue," you'll then be presented with the regular
[Kombo Connect](./introduction) flow, except that in this case, it's *you* going
through it and not your customer:

<Frame>
  <img alt="1376" />
</Frame>

After going through the flow, the integration will be set up, and you can start
using our unified API. To learn more about that, check out
[our general Getting Started guide](../../getting-started).


# Reconnecting an integration
Source: https://docs.kombo.dev/assessment/guides/connect/reconnection

This document explains why and how to reconnect an integration.

## When to reconnect an integration

### Authentication issues

Sometimes customers change integration authentication details, API keys expire,
or other integration setup details are changed and Kombo can no longer
authenticate with an integration that was previously connected.

After three consecutive days of failing authentication (which we check before every
sync), Kombo will pause scheduling syncs and will prompt you to reconnect the
integration.

#### How to Identify Authentication Issues

Authentication issues can be identified in two ways: programmatically (recommended) or operationally via the Kombo dashboard.

1. **Programmatically:**
   Use the [Integration State Changed webhook](../../guides/webhooks#integration-state-changed). This webhook allows you to monitor changes in the `state` value, helping you quickly detect authentication-related issues.

2. **Operationally:**
   Open the [integrations list](https://app.kombo.dev/integrations). An [issue](../../features/issues) appears on the integration as soon as authentication starts failing, and the integration state updates as well.

By leveraging these approaches, you can promptly diagnose and address authentication challenges.

### Changes in data scope

If you want to update which data you're interacting with in your customer's HR
systems, you will likely need to update your [Kombo scope config](../../features/scopes).
Updating your scope config in Kombo will usually go hand in hand with your
customer having to update their API credentials. Therefore, expanding your scope
config will likely end up with syncs showing warnings that not all permissions
are granted to the API credentials.

Syncs failing due to scope-mismatches can be avoided by using reconnection
links, as described [below](#a-note-on-updating-the-scope-config).

## Methods of reconnecting

### Use the dashboard to create an update link

In the [Kombo dashboard](https://app.kombo.dev), navigate to any integration
that you want to reconnect. Scroll down to the **Relink integration** section to
create an update link.

You can send this link to your customer to update the credentials of the
integration. Once they have reconnected successfully, syncs will run using the
newly entered credentials.

<Frame>
  <img alt="image" />
</Frame>

### Use the API to create a reconnection link

You can also create a reconnection link using the [create reconnection link endpoint](../../v1/post-integrations-integration-id-relink).
Specify the `link_type` for it to be used either in the [embedded flow](../connect/embedded-flow),
or sent out as a [magic link](../connect/magic-links).

## A note on updating the scope config

You are able to define the scope config of a reconnection link both in the UI
and using the API.

<Frame>
  <img alt="image" />
</Frame>

Setting a different scope config than the current integration's scope config
results in the following:

* Your customer will see the updated scope config in the connection flow (i.e.,
  they will have to create credentials with the newly desired permissions)
* On connection flow completion, the scope config of the integration will
  automatically be updated to reflect the new scope config

Use this functionality to smoothly migrate your customers to a new scope config,
without running into any sync issues. While the reconnection link has not been
completed, syncs will continue successfully working using the old scope config;
the new scope config will only be used once the reconnection link has been
completed.


# Troubleshoot connection flow problems
Source: https://docs.kombo.dev/assessment/guides/debugging/debug-connection-flow

Investigate and resolve issues that prevent your customers from connecting.

<Frame>
  <img alt="Pending connection detail view" />
</Frame>

When a customer cannot finish the connection flow, work through the steps below to isolate whether the problem originates from the customer’s configuration, Kombo, or the remote tool.

## 1. Identify the failing connection

* Open the [Pending Connections page](https://app.kombo.dev/pending-connections) in the dashboard.
* Locate the affected connection and open its detail view. This page aggregates the context you need, including flow status and quick links.
* If you can't find the connection, you can also try to locate it from the [Logs page](../../features/logs).

## 2. Inspect event and request logs

* Use the **Event Log** tab to understand exactly which step failed and what the customer saw in the UI. These entries often include an error message or hints the customer might have missed.
* Switch to the **Logs** tab to inspect the HTTP calls Kombo made:
  * Review failing requests. HTTP `401`/`403` responses typically mean a missing permission on the customer’s side.
  * `500`-level responses usually indicate a temporary issue in the remote tool—confirm their status page or retry later.
  * Other status codes (e.g. validation errors) can surface configuration issues on Kombo’s side.
  * Also inspect the response bodies, they might contain more information on whats failing.

<Frame>
  <img alt="Event log vs. request log tabs" />
</Frame>

For a deeper dive into logs, see [Logs](../../features/logs) and [Komboman](../../features/komboman) for reproducing calls manually.

## 3. Validate setup with connection guides

* Share the [connection guide](https://help.kombo.dev/hc/en-us/sections/14349683218961-Connection-Guides) for the tool with your customer. The guide lists mandatory permissions, API scopes, and any tool-specific prerequisites.
* Confirm that the customer followed the guide
* If the guide highlights optional scopes your product relies on, ensure the customer understands why they must be enabled.


# Diagnosing missing or incorrect data
Source: https://docs.kombo.dev/assessment/guides/debugging/debug-data-issues

A step-by-step guide to troubleshooting data discrepancies between Kombo and the remote tool.

When customers report missing, outdated, or incorrect data, the goal is to determine whether the discrepancy exists inside Kombo or originates from the remote tool.

This guide provides a structured workflow to pinpoint the issue and resolve it.

## 1. Verify the data in Kombo

First, check if the data is actually missing or incorrect in Kombo's own database.

### Check Data Quality View

Use the Data Quality View to see how many data points are synced for each model and field. This helps you to get an overview whether the data is complete.

<img alt="Data Quality View" />

### Check Data Explorer

Use the [Data Explorer](../../features/data-explorer) to inspect specific records. The data explorer shows the ground truth inside of Kombo. You can find all records and their fields values inside of the data explorer.

<img alt="Data Explorer" />

### Validate with Komboman

Use [Komboman](../../features/komboman) to make requests to the Kombo API (e.g., `GET /hris/employees` or `GET /ats/applications`) and check the JSON response directly.

<img alt="Komboman" />

<Note>
  If the data is correct and up-to-date in Kombo but missing or incorrect in
  your system, the issue is likely with how you fetch data from Kombo. Ensure
  you are [syncing data correctly](../../getting-started/fetching-data).
</Note>

## 2. Check the data in the remote tool

If the data is missing or wrong inside the Kombo app, we need to verify what Kombo is receiving from the remote tool.

### Use the Custom Field Explorer

The [Custom Field Explorer](../../features/custom-fields#map-fields-based-on-live-data) shows you all the raw fields Kombo has discovered from the remote tool, including those that aren't mapped to Kombo's unified model.

* If you see the field here, Kombo has access to the data, but it just isn't mapped to a standard field. You can use remappings to update the mapping of the field that is wrong.
* This at times might not show all the fields.

<img alt="Custom Field Explorer" />

### Inspect Request Logs

Go to the [Logs page](../../features/logs) to find the actual HTTP requests Kombo performed during the sync.

* Look for the relevant endpoint (e.g., `/GET employees`).
* Inspect the **Response Body** to see the raw data Kombo received.
* You can even replay the request in [Komboman](../../features/komboman) to see the live response.

<img alt="Request Logs" />

### Use Komboman (Passthrough)

If you can't find the request in the logs, use [Komboman](../../features/komboman) to manually send a request to the remote tool's API (using the "Passthrough" mode).

* This uses the customer's actual credentials, so it shows you exactly what the API returns.
* Compare this raw JSON with what you expected to see.

## 3. Resolutions

Once you've identified where the data is missing, use these steps to resolve the issue.

### Data is not available or incorrect in the remote tool

If you cannot find the correct data in the remote tool's API response (via Komboman or Logs), Kombo cannot sync it.

* **Permission Issue**: The most common cause is that the API user/token connected to Kombo does not have permission to view these fields. Ask the customer to check their permissions and scope settings in the remote tool.
* **Setup Issue**: The specific field wasn't exposed. Read the [connection guide](https://help.kombo.dev/hc/en-us/sections/14349683218961-Connection-Guides) for the tool. Some tools require additional setup, for example, to read custom fields.
* **Wrong Endpoint**: Some tools return data only on specific endpoints. Verify in the tool's documentation if the data is expected to be returned by the endpoint Kombo is calling (which you found in the logs).

### Data is correct in the remote tool, but not in Kombo

If you see the correct data in the raw API response but it doesn't appear (or appears incorrectly) in Kombo's unified API:

* **Check Scope Configuration**: Ensure the model or field is enabled in the integration's scope configuration. If a scope is disabled, Kombo will drop that data.
* **Check Filtering**: Verify if the record is being excluded by [filtering](/hris/features/filtering/introduction) configuration. For example, employees might be filtered out based on their employment status or location (HRIS), or applications might be skipped due to [upstream filtering](/ats/features/upstream-filtering) (ATS).
* **Remap the Data**: If the data is present but not in the field you expect (or is a custom field), you can map it manually:
  * Use [Custom Fields](../../features/custom-fields) to map the raw field to a new property in Kombo.
  * Use [Remapping](../../features/remapping/introduction) to override where a standard field gets its value from.


# How to troubleshoot issues with Kombo
Source: https://docs.kombo.dev/assessment/guides/debugging/introduction

Identify and resolve issues across connections, data, and actions using Kombo’s troubleshooting tools.

This guide helps you understand how to **troubleshoot and resolve issues in Kombo**—whether that’s missing data, connection problems, or failing actions.

Kombo provides built-in tooling like [Issues](../../features/issues), [Komboman](../../features/komboman), [Logs](../../features/logs), or the [Data Explorer](../../features/data-explorer) so you can investigate what’s happening behind the scenes and often fix problems yourself.

By the end of this guide you will be able to:

* verify whether an issue lies within Kombo or the connected tool
* choose the right troubleshooting tool for each situation
* collect the right evidence before reaching out to Kombo support

## Kombo support

Our support team is always here to help—but in many cases you can diagnose and even resolve issues yourself using the tools described below. When contacting support, include:

* a short description of what’s wrong
* the affected integration(s) or customers
* any screenshots, logs, or links from your troubleshooting steps

The more detail you share, the quicker we can get you back up and running.

## Common issues

<CardGroup>
  <Card title="Connection issues" icon="link-slash" href="./debug-connection-flow">
    Pending connection fails, customers get stuck in the flow, or you need to
    force a connection.
  </Card>

  <Card title="Data quality issues" icon="magnifying-glass" href="./debug-data-issues">
    Records look missing, outdated, or mapped incorrectly inside Kombo or your
    product.
  </Card>

  <Card title="Action issues" icon="bolt" href="./investigate-failing-actions">
    A write, passthrough, or dashboard-triggered action fails and you need to
    see why.
  </Card>
</CardGroup>

## Key tools for troubleshooting

<CardGroup>
  <Card title="Issues" icon="triangle-exclamation" href="../../features/issues">
    See which integrations currently need attention, and how long the problem
    has been observed.
  </Card>

  <Card title="Komboman" icon="terminal" href="../../features/komboman">
    Send manual Kombo or passthrough API requests to validate data or retry
    failing operations.
  </Card>

  <Card title="Logs" icon="scroll" href="../../features/logs">
    Inspect sync, action, and connection flow logs including detailed
    request/response payloads.
  </Card>

  <Card title="Data Explorer" icon="table" href="../../features/data-explorer">
    Inspect specific records and their field values to see the ground truth
    inside of Kombo.
  </Card>

  <Card title="Custom field explorer" icon="list" href="../../features/custom-fields#map-fields-based-on-live-data">
    Discover available custom fields in the remote tool and map them into Kombo.
  </Card>

  <Card title="Remapping" icon="sliders" href="../../features/remapping/introduction">
    Adjust how Kombo maps data into your models when the default setup is not
    the right fit.
  </Card>

  <Card title="Custom & remote fields" icon="grid" href="../../features/custom-fields">
    Learn how to work with Kombo’s field model, including automatic mapping
    rules and remote references.
  </Card>
</CardGroup>


# Investigate failing actions
Source: https://docs.kombo.dev/assessment/guides/debugging/investigate-failing-actions

Diagnose failed write actions using Logs and Komboman.

While most actions succeed automatically, occasional failures are inevitable when syncing data with external systems. Strict validation rules, changing permissions, or complex data dependencies can sometimes cause requests to be rejected.

This guide introduces tools like [Logs](../../features/logs) and [Komboman](../../features/komboman) to help you isolate and understand the error.

## 1. Find the action in the logs

<Frame>
  <video />
</Frame>

To find the relevant log entry, head to the [Logs page](../../features/logs) and use the filters on the top:

* **Type**: Select **Action** to see only write operations (excluding syncs and webhooks).
* **Status**: Select **Failed** to focus on the errors.
* **Integration**: Narrow down results to a specific customer connection.
* **Date**: If you know when the error happened, setting a time range helps filter out noise.

Once you've filtered the list, you should see the failed action.

## 2. Inspect the logs

Click on the log entry to open the detail view. This is your view for understanding what happened.

* **Review the input**: Check the `Incoming Request` tab to see exactly what data you sent to Kombo.
* **Inspect the requests**: An action often involves multiple HTTP calls to the remote tool. Check the timeline for any failed requests.
* **Dig deeper**: Click on a specific request in the timeline to see the raw payload Kombo sent and the error response from the remote system. These often contain more specific details than the top-level error message.

<Frame>
  <img alt="Request log details" />
</Frame>

## 3. Common issues

We have a dedicated [Error Handling guide](/guides/errors) that covers how to handle common API errors programmatically. Below, you'll find visual examples of the most common issues specific to actions:

### Missing permissions or Invalid authentication

If you receive a `403 Forbidden` or `401 Unauthorized` error, the integration
likely lacks the necessary permissions or it's authentication is invalid. Below
are some examples of how these errors might look in the logs:

<AccordionGroup>
  <Accordion title="Missing Permissions Example">
    <Frame>
      <img alt="Missing permissions error" />
    </Frame>
  </Accordion>

  <Accordion title="Invalid Authentication Example">
    <Frame>
      <img alt="Invalid authentication error" />
    </Frame>
  </Accordion>
</AccordionGroup>

**Solution**: Identify the missing permission from the error message. Ask your
customer to check their settings or API key, as they might have revoked access
or changed their role. In some cases, they will need to [reconnect the
integration](../connect/reconnection) to grant the missing scopes.

### Invalid input

If the error is a `400 Bad Request`, `422 Unprocessable Entity`, or a validation
error, the remote tool rejected the data you sent. Below are some examples of
how these errors might look in the logs:

<AccordionGroup>
  <Accordion title="Invalid Input Example 1">
    <Frame>
      <img alt="Invalid input error 1" />
    </Frame>
  </Accordion>

  <Accordion title="Invalid Input Example 2">
    <Frame>
      <img alt="Invalid input error 2" />
    </Frame>
  </Accordion>
</AccordionGroup>

**Solution**:

1. Identify the incorrect or missing data in the `Incoming Request` tab.
2. Use [Komboman](../../features/komboman) to replay the action with adjusted inputs and verify the fix.
3. Check the integration's **Field Report** (in the dashboard) to see which fields are required by the remote tool.
4. If a connection always requires specific static inputs, you can set up Remote field overrides.

### Logical errors (e.g., Job closed)

Sometimes the request is valid, but the operation cannot be performed due to the state of the remote system (e.g., applying to a closed job or creating a duplicate candidate). Below are some examples of how these errors might look in the logs:

<AccordionGroup>
  <Accordion title="Logical Error Example 1">
    <Frame>
      <img alt="Logical error 1" />
    </Frame>
  </Accordion>

  <Accordion title="Logical Error Example 2">
    <Frame>
      <img alt="Logical error 2" />
    </Frame>
  </Accordion>

  <Accordion title="Logical Error Example 3">
    <Frame>
      <img alt="Logical error 3" />
    </Frame>
  </Accordion>
</AccordionGroup>

**Solution**: Check the state of the referenced records (e.g., is the `job_id` open?) before sending the action, or handle these specific error codes gracefully in your application.

### Temporary issues

If you see a `500` error or a timeout from the remote tool, it might be a temporary issue. Below is an example of how this error might look in the logs:

<AccordionGroup>
  <Accordion title="Temporary Issue Example">
    <Frame>
      <img alt="Temporary remote tool error" />
    </Frame>
  </Accordion>
</AccordionGroup>

**Solution**: Try resending the action directly from the log details view.

## 4. Still not sure?

If the error is unclear or you suspect a bug in Kombo:

1. Copy the URL of the failing log entry.
2. Reach out to [Kombo support](/support).
3. Paste the link so we can look at the exact same trace you are seeing.


# Environments
Source: https://docs.kombo.dev/assessment/guides/environments



In Kombo, you will have access to two environments; a **production** environment (prod) and a **development** environment (dev). You can switch between these in the sidebar:

<Frame>
  <img />
</Frame>

## What differs per environment?

Only your tenant name ("Acme" in the case of the screenshot above) is shared
across environments. That means that all your other configurations, including
scopes, enabled tools, webhooks, custom fields, and secrets,
will be different per environment.

## Production

This is where you should create integrations with your customers. We are stricter
in this environment about default privacy settings and data retention.

### Saving the connection flow input in production

When connecting customers via your production environment, their connection flow
input is saved in [session storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage).
This is done so that while the same tab/window is open, your customer will not
have to enter the same data for the same input if they move back and forth
through the connection flow. When the tab/window is closed, the credentials
are forgotten. This differs from the development credential storage,
as described below.

## Development

The development environment is meant to be used with
your [sandbox environments](../getting-started/sandbox-integrations) during
development and testing. This environment is less strict about privacy settings
and data retention.

### Saving the connection flow input in development

In the development environment, the connection flow input is saved
in [local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage).
This is a quality-of-life feature meant for developers to prevent having
to enter the same inputs when creating multiple connections to the same
sandbox. Local storage will persist between browser sessions until it
is manually cleared.

### Kombo sandbox

You have access to our built-in **Kombo Sandbox** tool in the development
environment. You can create a new integration with this sandbox as you would
with any other integration, and instantly start reading data without having
to connect a HR system.

### Stale integrations

**In the development environment only**, integrations that did not receive an
API requests in the past two weeks will automatically
become [inactive](./integration-states#inactive). If you want to continue
using the integration, you can activate it again.

## Roles and Access Control

Kombo uses role-based access control so you can grant team members the right level of access. Roles are assigned per user in the dashboard.

| Role          | Environments             | Configuration          | API Keys               | User Management             |
| ------------- | ------------------------ | ---------------------- | ---------------------- | --------------------------- |
| **Admin**     | Production + Development | Full access            | Full access            | Can invite and manage users |
| **Developer** | Development only         | Full access (dev only) | Full access (dev only) | No access                   |
| **Operator**  | Production only          | Read + limited writes  | No access              | No access                   |

### Admin

Full access across both environments, including all configuration (scopes, webhooks, custom fields), API key management, and user administration.

### Developer

Full access to the Development environment only, including API keys and all configuration within that environment. Cannot access Production or manage users.

### Operator

Read access to the Production environment plus the ability to create integrations, reconnections, and provisioning links, edit integration settings, and map custom fields. Cannot manage API keys, scopes, audit logs, or users.

### SSO and MFA

Kombo's dashboard authentication supports **SSO** (SAML and OIDC) and **MFA** for users who want additional security. These are not available on all plans — contact the Kombo team to check availability and configure them for your tenant.


# Implementing New Tools
Source: https://docs.kombo.dev/assessment/guides/implementing-new-tools

Learn about best practices when using a new tool.

To enable a new tool, navigate to the [tools page](https://app.kombo.dev/tools) in the Kombo dashboard and enable it.

Before enabling it, we highly recommend using Kombo's resources to learn more about the tool. The reason for this is that not all HR tools support the exact same feature set. We try to unify these differences as much as possible, but we also aim to provide the best possible resources to prevent any surprises when using a tool.

Below is a list of the resources Kombo provides, and a short explanation on why they could be useful.

## Coverage Grid

The coverage grid provides a high-level overview of which data point is supported across all of our integrations. Hovering over noteworthy data points will also offer explanations of their implementation.

You can access the [HRIS coverage grid](https://app.kombo.dev/coverage/hris) or the [ATS coverage grid](https://app.kombo.dev/coverage/ats) from your dashboard.

## Tools Page

Our [tools page](https://app.kombo.dev/tools) provides in-depth documentation on each tool. Click on a tool's name to view its content.

### Resources

Under the resources tab, you'll find links to the tool's specific resources and guides.

* **Preview Connection Flow:** An interactive overview of the connection flow. Here, you'll be able to see each step that your customer will take, allowing you to provide support if necessary.
* **Connection Guide:** A written guide meant for customers, where we provide screenshots and explanations for navigating the tool's user interface to generate credentials.
* ***Sandbox***: If the tool allows for free demo accounts, we will provide a link here.

**ATS-Specific**

* **How to View Sources**: A guide to show where your company's desired attribution will be displayed in the customer's system.
* ***How to Set Up a Source***: If a tool has a complicated process for setting up source attribution, we provide an additional guide to assist your customer in doing so here.

### Limitations

The limitations tab provides general and data-point-specific explanations of how Kombo unifies the tools' data and, in some cases, which limitations the tool comes with.

For example, when a tool's data model differs too much from the unified Kombo model, we would explain how the data is mapped to the Kombo model here.


# Integration States
Source: https://docs.kombo.dev/assessment/guides/integration-states



## What is an Integration Status

After the connection flow has been completed, the integration will appear on
your [integrations page](https://app.kombo.dev/integrations).

Each integration has a status indicator informing you about the current
operational status.

<Note>
  ### API vs UI Integration States

  The [GET integration states](../v1/get-integrations-integration-id) endpoint returns a subset of the below-listed states, returning only those relating to the actual **sync status**.

  The [integrations page](https://app.kombo.dev/integrations) expands on these states for a more human-readable interface.
</Note>

## Possible Integration States

### Active

<Frame>
  <img />
</Frame>

The integration is running as expected, and data is being synced successfully.

### Sync Failing

<Frame>
  <img />
</Frame>

The last sync was not completed successfully. This can be the result of critical
errors, such as missing data, missing permissions, or the tool's API having downtime.

**Next steps:**

* Check the [logs](../features/logs) of the sync to read the error message.
* Reach out to Kombo for help with resolving an issue.

### Sync Has Warnings

<Frame>
  <img />
</Frame>

The last sync was successful with warnings. This can be the result of smaller
unexpected behavior, such as a specific field not being able to be fetched.

**Next steps:**

* Check the [logs](../features/logs) of the sync to read the warning message.
* Reach out to Kombo for help with resolving an issue.

### Quality Assurance

<Frame>
  <img />
</Frame>

If we detect any issues while performing the first sync, the integration status
will automatically be set to quality assurance mode. Our engineering team will
be notified, and we will contact you once we have resolved the issue and
re-enabled the integration.

### Authentication Failing

<Frame>
  <img />
</Frame>

The last sync failed because the credentials could no longer authenticate the
data transfer. This can be the result of expired credentials.

**Next steps:**

* [Reconnect the integration](./connect/reconnection#methods-of-reconnecting)

### Credentials Invalid

<Frame>
  <img />
</Frame>

The status is moved from **authentication failing** to **credentials invalid**
if every sync over the last 24 hours has failed due to authentication. The
integration will be automatically set to pause future syncs until new
credentials are provided.

**Next steps:**

* [Reconnect the integration](./connect/reconnection#methods-of-reconnecting)

### Setup

<Frame>
  <img />
</Frame>

An integration in the setup state has been successfully connected but no filters have been configured yet.

**Next steps:**

* [Create a provisioning link](/hris/v1/post-provisioning-groups-group-id-setup-links) to set up filters for the integration. You can also do this in the dashboard.

### Inactive

<Frame>
  <img />
</Frame>

An inactive integration will no longer automatically sync data. All credentials
and configuration are preserved — reactivating resumes syncing without
reconnection.

You can set an integration to active/inactive in two ways:

* **Dashboard:** Toggle in the settings page of the integration, as shown below.
* **API:** Use [Set integration enabled](../v1/put-integrations-integration-id-enabled) with `{ "value": false }` to pause or `{ "value": true }` to resume.

<Frame>
  <img />
</Frame>

In your [development environment](./environments#development), integrations will
be set to inactive if you did not send an API request to it over the past two
weeks. If desired, you can always reactivate it.

**Next steps:**

* Reactivate the integration in the dashboard or via the API.

### Deleted

<Frame>
  <img />
</Frame>

You previously deleted the integration. You can read more about our deletion policy [here](../features/deletion-policy).


# Partner Credentials
Source: https://docs.kombo.dev/assessment/guides/partner-credentials

Learn how existing partnerships to integrated systems can be used with Kombo.

## Overview

When you are already a partner with some of the tools that we are integrating,
Kombo allows you to bring your own credentials and settings to get the most out of
the partnership.

Partner credentials and options can, for example, be the OAuth master-level credentials
that are used to issue access tokens and initialize OAuth flows. That will allow
you to show your logo and name in the OAuth flow instead of Kombo's.

For most integrations, Kombo provides a set of default credentials and settings
so that you don't need to get a partnership with every tool you want to integrate.
However, if you have your own partnership, you can configure custom partner credentials
that work in a revision system, allowing you to manage multiple credential sets and
safely update them without breaking existing integrations.

## Understanding Credential Revisions

Partner credentials work in a revision system. Each time you create or update
credentials, a new revision is created with a label you can assign (e.g.,
"Production credentials" or "Staging credentials").

### How Revisions Work

The revision system ensures that credential changes are safe and non-destructive:

* **New integrations**: When you create a new integration, it automatically uses
  the latest revision (the most recently created one).
* **Reconnecting integrations**: When you reconnect an existing integration, it
  automatically upgrades to use the latest revision.
* **Existing integrations**: Existing integrations continue using their assigned
  revision and are **not automatically migrated** when you create a new
  revision. This ensures that creating new credentials doesn't break existing
  integrations.

## Managing Credentials and Revisions

You can manage partner credentials and revisions on the [tool settings page](https://app.kombo.dev/tools)
for all tools that support this feature.

<Frame>
  <img alt="image" />
</Frame>

The new revision will become the latest revision, and all new integrations will
automatically use it.

Each integration's details page shows which revision it's currently using,
including whether it's using customer-submitted credentials or Kombo default
credentials.

## Best Practices

Always test new credential revisions in your development environment before
using them in production. This helps you catch common issues like:

* Mismatched redirect URLs
* Insufficient OAuth scopes
* Incorrect API endpoints or base URLs
* Invalid authentication tokens

### Upgrading Existing Integrations

To upgrade an existing integration to a new revision, you must reconnect it
using the [reconnection flow](./connect/reconnection). This ensures
that the integration is properly tested with the new credentials before they're
applied.

The reconnection flow allows your customer to re-authenticate with the updated
credentials, ensuring a smooth transition without breaking the integration.

### Getting Help

We are always improving the support for custom partner credentials. If you are
missing this feature for a tool, or if you encounter any issues while setting
up credentials, please reach out to us.


# Static IPs
Source: https://docs.kombo.dev/assessment/guides/static-ips

Route all Kombo API calls through a fixed set of IP addresses so your customers can allowlist them.

## Use Case

Some systems are locked down to only accept inbound requests from a pre-approved set of IP addresses. Without Static IPs, Kombo's API calls to these systems would be rejected because our traffic originates from a dynamic address range.

Enabling Static IPs routes all outgoing API calls for a given integration through a fixed pool of addresses that you can share with your customer's system administrator to allowlist.

## Enabling Static IPs

Static IPs are configured per integration link at the time you create the connection link.

1. In the [Kombo dashboard](https://app.kombo.dev/integrations), click **New integration**.
2. Fill in the required fields and expand **Advanced settings**.
3. Toggle **Static IPs** on.
4. The dialog will display the IP addresses assigned to this integration. Copy them — you'll need to share them in the next step.
5. Click **Continue** and send the link to your customer as usual.

<Frame>
  <img
    alt="Static IPs toggle in the New Integration
dialog"
  />
</Frame>

## Sharing the IPs

Once you have enabled Static IPs, share the displayed IP addresses with the administrator of the connected system and ask them to add the addresses to their allowlist. Kombo's API calls will be rejected by the system until the allowlist is in place.

The exact steps to add IPs to an allowlist depend on the connected system. Refer to your customer's system documentation or share our [connection guides](https://help.kombo.dev) for step-by-step instructions.

## Existing Integrations

If you need to enable Static IPs for an integration that has already been set up, open the integration in the [Kombo dashboard](https://app.kombo.dev/integrations), go to its settings page, and toggle **Static IPs** on. The IPs to allowlist will appear immediately below the toggle.

<Frame>
  <img
    alt="Static IPs section on the Integration Settings
page"
  />
</Frame>


# How Kombo Syncs Data
Source: https://docs.kombo.dev/assessment/guides/sync

Understanding how Kombo keeps integration data up-to-date internally without sacrificing API reliability and performance.

# Syncs in Kombo

We're mirroring the data in the source systems into a database at regular
intervals (or when you [manually trigger a sync](../v1/post-force-sync)). When you
call our API, we will simply read from our database, resulting in endpoints that
always respond reliably and quickly.

Through our syncing approach, we can also provide [webhooks](./webhooks) for
systems that don't provide webhooks themselves.

<Info>
  This page explains how Kombo syncs data internally. If you're looking for how
  to fetch data from Kombo into your system, see our [Fetching Data
  guide](../getting-started/fetching-data).
</Info>

<Note>
  Note that syncs adhere to [your scope config](../features/scopes), so if there
  are sensitive data points you're not using, then those will **not** end up in
  our database.
</Note>

## Full Syncs vs. Delta Syncs

Kombo uses two different sync strategies to keep your data up-to-date. Each
serves a different purpose and has different trade-offs regarding speed,
completeness, and frequency.

### Full Syncs

A full sync **re-fetches all data** from the connected system. It pulls every
record (employees, candidates, jobs, etc.) regardless of whether it changed
since the last sync.

**Key characteristics:**

* Fetches the **complete dataset** from the remote system
* **Detects deletions**: records that existed before but are no longer returned
  by the source system are marked as deleted in Kombo
* **Reconciles data quality issues**: because everything is re-fetched, full
  syncs can correct inconsistencies that may have been missed by delta syncs or
  webhooks
* **Picks up configuration changes**: if you update your
  [scope config](../features/scopes) to include new fields, a full sync is needed to
  backfill those fields across all existing records
* Runs at a **lower frequency** than delta syncs
* Takes **longer to complete** since it processes all records

Full syncs are essential because they are the only sync type that can reliably
detect deletions and ensure the complete dataset is consistent.

### Delta Syncs

A delta sync **fetches only data that changed** since the last sync. It uses
upstream filters (like `updated_after` timestamps) to request only new or
modified records from the source system.

**Key characteristics:**

* Fetches only **new and modified records**, making it significantly faster
* **Cannot detect deletions**: since it only asks for changes, it has no way of
  knowing which records were removed
* Runs at a **higher frequency** than full syncs
* **Not available for all integrations**: delta syncing depends on the source
  system's API supporting change-based filtering

### How They Work Together

When an integration supports delta syncs, Kombo runs both types on
complementary schedules:

| Sync type  | Frequency | What it fetches      | Detects deletions |
| ---------- | --------- | -------------------- | ----------------- |
| Full sync  | Lower     | All records          | Yes               |
| Delta sync | Higher    | Only changed records | No                |

For integrations that **don't** support delta syncs, Kombo runs full syncs at a
higher frequency to compensate for the lack of incremental updates.

The exact sync frequency depends on your plan and can be customized on higher
tiers.

<Info>
  Some integrations also support **upstream webhooks**, which provide near
  real-time updates for individual record changes. When webhooks are active, the
  polling sync frequency may be reduced since webhooks already keep the data
  fresh. Learn more about [upstream webhooks](./upstream-webhooks).
</Info>

## Sync Units

For some integrations, Kombo splits a sync into smaller, independent **sync
units**. Instead of syncing all data types together, each unit syncs a focused
part of the dataset (for example, one model or a group of related models) and
completes on its own. This is currently being rolled out for a subset of tools
and environments, and doesn't change how you read data from our API.

Because units run independently, a few behaviors are scoped to the unit rather
than the sync as a whole:

* **Deletion tracking is per unit**: after a unit finishes its full sync, only
  the records belonging to that unit are considered for deletion tracking.
  Records from other units are unaffected until their own unit completes.
* **Webhooks are sent per unit**: "Data changed" [webhooks](./webhooks#data-changed)
  fire as each unit processes its data, so you receive updates progressively
  rather than all at once at the end of a full sync.
* **Endpoints unlock as units finish**: for newly connected integrations, an
  endpoint becomes available as soon as the unit responsible for its data
  completes, rather than waiting for the entire initial sync to finish.

## Sync Scheduling

Kombo uses a frequency-based scheduling system that automatically determines
when syncs should run for each integration.

### How Scheduling Works

The scheduling system works by tracking the **last sync time** and adding the
**configured frequency** to determine when the next sync is due.

For example, if a full sync completed at 2:00 PM and the configured frequency is
10 hours, the next sync will be due at 12:00 AM (midnight).

### Sync Frequencies

Different sync types run at different frequencies:

* **Full syncs** run less often when delta syncs are available, and more often
  when they are not
* **Delta syncs** run more frequently than full syncs

The exact frequency depends on your plan and can be customized on higher tiers.

When you manually trigger a sync, it **moves the schedule forward**:

**Example**: Say automatic full syncs are scheduled every 10 hours:

* Last sync: 10:00 AM → Next due: 8:00 PM
* Manual sync at 2:00 PM → Next due: 12:00 AM (midnight) (not 8:00 PM)

The schedule resets from the time of the manual sync, rather than keeping the
original schedule.

## Real-time Data Updates

In addition to full and delta syncs, we are also able to receive webhooks from
selected tools to keep our data in sync more efficiently. Read more about it
[here](./upstream-webhooks).

## Data Normalization

When syncing data from connected systems, Kombo normalizes records into the
unified model. Here's how different data scenarios are handled:

### Missing and Unsupported Fields

If a field is not available in the source system or the integration doesn't
support it, Kombo sets it to `null`. Records are **never dropped** due to
missing fields — you'll always receive the full record with `null` for any
unavailable properties.

This means you should design your system to handle `null` values gracefully,
since different source systems expose different sets of fields.

### Enum Normalization

For categorical fields like `gender`, `employment_type`, or
`employment_status`, Kombo maintains extensive mapping tables that translate
hundreds of system-specific values into unified enum values. For example,
"Vollzeit" or "CDI" from a German or French system both map to `FULL_TIME`.

If a value from the source system cannot be mapped to a known enum value, Kombo
**passes through the original string** rather than discarding it. This means you
may occasionally see raw values from the source system alongside standardized
ones for less common integrations. See the documentation of the specific
endpoint and enum for more information. Some enums don't pass unknown values through.

You can use [remapping](../features/remapping/introduction) to customize how specific
values are mapped if the defaults don't fit your needs.

### Scope-Based Filtering

Fields that are not included in [your scope config](../features/scopes) are set to `null`
during sync. This ensures that sensitive data points you're not using never
enter the Kombo database, even if the source system provides them.

## How Syncs Write Data to the Database

Understanding how Kombo syncs write data to the database is crucial for
understanding data availability and timing behavior.

### Non-Atomic Data Streaming

**Syncs are not atomic operations**. Instead of waiting to commit all data at
the end of a sync, Kombo streams data directly into the database as it's
processed during the sync. This means:

* **Data becomes available immediately**: Updated records appear in API
  responses as soon as they're processed, even while the sync is still running
* **Partial sync results**: If you query the API with `updated_after` during an
  ongoing sync, you'll receive records that have already been processed
* **No "commit phase"**: There's no single point where all sync data becomes
  available at once

### Change Tracking with `changed_at`

Each record in Kombo's database has a `changed_at` timestamp that tracks when
the record was last modified. This field is automatically updated by database
triggers when any tracked field changes:

* **Immediate updates**: `changed_at` is set as soon as a record is upserted
  during sync
* **API filtering**: The `updated_after` parameter in API requests filters based
  on this `changed_at` timestamp
* **Real-time availability**: Records with updated `changed_at` timestamps
  become immediately visible in API responses that use `updated_after` filtering

### Sync Lifecycle and Database Operations

During a sync, Kombo performs these database operations:

1. **Upsert operations**: Each record is upserted (created or updated)
   immediately when processed. If there were changes, the `changed_at` timestamp
   is updated.
2. **Deletion tracking**: For full syncs, records not seen during the sync are
   marked with `remote_deleted_at` after the sync completes successfully.
3. **Reference validation**: Ensures data integrity by validating relationships
   between records.

### Implications for API Consumers

* **Progressive data updates**: You can start receiving updated data before the
  sync completes
* **Timestamp-based filtering works reliably**: Using `updated_after` will
  correctly capture changes made during ongoing syncs
* **No need to wait**: There's no need to wait for sync completion to access
  newly updated data
* **Consistent behavior**: This works the same way for all sync types (full,
  delta, and default syncs)


# Upstream webhooks
Source: https://docs.kombo.dev/assessment/guides/upstream-webhooks

Kombo can subscribe to webhooks of the systems that your customers connect. We call this feature upstream webhooks. This document explains how they work and how you can leverage them.

<Note>
  Please be aware that this page covers upstream webhooks. These are webhooks
  that Kombo receives from the connected ATS/HRIS such as Personio or Recruitee.
  If you try to understand webhooks that Kombo sends to your system for new
  integrations or finished syncs, check out [this page](./webhooks).
</Note>

## Concept

Kombo subscribes to webhooks of the systems that your customers connect.
We call this feature upstream webhooks. The goal of this system is to enable you
to receive data in real-time without waiting for a normal sync to complete. Please
note that this is not available for all integrations and depending on the granted
permissions, this might require a re-connect for existing integrations.

When upstream webhooks are successfully enabled and you're subscribed to the data-changed webhook,
Kombo automatically reduces the sync frequency from 3 hours to 24 hours since most updates
are delivered in real-time.

## Availability

Upstream webhooks are available for a limited set of integrations as not all
integrations support them yet. We are actively working on implementing this
feature for more integrations.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/assessment/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/assessment/connectors/smartrecruiters">SmartRecruiters</a></li>
    <li><img /><a href="/assessment/connectors/oraclerecruiting">Oracle Recruiting Cloud</a></li>
    <li><img /><a href="/assessment/connectors/lever">Lever</a></li>
    <li><img /><a href="/assessment/connectors/icims">iCIMS</a></li>
    <li><img /><a href="/assessment/connectors/recruitee">Tellent Recruitee</a></li>
    <li><img /><a href="/assessment/connectors/greenhouse">Greenhouse</a></li>
    <li><img /><a href="/assessment/connectors/teamtailor">Teamtailor</a></li>
    <li><img /><a href="/assessment/connectors/ashby">Ashby</a></li>
    <li><img /><a href="/assessment/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/assessment/connectors/bullhorn">Bullhorn</a></li>
    <li><img /><a href="/assessment/connectors/jobylon">Jobylon</a></li>
    <li><img /><a href="/assessment/connectors/eightfold">Eightfold</a></li>
    <li><img /><a href="/assessment/connectors/jazzhr">JazzHR</a></li>
    <li><img /><a href="/assessment/connectors/jobvite">Jobvite</a></li>
    <li><img /><a href="/assessment/connectors/pageup">PageUp People</a></li>
    <li><img /><a href="/assessment/connectors/sandbox">Kombo Sandbox</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

## Setup

Whether additional setup is required depends on the connected tool. For many
tools, we are able to subscribe to webhooks automatically through the tool's
API. However, some require a one-time manual configuration by the end-customer
via the integration's Setup Flow. Until this step is completed, real-time
updates will not be available, and changes will arrive after the next scheduled
sync instead.

All configured webhook subscriptions (automatic and manual) are shown in an
integration's settings in the Kombo dashboard and can be managed from there.

## End-Customer Experience

For most integrations, the end-customer only needs to grant a permission to the
credentials to allow us to subscribe to webhooks.

<Frame>
  <img />
</Frame>

Kombo will also diligently only subscribe to webhook event types that are compliant
with the scope config. For example, if you disable candidates and only care about jobs, we
will not subscribe to any candidate events.

## Implementation Guide

By using our [Data changed webhook](./webhooks#data-changed), you will automatically receive updates
about changes we receive from upstream webhooks. That is in addition to any
changes from syncs or other sources. Learn more about how to fetch from Kombo in
our [Fetching Data](../getting-started/fetching-data) guide.

Set up the downstream event in the [webhook config](https://app.kombo.dev/configuration/webhooks) in the Kombo dashboard.

```mermaid theme={null}
sequenceDiagram
    participant ATS as End customer's ATS/HRIS
    participant Kombo as Kombo
    participant Customer as Kombo Customer

    ATS->>Kombo: Send upstream webhook event
    Kombo->>Kombo: Verify event

    Kombo-->>ATS: GET related data
    Kombo->>Kombo: Update Kombo DB


    Kombo->>Customer: Send downstream "data-changed"
    Customer->>Customer: Verify event
    Customer->>Kombo: GET changes via Kombo API
```

You can usually expect to receive events from the connected system within 10-20 seconds.
Most systems take a few seconds before they send the webhook to Kombo.

Kombo will retry the request to your system for up to 5 times with exponential
backoff.

## Troubleshooting

Check out the logs in the Kombo dashboard to see every webhook event that we receive.
The downstream request will also be logged there with any warnings or errors that
we encountered while processing or forwarding the event.

<Frame>
  <img />
</Frame>


# Webhooks
Source: https://docs.kombo.dev/assessment/guides/webhooks

Kombo sends you webhooks so that you don't have to poll our API for changes.

<Note>
  Please be aware that this page covers downstream webhooks. These are webhooks
  that Kombo sends to your system for events like new integrations or finished
  syncs. If you try to understand webhooks that Kombo receives from the
  connected ATS/HRIS such as Personio or Recruitee, check out [this
  page](./upstream-webhooks).
</Note>

## Enable Webhooks

You can configure your Kombo webhooks in the dashboard directly in the
[webhooks tab](https://app.kombo.dev/configuration/webhooks). After creating the first
webhook, a random webhook secret will be generated and shown. You can learn
how to use it in [Validate the data](#validate-the-data).

<Frame>
  <img alt="1412" />
</Frame>

## Available webhooks

### Data changed

We send a `data-changed` webhook every time data changes in Kombo. This includes
changes from regular syncs as well as updates from upstream webhooks.
Read more about fetching data [here](../getting-started/fetching-data).

<Note>
  We trigger this webhook, when we receive a change. To speed up delivery of
  changes to Kombo, ensure that upstream webhooks are enabled for the
  integration. If upstream webhooks are not enabled or not supported,
  notifications are sent after the next scheduled sync (latency equals the sync
  frequency).
</Note>

You can use this webhook to keep your database up to date by fetching only
the updated data using the `updated_after` filter.

This webhook is useful to fetch data from Kombo into your system. Read more
[here](../getting-started/fetching-data).

We will only ever send you a `data-changed` webhook if there are changes to the data.

```json data-changed theme={null}
{
  "id": "FhghqjnCi9WuAoLT8Z75CFcs",
  "type": "data-changed",
  "data": {
    "integration_id": "bombohr:ats-dev",
    "integration_tool": "bombohr",
    "integration_category": "ATS",
    "changed_models": [
      {
        "name": "ats_applications"
      }
    ]
  }
}
```

We are debouncing `data-changed` with a 30-second window by default. This means
that you will at most receive one `data-changed` webhook every 30 seconds.

When the webhook is triggered for the first time, we send it out immediately.
After that, we will wait 30 seconds, during which we will collect all events and
send them as a single webhook, thereby starting another 30-second cooldown
window. We do not wait for syncs to finish before sending out the webhook;
instead, we may send you multiple webhooks during a single sync to ensure you
receive changes as soon as possible.

### Sync finished

<Warning>
  The `sync-finished` webhook is deprecated and replaced by the [data-changed
  webhook](#data-changed). It is still available for existing setups, but should
  not be implemented in new setups. Use `data-changed` instead for [fetching
  data updates](../getting-started/fetching-data).
</Warning>

The `sync-finished` webhook is sent every time a sync finishes, regardless of
the sync state. Possible values for `sync_state` are:

* `SUCCEEDED` The sync finished successfully.
* `PARTIALLY_FAILED` The sync succeeded but had non-fatal errors. Kombo will
  take care of it.
* `FAILED` There was a critical error during the sync and the sync did not
  finish. If this happens, we get an alert and will look into the issue to fix
  it ASAP.
* `TIMED_OUT` The sync timed out before completion. This happens rarely and will
  cause an immediate and automatic restart of the sync. Kombo will be notified
  and look into the issue ASAP.
* `CANCELLED` The sync was actively canceled by Kombo. This happens very rarely,
  has no negative side-effects, and if it does happen, we will schedule a new
  sync shortly after.
* `AUTHENTICATION_FAILED` The authentication of the connection is incorrect.
  Please check the Kombo dashboard for further steps.

This webhook is useful for informing customers about when the last sync ran or if
user intervention is required due to authentication issues. This should **not** be
used to trigger data refreshes. Use the [data-changed webhook](#data-changed) for that.

<Note>
  The `sync_started_at` field represents when Kombo started syncing data from
  the connected system, not when you should start fetching from Kombo. Do not
  use this field as your `updated_after` parameter when fetching data.
  Otherwise, you might risk missing data that was created/updated via webhooks
  before the sync started.
</Note>

```json sync-finished theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "sync-finished",
  "data": {
    "sync_id": "B89SCXXho7Yw8PGo8AKJxLn4",
    "sync_state": "SUCCEEDED",
    "sync_started_at": "2021-09-01T12:00:00.000Z",
    "sync_ended_at": "2021-09-01T12:30:00.000Z",
    "sync_duration_seconds": 1800,
    "integration_id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
    "integration_tool": "personio",
    "integration_category": "HRIS",
    "end_user": {
      "origin_id": "36123",
      "creator_email": "user@example.com",
      "organization_name": "Acme, Inc."
    },
    "log_url": "https://app.kombo.dev/env/production/logs/C3xUo6XAsB2sbKC7M1gyXaRX"
  }
}
```

### Integration created

The `integration-created` webhook is sent for every integration that is created.
Please react to this webhook event by adding the integration to your database
or by performing any other business logic that is required when an integration is
created.

```json integration-created theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "integration-created",
  "data": {
    "id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
    "tool": "personio",
    "category": "HRIS",
    "end_user": {
      "origin_id": "36123",
      "creator_email": "user@example.com",
      "organization_name": "Acme, Inc."
    }
  }
}
```

### Integration deleted

The `integration-deleted` webhook is sent when an integration is deleted.
Please react to this webhook event by removing the integration from your database
or by performing any other business logic that is required when an integration is
deleted.

```json integration-deleted theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "integration-deleted",
  "data": {
    "id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
    "tool": "personio",
    "category": "HRIS",
    "end_user": {
      "origin_id": "36123",
      "creator_email": "user@example.com",
      "organization_name": "Acme, Inc."
    },
    "deleted_at": "2022-11-02T10:50:10.242Z"
  }
}
```

### Connection flow failed

The `connection-flow-failed` webhook is sent whenever an error occurs during the
connection flow. These errors could, for example, originate from a user entering
incorrect credentials or from a mismatch between the required and supplied API
permissions.

This is not an alert-type webhook, but should instead be used to collect data
and get insights into user behavior. **The connection flow can still be
successfully completed after this webhook is sent.**

You can check whether the connection flow ended successfully by following the
link under `log_url`. Additionally, the log will display the exact errors your
customer ran into, which you can use to provide support if needed.

```json connection-flow-failed theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "connection-flow-failed",
  "data": {
    "integration_tool": "personio",
    "integration_category": "HRIS",
    "end_user": {
      "origin_id": "36123",
      "creator_email": "user@example.com",
      "organization_name": "Acme, Inc."
    },
    "log_url": "https://app.kombo.dev/env/production/logs/C3xUo6XAsB2sbKC7M1gyXaRX"
  }
}
```

### Assessment order received

The `assessment:order-received` webhook is sent every time an assessment is
ordered for a candidate from within an end-customer's tool.

```json assessment:order-received theme={null}
{
  "id": "Cbfk5sHtDxrSrJBRjsDtbaN9",
  "type": "assessment:order-received",
  "data": {
    "id": "B5KQKhAgTv6ZwzrfAbqbhipd",
    "integration_id": "workday:CBNMt7dSNCzBdnRTx87dev4E",
    "package_id": "typescript_test",
    "status": "OPEN",
    "candidate": {
      "remote_id": "12345",
      "email": "john.doe@gmail.com",
      "first_name": "John",
      "last_name": "Doe",
      "phone": "+1 123 456 7890"
    },
    "application": {
      "remote_id": "54321"
    },
    "job": {
      "remote_id": "67890",
      "name": "Engineering Manager",
      "location": {
        "city": "Berlin",
        "country": "DE",
        "raw": "Berlin, Germany",
        "state": "Berlin",
        "street_1": "Lohmühlenstraße 65",
        "street_2": null,
        "zip_code": "12435"
      },
      "hiring_team": [
        {
          "first_name": "Jane",
          "last_name": "Doe",
          "remote_id": "78901",
          "email": "jane.doe@gmail.com",
          "hiring_team_roles": ["RECRUITER"]
        }
      ]
    }
  }
}
```

### Integration state changed

The `integration-state-changed` webhook is sent when the status of the
integration changes. Use this to detect stale credentials and to reconnect your
customer.

Possible values for the `"state"` key include:

* `ACTIVE` The integration is active and working.
* `INVALID` The connection [requires reconnection](./connect/reconnection) in order to work again.
* `INACTIVE` The integration has been paused, either via the [dashboard or API](./integration-states#inactive). No syncs will run until it is re-enabled.

The payload also includes `qa_status` (`PENDING`, `PASSED`, or `FAILED`) and `setup_status` (`INCOMPLETE`, `FINAL_SYNC_PENDING`, or `COMPLETED`). Together these tell you whether the integration is fully ready to serve data — see [integration states](./integration-states) for details.

```json integration-state-changed theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "integration-state-changed",
  "data": {
    "integration_tool": "personio",
    "integration_category": "HRIS",
    "integration_id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
    "end_user": {
      "origin_id": "36123",
      "creator_email": "user@example.com",
      "organization_name": "Acme, Inc."
    },
    "state": "ACTIVE",
    "qa_status": "PASSED",
    "setup_status": "COMPLETED"
    "updated_at": "2021-09-01T12:00:00.000Z"
  }
}
```

### Issue status changed

The `issue-status-changed` webhook is sent when Kombo [raises or resolves an issue](../features/issues). Subscribe once; every customer-visible issue type uses this webhook. See [issue types](../features/issue-types) for the current list. We will add more types over time, so your handler should treat `issue.type` as an open set and not fail on unknown values.

`change` is `raised` when the issue first appears or comes back after being resolved, and `resolved` when the condition clears. This webhook is only sent when the issue is raised or resolved. Snoozing only hides the issue in the Kombo dashboard, so snoozing, a snooze expiring, or updates to the message or other fields do not trigger it.

```json issue-status-changed theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "issue-status-changed",
  "data": {
    "change": "raised",
    "issue": {
      "id": "8f3a1c2e4b5d6a7c8e9f0a1b",
      "type": "integration.authentication_failed",
      "title": "Authentication failed",
      "status": "OPEN",
      "markdown_message": "**Acme, Inc.**'s personio HRIS integration failed authentication. This is often invalid, expired, or revoked credentials, but it can also be temporary provider downtime.\n\nCheck the [logs](https://app.kombo.dev/env/production/integrations/personio:CBNMt7dSNCzBdnRTx87dev4E/logs) first. If the credentials look invalid, create a reconnection link from the [integration page](https://app.kombo.dev/env/production/integrations/personio:CBNMt7dSNCzBdnRTx87dev4E) so the customer can reconnect.",
      "first_observed_at": "2021-09-01T12:00:00.000Z",
      "resolved_at": null
    },
    "integration": {
      "id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
      "tool": "personio",
      "category": "HRIS",
      "end_user": {
        "origin_id": "36123",
        "creator_email": "user@example.com",
        "organization_name": "Acme, Inc."
      }
    }
  }
}
```

## Validate the data

Anyone could post data to your webhook URL. That's why we're signing each
request with a secret specific to your Kombo account. This secret is called the
**Kombo Webhook Secret** and you can find it [on the Kombo
dashboard](https://app.kombo.dev/configuration/webhooks).

Each valid webhook `POST` request from us will include the `X-Kombo-Signature`
header. To validate it, carefully follow these steps:

1. Decode the `X-Kombo-Signature` header from [`base64url`
   encoding](https://base64.guru/standards/base64url) (without padding) to raw
   bytes.
2. Compute the HMAC-SHA256 over the **raw** JSON request body (Kombo encodes
   this using two-space indentation) with your **Kombo Webhook Secret** as raw
   bytes.
3. Compare the decoded signature bytes to the computed HMAC bytes using a
   constant-time comparison function (like [Node.js's
   `timingSafeEqual`](https://nodejs.org/docs/latest-v22.x/api/crypto.html#cryptotimingsafeequala-b))
   to protect against timing attacks.

<Warning>
  If you're stuck trying to get the signatures to match, please verify that:

  1. You're using the Webhook Secret of the **correct Kombo environment** (e.g.,
     production or development).
  2. You're using the **raw JSON request body**. If your framework already parses
     the JSON body for you, make sure to re-encode it with two-space indentation
     (e.g., `JSON.stringify(body, null, 2)` in JavaScript).
  3. You're decoding the signature header from `base64url` (not standard `base64`)
     and comparing raw bytes (not re-encoding the computed HMAC for string
     comparison).
</Warning>

Here are some examples of how you could achieve this in a few different languages:

<CodeGroup>
  ```ts TypeScript theme={null}
  import { createHmac, timingSafeEqual } from 'node:crypto'

  const signatureHeader = req.headers['x-kombo-signature']

  // Get the raw UTF-8-encoded string body because this was used for signing
  const body = request.body

  // Or if you use a framework that parses the body for you, you can use this.
  // Note: This is not the same as JSON.stringify(request.body)
  const body = JSON.stringify(request.body, null, 2)

  const expected = createHmac('sha256', KOMBO_WEBHOOK_SECRET)
  .update(body, 'utf8')
  .digest()

  // Decode and compare in constant time
  const provided = Buffer.from(signatureHeader, 'base64url')
  const isValidRequest =
  provided.length === expected.length && timingSafeEqual(expected, provided)

  ```

  ```python Python theme={null}
  import base64
  import hmac
  import hashlib

  provided_signature = request.headers.get('X-Kombo-Signature')

  secret = KOMBO_WEBHOOK_SECRET.encode()
  expected = hmac.new(secret, request_body, hashlib.sha256).digest()

  # Decode the provided signature and compare in constant time
  try:
    provided = base64.urlsafe_b64decode(provided_signature + '==')
    is_valid_request = hmac.compare_digest(expected, provided)
  except Exception:
    is_valid_request = False

  return is_valid_request
  ```

  ```kotlin Kotlin theme={null}
  val providedSignature = request.getHeader("X-Kombo-Signature")
  // CharStreams is from com.google.guava:guava library
  val requestBodyAsString = request.reader.use { CharStreams.toString(it) }

  // Calculate the signature
  val algorithm = "HmacSHA256"
  val encoding = Charsets.UTF_8
  val secret = KOMBO_WEBHOOK_SECRET.toByteArray(encoding)
  val signingKey = SecretKeySpec(secret, algorithm)
  val mac = Mac.getInstance(algorithm)
  mac.init(signingKey)

  val expected = mac.doFinal(requestBodyAsString.toByteArray(encoding))

  // Decode and compare in constant time
  val isValidRequest = try {
      val provided = Base64.getUrlDecoder().decode(providedSignature)
      MessageDigest.isEqual(expected, provided)
  } catch (e: Exception) {
      false
  }

  return isValidRequest

  ```
</CodeGroup>

## Testing webhooks

The list of all created webhooks has two buttons on the right. One is for
deleting the webhook, the other is for sending a test request. This test request
will contain dummy data but will use the correct data schema.

Be careful when using this feature in production! It will send invalid data to
your webhook.

### Testing locally

For local development, you can use a service like [localtunnel](https://theboroer.github.io/localtunnel-www/)
or [ngrok](https://ngrok.com/). These tools allow you to expose a local port
through a public URL provided by them. The setup is very straightforward: Once
you've started a tunnel, simply add the provided URL as a webhook in the Kombo
dashboard. You can then send test requests to validate that your endpoint is
working properly.

## Retry behavior

If your webhook endpoint does not acknowledge the webhook (returns an error or
does not respond), Kombo will automatically retry the delivery. This ensures
reliable webhook delivery even when your endpoint is temporarily unavailable.

### Retry attempts

Kombo will retry failed webhook deliveries up to **5 times** before giving up.
Each retry uses exponential backoff with the following delays:

* After 1st failure: 1 second
* After 2nd failure: 2 seconds
* After 3rd failure: 4 seconds
* After 4th failure: 8 seconds
* After 5th failure: 16 seconds

### Error conditions that trigger retries

Kombo will retry webhook deliveries for the following error conditions:

* **Rate limit errors** (HTTP 429): Retries respect `Retry-After` headers when
  provided
* **Server errors** (HTTP 5xx): Temporary server errors that may resolve on retry
* **Connection errors**: Network timeouts, connection resets, DNS failures, and
  other transient network issues
* **Cloudflare errors** (HTTP 409 with Cloudflare 1018 error): Temporary
  Cloudflare blocking errors

### Error conditions that do not trigger retries

The following errors will **not** trigger retries, as they indicate permanent
failures:

* **Client errors** (HTTP 4xx, except 429): These typically indicate issues with
  the webhook configuration or request format
* **DNS not found** (ENOTFOUND): The webhook URL cannot be resolved

### Best practices

To ensure reliable webhook delivery:

1. **Respond quickly**: Return a 2xx status code as soon as you've received and
   validated the webhook, even if you process it asynchronously
2. **Handle idempotency**: Webhooks may be delivered multiple times due to
   retries, so ensure your webhook handler is idempotent
3. **Monitor webhook logs**: Check the Kombo dashboard for webhook delivery
   failures and retry attempts

## Automatic deactivation of webhooks

If we are unable to find your webhook endpoint for more than 7 days (HTTP status
code 404 or 410), we will automatically disable the webhook. You can always
re-enable it in the dashboard.


# Important Changes
Source: https://docs.kombo.dev/assessment/important-changes

Significant platform changes that may affect your integration.

<Update label="2026-07-21" description="Timesheet retention outside the sync window">
  ## Timesheets that age out of the sync window are no longer marked as deleted

  Kombo only keeps a rolling window of timesheets up to date during sync (default: the last **2 months**, configurable via the **"Historical timesheet months to sync"** setting). Previously, timesheets that fell outside that window were marked as deleted on the next full sync.

  **What changed:** Kombo now only deletion-tracks timesheets **inside** that window. Timesheets that age out of the window are **kept** and are not marked with `remote_deleted_at` just because they were not re-fetched. Within the window, timesheets that disappear from the remote HRIS are still marked as deleted as usual.

  ### Who is affected

  Anyone relying on timesheets outside the window receiving a `remote_deleted_at` value (or disappearing from default list responses) simply because they aged out of the re-fetch window.

  ### What you should do

  * Treat aging out of the window as **retention**, not deletion — do not expect those rows to be marked deleted.
  * If you need history beyond what you've kept up to date, configure a larger window upfront or archive timesheets on your side.
  * Contact Kombo support if you need the window changed for your environment (the setting is read-only in the dashboard).

  See the [Time & Attendance guide](/hris/features/time-and-attendance) and the [GET timesheets](/hris/v1/get-timesheets) endpoint for details.
</Update>

<Update label="2026-05-19" description="New HTTP status code for integration setup errors">
  ## Integration setup errors now return HTTP status code 409 instead of 503

  From **Tuesday, May 19, 2026**, the following [Kombo error codes](/guides/errors) will start returning **HTTP `409 Conflict`** instead of **HTTP `503 Service Unavailable`**:

  | Error code                                                                        | Meaning                                                      |
  | --------------------------------------------------------------------------------- | ------------------------------------------------------------ |
  | [`INTEGRATION.SETUP_INCOMPLETE`](/guides/errors#integration-setup_incomplete)     | The integration setup hasn't been finished yet.              |
  | [`INTEGRATION.SETUP_SYNC_PENDING`](/guides/errors#integration-setup_sync_pending) | The initial sync after connection is still running.          |
  | [`INTEGRATION.QA_FAILED`](/guides/errors#integration-qa_failed)                   | The integration's setup data didn't pass our quality checks. |

  We're making these changes in accordance with [our error handling best practices](/guides/errors#error-format) that we announced with the release of structured error codes in August 2025:

  Error handling logic on top of the Kombo API should, if available, **always make use of the `error.code` field** in the response, and **only** fall back to the HTTP status code if the `error.code` is not present (which should rarely happen).

  We're changing these specific codes because `409 Conflict` ([RFC 7231](https://www.rfc-editor.org/rfc/rfc7231#section-6.5.8)) matches the actual error state better. The `error.code` values themselves are **not changing**.

  ### What you should do

  Start by checking whether your implementation currently branches on the HTTP status code (`503` specifically, or `5xx` in general) when handling any of the three error codes above.

  * **If it doesn't, you're all set** and don't need to take any action.
  * **If it does**, please update that logic to rely on the `error.code` field instead of the HTTP status code, so it keeps behaving correctly once these errors start returning `409`.

  While you're at it, you may want to consider adding explicit handling for [`INTEGRATION.SETUP_INCOMPLETE`](/guides/errors#integration-setup_incomplete), [`INTEGRATION.SETUP_SYNC_PENDING`](/guides/errors#integration-setup_sync_pending), and [`INTEGRATION.QA_FAILED`](/guides/errors#integration-qa_failed) if you don't have it yet:

  * `INTEGRATION.SETUP_INCOMPLETE` and `INTEGRATION.QA_FAILED` should be surfaced to the affected end-customer or admin user because they usually require manual intervention.
  * `INTEGRATION.SETUP_SYNC_PENDING` resolves once the initial sync finishes, but initial syncs can take hours in some cases. We recommend relying on [webhooks](guides/webhooks) instead of retrying silently or polling aggressively.
</Update>

<Update label="2026-03-20" description="Concurrency limiting enforced">
  ## Action concurrency limiting is now enforced

  Kombo now enforces concurrency limits on action endpoints. Previously,
  concurrent requests were measured but not rejected. Now, when more than 30
  action requests are in flight simultaneously for a single integration,
  additional requests are rejected with HTTP `429` and the error code
  `PLATFORM.CONCURRENCY_LIMIT_EXCEEDED`.

  **Who is affected:** Customers sending many parallel action requests (e.g.,
  bulk-creating candidates or moving applications) may start receiving `429`
  responses they were not receiving before. Model read endpoints are not affected
  (e.g. `GET /ats/candidates`)

  **What to do:**

  * Handle the new `PLATFORM.CONCURRENCY_LIMIT_EXCEEDED` error code in your
    retry logic.
  * Use exponential backoff starting at \~1s.
  * Optionally, check the `Concurrency-Remaining` response header to throttle
    proactively.

  See the full [Concurrency Limiting](guides/concurrency-limiting) guide for
  details.
</Update>


# Introduction
Source: https://docs.kombo.dev/assessment/introduction

Learn how to get started with Kombo's unified ATS Assessment & Background Check API.

As an assessment or background check provider, you want to **reduce the friction for your customers to order assessments or background checks** for their candidates.

By building on top of Kombo's **Unified ATS Assessment & Background Check API**, you can allow your customers to seamlessly start assessments or background checks right from their Applicant Tracking System (ATS).

Here's how it works:

1. Submit your available packages via the [Set packages endpoint](/assessment/v1/put-packages) to Kombo. We'll take care of displaying them in your customers' ATSs. Your customers can then choose the packages and create assessment or background check orders from their ATSs.
2. When your customer triggers a new assessment or background check order in the ATS, Kombo sends you an `assessment:order-received` [webhook event](/assessment/webhooks/assessment-order-received), so you can automatically send out an email to the candidate and get the assessment or the background check process started on your side.
3. Once the candidate has completed their assessment or the background check status has been updated, you can write back the results to the ATSs with the [Update order result endpoint](/assessment/v1/put-orders-assessment-order-id-result) via Kombo. Your customers will be able to view the results directly within their ATSs.

Continue reading to learn more about what these steps look like in practice.

## Setup: Connecting a new customer

<Frame>
  <img />
</Frame>

Use [Kombo Connect](/assessment/guides/connect/introduction) to set up your integrations with your customers. We'll guide your customers through the process of setting up their integrations.

## Implementation Overview

```mermaid theme={null}
sequenceDiagram
    participant You
    participant Kombo
    participant ATS

    Note over You, ATS: Configure Packages
    You->>Kombo: Set assessment test packages<br/>PUT `/assessment/packages`
    Kombo<<-->>ATS: List packages

    Note over You, ATS: Order Assessment or Background Check
    ATS-->>Kombo: New assessment or background check<br/>order event
    Kombo-->>Kombo: Process order
    Kombo->>You: Receive new order<br/>`assessment:order-received` event

    Note over You, ATS: Update Result
    You->>You: Perform assessment/background check
    You->>You: Generate report and score
    You->>Kombo: Update order result<br/>PUT `/assessment/orders/{order_id}/result`
    Kombo-->>ATS: Write result to ATS
```

<Tip>
  Check out how to use Kombo's [Sandbox
  Integration](/assessment/features/assessment-ui#development-flow) to speed up
  your implementation.
</Tip>

<Steps>
  <Step title="Configure Available Packages">
    [Submit](/assessment/v1/put-packages) all your available assessment and/or background check packages for the customer once they have connected via Kombo. Kombo automatically configures the ATS to surface the packages to your customer.

    ```shell theme={null}
    curl --location --request PUT 'https://api.kombo.dev/v1/assessment/packages' \
      --header 'X-Integration-Id: smartrecruiters:example_integration_id' \
      --header 'Content-Type: application/json' \
      --header 'Authorization: Bearer example_kombo_token' \
      --data '{
        "packages": [
          {
            "id": "YOUR-PKG-ID-0001",
            "name": "Coding Test",
            "description": "Coding test description...",
            "type": "SKILLS_TEST"
          },
          {
            "id": "YOUR-PKG-ID-0002",
            "name": "Psychometric Test",
            "description": "Psychometric test description...",
            "type": "SKILLS_TEST"
          },
          {
            "id": "YOUR-PKG-ID-0003",
            "name": "Visa Status",
            "description": "Visa status check...",
            "type": "BACKGROUND_CHECK"
          },
          {
            "id": "YOUR-PKG-ID-0004",
            "name": "SSN Verification",
            "description": "SSN verification check...",
            "type": "BACKGROUND_CHECK"
          }
        ]
      }'
    ```

    Your customer will then be able to view your submitted packages in their ATS:

    <Frame>
      <img />
    </Frame>
  </Step>

  <Step title="Reacting to New Assessment or Background Check Orders">
    <Note>
      For **Inline Assessment**, please refer to [this guide](/assessment/features/inline-assessment) for reacting to new inline assessment orders.
    </Note>

    When your customer triggers an assessment or background check for a specific candidate from their ATS, Kombo will then notify you that a new assessment or background check order has been created via the `assessment:order-received` [webhook event](/assessment/webhooks/assessment-order-received).

    * For assessments, you should then send out an email to the candidate to take the test on your platform. The candidate will then complete your assessment.
    * For background checks, you could send out an email to the candidate to fill in additional information required by the background check that is not stored on the ATS.

    ```json assessment:order-received theme={null}
    {
      "id": "Cbfk5sHtDxrSrJBRjsDtbaN9",
      "type": "assessment:order-received",
      "data": {
        "id": "B5KQKhAgTv6ZwzrfAbqbhipd",
        "integration_id": "workday:CBNMt7dSNCzBdnRTx87dev4E",
        "package_id": "typescript_test",
        "status": "OPEN",
        "candidate": {
          "remote_id": "12345",
          "email": "john.doe@gmail.com",
          "first_name": "John",
          "last_name": "Doe",
          "phone": "+1 123 456 7890"
        },
        "application": {
          "remote_id": "54321"
        },
        "job": {
          "remote_id": "67890",
          "name": "Bottle Opener",
          "job_code": "BO-2024-01",
          "description": "<p>We are looking for a skilled and energetic individual to join our team as the chief bottle open officer. This unique role requires precision, attention to detail, and the ability to handle a high volume of beverage bottles in a fast-paced environment. The ideal candidate will ensure bottles are opened swiftly and safely while maintaining hygiene standards.</p>",
          "location": {
            "street_1": "Lohmühlenstraße 65",
            "city": "Berlin",
            "state": "Berlin",
            "zip_code": "12435",
            "country": "DE",
            "raw": "Berlin, Germany"
          },
          "hiring_team": [
            {
              "first_name": "Jane",
              "last_name": "Doe",
              "remote_id": "78901",
              "email": "jane.doe@gmail.com",
              "hiring_team_roles": ["RECRUITER"]
            }
          ]
        }
      }
    }
    ```

    <Tip>Please refer to [this guide](/assessment/guides/webhooks#validate-the-data) on how to validate Kombo's webhooks.</Tip>

    You can reject your customer’s order of a package by responding with a `422` status code and body in the following shape:

    ```http theme={null}
    HTTP/1.1 422 Unprocessable Content
    Date: Fri, 28 Jun 2024 12:00:00 GMT
    Content-Type: application/json; charset=utf-8
    Content-Length: 187

    {
      "status": "ORDER_REJECTED",
      "message": "There is an existing order for this candidate..."
    }
    ```

    <Info>
      We will propagate the error message from the `message` field back to the ATS's UI if it is supported by their API, so that your customers can understand what’s going on.
    </Info>

    <Warning>
      The response to the `assessment:order-received` webhook’s body needs to match the shape described in the example to make us reject the assessment order!

      Other errors will not cause us to reject the assessment. We will still accept it and make it available via the [Get open orders](/assessment/v1/get-orders-open) endpoint so that you can retry at a later point.
    </Warning>
  </Step>

  <Step title="Write Back Results">
    Once the candidate has completed your assessment or the background check has been updated for the candidate, you can [update the results](/assessment/v1/put-orders-assessment-order-id-result) of the assessment or the background check via Kombo:

    ```shell theme={null}
    curl --location --request PUT 'https://api.kombo.dev/v1/assessment/orders/B5KQKhAgTv6ZwzrfAbqbhipd/result' \
      --header 'X-Integration-Id: smartrecruiters:example_integration_id' \
      --header 'Content-Type: application/json' \
      --header 'Authorization: Bearer example_kombo_token' \
      --data '{
        "status": "COMPLETED",
        "score": 90,
        "max_score": 100,
        "result_url": "https://example.com",
        "completed_at": "2023-04-04T00:00:00.000Z",
        "attributes": [
          {
            "type": "TEXT",
            "label": "Role fit",
            "value": "Excellent"
          },
          {
            "type": "SUB_RESULT",
            "id": "<YOUR_INTERNAL_ID_OF_THE_TEST>",
            "label": "Personality test",
            "score": {
              "value": 97,
              "max": 100
            },
            "status": "COMPLETED"
          },
          {
            "type": "TEXT",
            "label": "SSN Status",
            "value": "Valid"
          }
        ],
        "attachments": [
          {
            "name": "Assessment Report.pdf",
            "data": "SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=",
            "content_type": "application/pdf"
          }
        ]
      }'
    ```

    Kombo will write the assessment or background check results back into your customer's ATS system.
    Your customer can then view the results directly in their ATS.

    <Frame>
      <img />
    </Frame>

    <Frame>
      <img />
    </Frame>
  </Step>
</Steps>


# Delete integration
Source: https://docs.kombo.dev/assessment/v1/delete-integrations-integration-id

DELETE /integrations/{integration_id}
Delete the specified integration.

**⚠️ This can not be undone!**


# Check API key
Source: https://docs.kombo.dev/assessment/v1/get-check-api-key

GET /check-api-key
Check whether your API key is working properly.



# Get integration by token
Source: https://docs.kombo.dev/assessment/v1/get-connect-integration-by-token-token

GET /connect/integration-by-token/{token}
Use this endpoint with the token you get from the connection flow to retrieve information about the created integration.

It works in a similar way as the OAuth2 code flow to securely retrieve information and connect the integration to your user.

> Check out [our full guide](/connect/embedded-flow) for more details about implementing the connection flow into your app.

This endpoint is used to ensure users can't trick your system connecting their
account in your system to another customers integration. You don't get the integration ID
from the `showKomboConnect(link)` function but only the short lived token used
for this endpoint so that users can't send you arbitrary data that you would put
into your system.


# Get integration details
Source: https://docs.kombo.dev/assessment/v1/get-integrations-integration-id

GET /integrations/{integration_id}
Get the specified integration with everything you need to display it to your customer.



# Get custom fields with current mappings
Source: https://docs.kombo.dev/assessment/v1/get-integrations-integration-id-custom-fields

GET /integrations/{integration_id}/custom-fields
Get all custom fields available on the specified integration.

\**This includes the mapping to the corresponding integration field if applicable*


# Get integration fields
Source: https://docs.kombo.dev/assessment/v1/get-integrations-integration-id-integration-fields

GET /integrations/{integration_id}/integration-fields
Get all fields available on the specified integration.

**This includes the mapping to your custom fields**


# Get orders
Source: https://docs.kombo.dev/assessment/v1/get-orders

GET /assessment/orders
Get all assessment and background check orders of an integration.



# Get open orders (deprecated)
Source: https://docs.kombo.dev/assessment/v1/get-orders-open

GET /assessment/orders/open
**(⚠️ Deprecated - Use [Get orders](/assessment/v1/get-orders) instead)** Get all open assessment and background check orders of an integration.



# Get packages
Source: https://docs.kombo.dev/assessment/v1/get-packages

GET /assessment/packages
Get all available assessment and background check packages for an integration.

This is mainly intended for debugging. As you always need to submit the full list of available packages when using ["set packages"](/assessment/v1/put-packages), there shouldn't ever be a need to call this endpoint in production.


# Get tools
Source: https://docs.kombo.dev/assessment/v1/get-tools-category

GET /tools/{category}
Get a list of the tools (i.e., integrations) enabled in your environment.

This can (in combination with the `integration_tool` parameter of [the "Create Link" endpoint](/v1/post-create-link)) be used to, for example, display a custom list or grid of available integrations to your end users instead of exposing Kombo Connect's standard tool selector.


# Updates an integration fields passthrough setting
Source: https://docs.kombo.dev/assessment/v1/patch-integrations-integration-id-integration-fields-integration-field-id

PATCH /integrations/{integration_id}/integration-fields/{integration_field_id}
When enabled, the integration field will be passed as part of the `integration_fields` array on the specific model endpoint. Providing false will disable the passthrough for the specified field.



# Activate integration (optional)
Source: https://docs.kombo.dev/assessment/v1/post-connect-activate-integration

POST /connect/activate-integration
Use this endpoint with the token you get from the connection flow to retrieve information about the created integration. It works in a similar way as the OAuth2 code flow to securely retrieve information and connect the integration to your user. You do not need to call this endpoint for an integration to become active.

<Warning>We are deprecating this endpoint in favour of the [get integration by code endpoint](/v1/get-integration-by-token-token). To migrate you only have to change to the new API endpoint.</Warning>

### Example Request Body

```json theme={null}
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtZXNzYWdlIjoiVGhpcyBpcyBub3QgYW4gYWN0dWFsIHRva2VuLiJ9.JulqgOZBMKceI8vh9YLpVX51efND0ZyfUNHDXLrPz_4"
}
```


# Create connection link
Source: https://docs.kombo.dev/assessment/v1/post-connect-create-link

POST /connect/create-link
Generate a unique link that allows your user to enter the embedded Kombo Connect flow.

> Check out [our full guide](/connect/embedded-flow) for more details about implementing the connection flow into your app.

> Kombo will not deduplicate integrations for you that are created with this endpoint. You are responsible for keeping track of integrations in your system and prevent customers from connecting the same tool again. Use the [reconnection link](/v1/post-integrations-integration-id-relink) endpoint if you want a customer to update their credentials.

### Example Request Body

```json theme={null}
{
  "end_user_email": "test@example.com",
  "end_user_organization_name": "Test Inc.",
  "integration_category": "HRIS",
  "integration_tool": "personio",
  "end_user_origin_id": "123",
  "language": "en",
  "link_type": "EMBEDDED"
}
```


# Trigger sync
Source: https://docs.kombo.dev/assessment/v1/post-force-sync

POST /force-sync
Trigger a sync for a specific integration.

<Warning>Please note that it is **not** necessary nor recommended to call this endpoint periodically on your side. Kombo already performs periodic syncs for you and you should only trigger syncs yourself in special cases (like when a user clicks on a "Sync" button in your app).</Warning>


# Create provisioning setup link (deprecated)
Source: https://docs.kombo.dev/assessment/v1/post-hris-provisioning-groups-group-id-setup-links

POST /hris/provisioning-groups/{group_id}/setup-links
Create a new link that can be passed to the Kombo Connect SDK to open the provisioning setup UI.

<Warning>
  **This endpoint is deprecated!**

  Please use the [Create Setup Flow link endpoint](/v1/post-integrations-integration-id-setup-link) instead. It supports the full Setup Flow (including filtering, field mapping, and any other enabled steps) and works for any integration category, not just HRIS.
</Warning>


# Create reconnection link
Source: https://docs.kombo.dev/assessment/v1/post-integrations-integration-id-relink

POST /integrations/{integration_id}/relink
Create a link that will allow the user to reconnect an integration. This is useful if you want to allow your users to update the credentials if the old ones for example expired.

Embed this the same way you would [embed the connect link](/connect/embedded-flow). By default, the link will be valid for 1 hour.

### Example Request Body

```json theme={null}
{
  "language": "en",
  "scope_config_id": "9Pv6aCFwNDEzPNmwjSsY9SQx",
  "link_type": "EMBEDDED"
}
```


# Create Setup Flow link
Source: https://docs.kombo.dev/assessment/v1/post-integrations-integration-id-setup-link

POST /integrations/{integration_id}/setup-link
Create a link that lets your customer run the [Setup Flow](/hris/features/setup-flow/introduction) for an integration. Use this to send customers back into setup steps like field mapping or employee filtering without having to go through the initial connection flow again. Pass the returned URL to `showKomboConnect` from the Kombo Connect SDK, the same way you do with a connection link.

The integration must have at least one Setup Flow step enabled (e.g. field mapping or employee filtering); otherwise this endpoint returns a `PLATFORM.INPUT_INVALID` error. Steps can be enabled from the Integration Settings tab in the dashboard or via the [Create Connection Link endpoint](./post-connect-create-link).


# Send passthrough request
Source: https://docs.kombo.dev/assessment/v1/post-passthrough-tool-api

POST /passthrough/{tool}/{api}
Send a request to the specified integration's native API.

At Kombo we put a lot of work into making sure that our unified API covers all our customers' use cases and that they never have to think about integration-specific logic again. There are cases, however, where our customers want to build features that are very integration-specific. That's where this endpoint comes in.

Pass in details about the request you want to make to the integration's API and we'll forward it for you. We'll also take care of setting the right base URL and authenticating your requests.

To get started, please pick the relevant API (some tools provide multiple to due different base URLs or authentication schemes) from the table below and pass in the `{tool}/{api}` identifier as part of the path.

| Integration                  | `{tool}/{api}`                     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| ---------------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| 360Learning                  | `360learning/v2`                   | 360Learning [API v2](https://360learning.readme.io/docs). We automatically handle authentication and use `https://app.360learning.com/api/v2/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| a3innuva Nómina              | `a3innuvanomina/laboral`           | a3innuva Nómina API [docs](https://a3developers.wolterskluwer.es/). Requests are automatically authenticated using OAuth access tokens (refreshed when needed). Base URL: `https://a3api.wolterskluwer.es/Laboral/api`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Abacus Umantis               | `abacusumantis/v1`                 | [Umantis API v1](https://recruitingapp-91005709.umantis.com/api/v1/swagger-ui). We automatically authenticate all requests and use `https://\{subdomain\}.umantis.com/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Abacus                       | `abacus/api`                       | Abacus [REST API](https://apihub.abacus.ch/). We automatically authenticate all requests and use `https://\{\{abacusUrl\}\}/api/entity/v1/mandants/\{\{mandantId\}\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Absence.io                   | `absenceio/v2`                     | Absence.io [API](https://docs.absence.io/). We automatically authenticate all requests and use `https://app.absence.io/api/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| ADP Decidium                 | `adpdecidium/default`              | [ADP Decidium API](https://developers.adp.com/apis/api-explorer/hcm-offrg-dge). We automatically authenticate all requests and use `https://api.eu.adp.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| ADP Workforce Now            | `adpworkforcenow/default`          | [ADP Workforce Now API v2](https://developers.adp.com/build/api-explorer/hcm-offrg-wfn). We automatically authenticate all requests and use the correct subdomain.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| AFAS Software                | `afas/api`                         | AFAS' [API](https://connect.afas.nl/rest/get). We automatically authenticate all requests and use `https://\{domain\}/ProfitRestServices` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| AlexisHR                     | `alexishr/v1`                      | [AlexisHR's v1 API](https://docs.alexishr.com/) We automatically authenticate all requests and use `https://\{subdomain\}.alexishr.com` as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| ApplicantStack               | `applicantstack/api`               | ApplicantStack's [API](https://helpas.payrollservers.info/s/article/API-Integration-Guide). We automatically authenticate all requests and use `https://\{subdomain\}.applicantstack.com/api/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Apploi                       | `apploi/rest-api`                  | The [Apploi API](https://integrate.apploi.com/). We automatically authenticate all requests and use `https://partners.apploi.com/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Ashby                        | `ashby/v1`                         | Ashby's [V1 API](https://developers.ashbyhq.com/reference/introduction). We automatically authenticate all requests with the provided credentials and use `https://api.ashbyhq.com` as the base URL. Please note that Ashby uses an RPC-style API. Please check [the Ashby API documentation](https://developers.ashbyhq.com/reference/introduction) for details on how to use it.                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| Asymbl                       | `asymbl/v63`                       | We use `https://\{subdomain\}.my.salesforce.com` as the base URL. Find the official docs [here](https://asymblinc.github.io/ats/ats.html).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Avature                      | `avature/custom-api`               | Avatures's Custom API. Call `Get /openapi` to retrieve the specific custom API schema. We automatically authenticate all requests and use the instance specific custom API URL as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Avionté                      | `avionte/front-office-v1`          | Avionte's API. We automatically authenticate all requests and use `https://api.avionte.com/front-office/v1` as the base URL. Documentation for the BOLD Front Office API: [https://developer.avionte.com/reference/get-all-talent-tags](https://developer.avionte.com/reference/get-all-talent-tags)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| BambooHR                     | `bamboohr/v1`                      | BambooHR's [API](https://documentation.bamboohr.com/reference/get-employee). We automatically authenticate all requests using the customer credentials `https://api.bamboohr.com/api/gateway.php/\{subdomain\}/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| BITE                         | `bite/v1`                          | [Bite's v1 API](https://api.b-ite.io/docs/#/). We automatically authenticate all requests and use your configured API base URL with `/v1` appended (default `https://api.b-ite.io/v1`).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| BoondManager                 | `boondmanager/api`                 | BoondManager [REST API](https://ui.boondmanager.com/administrator/developer/apisandbox). We automatically authenticate all requests and use `https://ui.boondmanager.com/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Breezy HR                    | `breezyhr/v3`                      | [BreezyHR's v3 API](https://developer.breezy.hr/reference/overview). We automatically authenticate all requests and use "[https://api.breezy.hr/v3/](https://api.breezy.hr/v3/)" as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| Bullhorn for Salesforce      | `bullhorn4salesforce/v66`          | We use `https://\{subdomain\}.my.salesforce.com/services/data/v66.0` as the base URL. Find the official docs [here](https://kb.bullhorn.com/bh4sf/Content/BH4SF/Topics/bh4sfRestAPI.htm).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Bullhorn                     | `bullhorn/default`                 | [Bullhorn's API](https://bullhorn.github.io/rest-api-docs/index.html). We automatically use the right `https://\{subdomain\}.bullhornstaffing.com/rest-services/\{corpToken\}` base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| CareerPlug                   | `careerplug/api`                   | We use `https://api.careerplug.com` as the base URL. Find the official docs [here](https://api.careerplug.com/docs#api).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Carerix                      | `carerix/api`                      | Carerix [REST API](https://docs.carerix.io/rest/introduction). We automatically authenticate all requests and use `https://api.carerix.com` as the base URL. Please note that Carerix uses XML for request and response bodies.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Carerix                      | `carerixgraphql/graphql`           | Carerix [GraphQL API](https://docs.carerix.io/graphql/welcome). We automatically authenticate all requests (OAuth2 client credentials) and use `https://api.carerix.io/graphql/v1` as the base URL. Send GraphQL requests as `POST /graphql` with a JSON body of `\{ "query": "...", "variables": \{ ... \} \}`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| CEGID TalentSoft Customer    | `talentsoftcustomer/v1`            | Cegid Talentsoft Recruiting FrontOffice API: [API Documentation](https://developers.cegid.com/api-details#api=cegid-talentsoft-recruiting-frontoffice) We automatically authenticate all requests and use `https://\{customer_subdomain\}.talent-soft.com/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| CEGID TalentSoft FrontOffice | `talentsoft/v2`                    | Cegid Talentsoft Recruiting FrontOffice [API](https://developers.cegid.com/api-details). We automatically authenticate all requests using the provided credentials and use `https://\{domain\}/api/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Ceipal                       | `ceipal/v1`                        | We use `https://api.ceipal.com/v1` as the base URL. Find the official docs [here](https://developer.ceipal.com/ceipal-ats-version-one/ceipal-ats-v1-api-reference).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Cezanne HR                   | `cezannehr/dataservice`            | [CezanneHR's v7 dataservice API](https://api.cezannehr.com/).We automatically authenticate all requests and use the base URL `https://\{subdomain\}.cezanneondemand.com/cezanneondemand/v7/dataservice.svc`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Compleet (Persy)             | `compleetpersy/api`                | Compleet Persy [REST API](https://persy-api.refined.site/space/PAPI/450166808/Requirements+Jobfeed+%2F+Anforderungen+f%C3%BCr+Jobfeeds). We automatically authenticate all requests and use `https://www.germanpersonnel.de/persy/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Compleet                     | `compleetpitcher/pitcher`          | Compleet's Pitcher API. We automatically authenticate all requests and use the configured base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Connexys By Bullhorn         | `connexys/api`                     | [Connexy's API](https://api.conexsys.com/client/v2/docs/#section/Overview). We automatically authenticate all requests and use `https://\{connexys_domain\}/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Cornerstone OnDemand         | `cornerstoneondemand/core-hr`      | Cornerstone's [Core HR API](https://csod.dev/reference/core-hr/). We automatically authenticate all requests using the client ID and secret and use `https://\{your_domain\}.csod.com/services/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Cornerstone OnDemand         | `cornerstoneondemand/learning`     | Cornerstone's [Learning API](https://csod.dev/reference/learning/). We automatically authenticate all requests using the client ID and secret and use `https://\{your_domain\}.csod.com/services/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Cornerstone OnDemand         | `cornerstoneondemand/recruiting`   | Cornerstone's [Recruiting API](https://csod.dev/reference/recruiting/). We automatically authenticate all requests using the client ID and secret and use `https://\{your_domain\}.csod.com/services/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Cornerstone TalentLink       | `cornerstonetalentlink/apply`      | Cornerstone TalentLink's Apply API. We automatically authenticate all requests using the provided credentials and API key, and use `https://apiproxy.shared.lumessetalentlink.com/apply` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Cornerstone TalentLink       | `cornerstonetalentlink/rest`       | Cornerstone TalentLink's [REST API](https://developer.lumesse-talenthub.com/rest-api-developers-guide/1.21.33/index.html?page=rest-api\&subpage=introduction). We automatically authenticate all requests using the provided credentials and API key, and use `https://apiproxy.shared.lumessetalentlink.com/tlk/rest` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Coursera                     | `coursera/v1`                      | We use `https://api.coursera.com/ent` as the base URL. Find the official docs [here](https://dev.coursera.com).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Coveto (legacy SOAP API)     | `coveto/public`                    | We automatically use `https://\{subdomain\}.coveto.de` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Coveto (REST API)            | `covetorest/v1`                    | We automatically use `https://\{subdomain\}.coveto.de/public/api/v1` as the base URL. [https://demo.coveto.de/swagger-ui/index.html#/](https://demo.coveto.de/swagger-ui/index.html#/)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Crelate                      | `crelate/api`                      | Crelate [REST API](https://app.crelate.com/api3/docs/index.html). We automatically authenticate all requests and use `https://app.crelate.com/api3` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| d.vinci admin                | `dvinciadmin/odata-api`            | [DVinci ODATA API](https://dvinci.freshdesk.com/en/support/solutions/articles/75000059523-odata-reporting-api).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| d.vinci admin                | `dvinciadmin/rest-api`             | [DVinci REST API](https://static.dvinci-easy.com/files/d.vinci%20rest-api.html).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| d.vinci                      | `dvinci/apply-api`                 | The [DVinci Apply API](https://static.dvinci-easy.com/files/d.vinci%20application-apply-api.html). All requests are authenticated by Kombo and use `https://\{dvinci_domain\}/p/\{portal_path\}/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| d.vinci                      | `dvinci/rest-api`                  | The [DVinci REST API](https://static.dvinci-easy.com/files/d.vinci%20rest-api.html). All requests are authenticated by Kombo and use `https://\{dvinci_domain\}/restApi/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Databites                    | `databites/v1`                     | We use `https://\{subdomain\}.databites.de` as the base URL. Find the official docs [here](https://\{subdomain}.databites.de/api-dokumentationen/public-integrations/index).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| DATEV LODAS                  | `datev/eau`                        | DATEV's [eau](https://developer.datev.de/en/product-detail/eau-api/1.0.0/overview) API. We automatically authenticate all requests and use \`[https://eau.api.datev.de/\\\{platform](https://eau.api.datev.de/\\\{platform)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | platform-sandbox}/v1/clients/\{client-id}/\` as the base URL. |
| DATEV                        | `datevhr/eau`                      | DATEV's [eau](https://developer.datev.de/en/product-detail/eau-api/1.0.0/overview) API. We automatically authenticate all requests and use \`[https://eau.api.datev.de/\\\{platform](https://eau.api.datev.de/\\\{platform)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | platform-sandbox}/v1/clients/\{client-id}/\` as the base URL. |
| DATEV                        | `datevhr/hr-exports`               | DATEV's [hr-exports](https://developer.datev.de/en/product-detail/hr-exports/1.0.0/overview). We automatically authenticate all requests and use \`[https://hr-exports.api.datev.de/\\\{platform](https://hr-exports.api.datev.de/\\\{platform)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | platform-sandbox}/v1/clients/\{client-id}\` as the base URL.  |
| DATEV                        | `datevhr/hr:payrollreports`        | DATEV's [hr:payrollreports](https://developer.datev.de/en/product-detail/hr-payrollreports/2.0.0/overview) API. We automatically authenticate all requests and use \`[https://hr-payrollreports.api.datev.de/\\\{platform](https://hr-payrollreports.api.datev.de/\\\{platform)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | platform-sandbox}/v1/clients/\{client-id}/\` as the base URL. |
| DATEV                        | `datevlauds/lauds`                 | DATEV's [hr-exchange](https://developer.datev.de/de/product-detail/hr-exchange/1.0.0/overview). We automatically authenticate all requests and use \`[https://hr-exchange.api.datev.de/\\\{platform](https://hr-exchange.api.datev.de/\\\{platform)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | platform-sandbox}/v1/clients/\{client-id}\` as the base URL.  |
| Dayforce                     | `dayforce/V1`                      | [Dayforce's API](https://developers.dayforce.com/Build/Home.aspx). We automatically authenticate all requests and use `\{\{baseUrl\}\}/Api/\{\{clientNamespace\}\}/V1` as the base URL                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Deel                         | `deel/api`                         | Deel's [API](https://developer.deel.com/reference/). We automatically authenticate all requests using the provided credentials and use `https://\{api_domain\}/rest` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                               |
| Digital Recruiters           | `digitalrecruiters/api`            | Cegid Digital Recruiters [Talent Acquisition API](https://cegid-hr-developers.talentsoft.net/docs/tutorial-basics/Talent%20Acquisition/Getting%20Started). We automatically authenticate all requests by replacing `:token` in the request URL with your configured access token and use your configured Digital Recruiters domain as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Docebo                       | `docebo/api`                       | Docebo [API](https://developer.docebo.com). We automatically handle authentication and use `https://\{subdomain\}.docebosaas.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| Eightfold                    | `eightfold/api`                    | Eightfold's [API](https://apidocs.eightfold.ai/). We automatically authenticate all requests and use  `https://apiv2.\{region\}/api/v2/core/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Employment Hero              | `employmenthero/default`           | EmploymentHero [API](https://developer.employmenthero.com/api-references/#icon-book-open-introduction). We automatically authenticate all requests using the credentials supplied by the customer and use `https://api.employmenthero.com/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Eploy                        | `eploy/api`                        | Eploy's [API](https://www.eploy.com/resources/developers/api-documentation/). We automatically authenticate all requests. The base URL is `https://\{hostname\}/api`, where `\{hostname\}` is either `\{subdomain\}.eploy.net` or your full custom hostname when applicable.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| eRecruiter                   | `erecruiter/api`                   | [eRecruiter's API](https://api.erecruiter.net/swagger/ui/index). We automatically authenticate all requests and use `https://\{domain\}/Api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Eurécia                      | `eurecia/api`                      | Eurécia [REST API](https://api.eurecia.com/eurecia/fw/swagger/index.html#/) We automatically authenticate all requests and use `https://\{domain\}/eurecia/rest` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| Factorial                    | `factorial/api`                    | Factorial's [API](https://apidoc.factorialhr.com/). We automatically authenticate all requests and use `https://api.factorialhr.com/api` or `https://api.demo.factorial.dev/api` as the base URL, depending on the connected instance.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Flatchr                      | `flatchr/api`                      | Flatchr's [API](https://developers.flatchr.io/docs/getting_started). We automatically authenticate all requests and use `https://api.flatchr.io` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| Flatchr                      | `flatchr/career`                   | Flatchr's [Career API](https://developers.flatchr.io/docs/QuickStart/Candidats/Creer_un_candidat). We automatically authenticate all requests and use `https://career.flatchr.io` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| Fountain                     | `fountain/v2`                      | Fountain's [Hire API](https://developer.fountain.com/reference/get_v2-applicants). We automatically authenticate all requests. The base URL depends on how the integration is connected: Fountain One (OAuth) requests go to `https://services.fountain.com/api/servicehire/v2`, while legacy API-key requests go to `https://\{subdomain\}.fountain.com/api/v2`.                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| Fourth                       | `fourth/uk-employee`               | Fourth [UK Employee API](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference) We automatically authenticate all requests and use `https://api.fourth.com/hr/organisations/\{organisation_id\}/` as the base URL. We also enforce the required query params for all requests.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Gem                          | `gem/api`                          | Gem's [ATS API](https://api.gem.com/ats/v0/reference) We automatically authenticate all requests and use `https://api.gem.com/ats/v0` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Google Workspace             | `googleworkspace/admin`            | [Googles's API](https://developers.google.com/admin-sdk/directory/reference/rest). We automatically authenticate all requests and use '[https://admin.googleapis.com](https://admin.googleapis.com)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                               |
| Google Workspace             | `googleworkspace/people`           | [Googles's API](https://developers.google.com/people/api/rest). We automatically authenticate all requests and use '[https://people.googleapis.com](https://people.googleapis.com)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Greenhouse (V1)              | `greenhouse/harvest-v2`            | Greenhouse [Harvest API v2](https://developers.greenhouse.io/harvest.html). We automatically authenticate all requests using the API key and use `https://harvest.greenhouse.io/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Greenhouse (V1)              | `greenhouse/harvest`               | Greenhouse [Harvest API v1](https://developers.greenhouse.io/harvest.html). We automatically authenticate all requests using the API key and use `https://harvest.greenhouse.io/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Greenhouse (V3)              | `greenhousev3/harvestv3`           | We use `https://harvest.greenhouse.io/v3` as the base URL. Find the official docs [here](https://harvestdocs.greenhouse.io/reference/).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Greenhouse Job Board         | `greenhousejobboard/boards-api`    | [Greenhouse Job Board API](https://developers.greenhouse.io/job-board). We automatically authenticate all requests and use '[https://boards-api.greenhouse.io/v1/boards/\\\{job\_board\_token\\}](https://boards-api.greenhouse.io/v1/boards/\\\{job_board_token\\})' as the base URL. Optionally, you can provide a custom job\_board\_token to use a different job board.                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Greenhouse                   | `greenhouse/harvest-v2`            | Greenhouse [Harvest API v2](https://developers.greenhouse.io/harvest.html). We automatically authenticate all requests using the API key and use `https://harvest.greenhouse.io/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Greenhouse                   | `greenhouse/harvest`               | Greenhouse [Harvest API v1](https://developers.greenhouse.io/harvest.html). We automatically authenticate all requests using the API key and use `https://harvest.greenhouse.io/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Greenhouse                   | `greenhouse/harvestv3`             | We use `https://harvest.greenhouse.io/v3` as the base URL. Find the official docs [here](https://harvestdocs.greenhouse.io/reference/).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| GuideCom                     | `guidecom/api`                     | GuideCom's API. We automatically authenticate all requests and use the configured API base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Gusto                        | `gusto/v1`                         | [Gusto API](https://docs.gusto.com/app-integrations/docs/introduction). We automatically authenticate all requests with OAuth and use `\{api_base_url\}/v1` as the base URL (`https://api.gusto.com/v1` in production, `https://api.gusto-demo.com/v1` in development).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Hailey HR                    | `haileyhr/api`                     | Hailey HR's [API](https://api.haileyhr.app/docs/index.html). We automatically authenticate all requests using the provided credentials and use `https://api.haileyhr.app` as the base URL. Connections created against the `DEMO` remote environment are routed to `https://api.demo.haileyhr.app` instead.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Hansalog                     | `hansalog/vision`                  | Hansalog's [Vision API](https://hansalog-vision.document360.io/docs/). We automatically authenticate all requests and use `https://\{subdomain\}.hansalog-cloud.de/vision` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Haufe Umantis                | `umantis/v1`                       | [Umantis API v1](https://recruitingapp-91005709.umantis.com/api/v1/swagger-ui). We automatically authenticate all requests and use `https://\{subdomain\}.umantis.com/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| HeavenHR                     | `heavenhr/v2`                      | [HeavenHR API](https://api.heavenhr.com/). We automatically authenticate all requests using the provided credentials and use `https://api.heavenhr.com/api/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Heyrecruit                   | `heyrecruit/v2`                    | [Heyrecruit's v2 API](https://documenter.getpostman.com/view/23241256/2s9YysBLcf#47e271ac-47c8-4c75-9cc6-b8c506e9dad6). We automatically authenticate all requests using the client ID and secret and use `https://app.heyrecruit.de/api/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| HiBob                        | `hibob/docs`                       | This passthrough is only used for fetching employee documents in HiBob. It is present as a workaround while we are working on a new endpoint for fetching documents in HRIS. It should not be used for any other purpose. We automatically authenticate all requests using the service user credentials and use `https://app.hibob.com/api/docs/employees/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| HiBob                        | `hibob/hire`                       | [HiBob's Hire API](https://apidocs.hibob.com/docs/how-to-integrate-with-ats-hire-api). We automatically authenticate all requests using the hire service user credentials. The base URL is configured during the integration setup.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| HiBob                        | `hibob/v1`                         | [HiBob's v1 API](https://apidocs.hibob.com/reference/get_people). We automatically authenticate all requests using the service user credentials (or, for old integrations, the API key) and use `https://api.hibob.com/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| HoorayHR                     | `hoorayhr/api`                     | [HoorayHR API](https://api.hoorayhr.io/documentation/). We automatically authenticate all requests and use `https://api.hoorayhr.io` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                               |
| HR Office                    | `hroffice/soap`                    | [HROffice SOAP API](https://api.hroffice.nl/HROfficeCoreService.asmx). We automatically authenticate all requests and wrap them in a SOAP envelope. Build the request `Body` with the raw XML parameters for your operation (e.g., `\<languageId\>1\</languageId\>`). Use `/` as your `path`. Set your `method` to `POST`. You need to specify the `api_options` object and set `operation_name` to the SOAP operation you want to call (e.g., `GetAllJobByLanguage`).                                                                                                                                                                                                                                                                                                                                              |                                                               |
| HR WORKS                     | `hrworks/v2`                       | HRWorks's v2 [API](https://developers.hrworks.de/2.0/endpoints). We automatically authenticate all requests using the customer credentials.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| HR4YOU                       | `hr4you/v2`                        | [HR4YOU's v2 API](https://apiprodemo.hr4you.org/api2/docs). We automatically authenticate all requests and use the customers provided base URL (e.g. `https://your-company.hr4you.org/` or a custom domain).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Humaans                      | `humaans/api`                      | Humaans' [API](https://docs.humaans.io/api/). We automatically authenticate all requests using the API key and use `https://app.humaans.io/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| iCIMS                        | `icims/default`                    | [iCIMS Default API](https://developer-community.icims.com/). We automatically authenticate all requests and use `https://api.icims.com/customers/\{customer_id\}` as the base url.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| InRecruiting by Zucchetti    | `inrecruiting/default`             | [inRecruiting's v3 API](https://inrecruiting.intervieweb.it/api-docs/). We automatically authenticate all requests and use the customers domain as base URL                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Insperity                    | `insperity/api`                    | Insperity [APIs](https://developer.insperity.com/) We automatically authenticate all requests and use `https://api.insperity.com` as the base URL. For staging environments, we use `https://apistage.insperity.com`. Note that all requests require the company ID to be specified in the path or body.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| IRIS Cascade                 | `iriscascade/v2`                   | IRIS Cascade HR [API](https://swagger.hrapi.co.uk/). We automatically authenticate all requests using the provided credentials and use `https://api.iris.co.uk/hr/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| JazzHR                       | `jazzhr/v1`                        | [JazzHR's v1 API](https://www.resumatorapi.com/v1/#!`).We automatically authenticate all requests and use "[https://api.resumatorapi.com/v1/](https://api.resumatorapi.com/v1/)" as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| JobAdder                     | `jobadder/api`                     | We use `https://api.jobadder.com/v2` as the base URL. Find the official docs [here](https://api.jobadder.com/v2/docs).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| JobDiva                      | `jobdiva/api`                      | We automatically authenticate all requests and use `https://api.jobdiva.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Jobvite                      | `jobvite/api`                      | We automatically authenticate all requests and use '[https://api.jobvite.com/api/v2](https://api.jobvite.com/api/v2)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Jobvite                      | `jobvite/v2`                       | We use `https://api.jobvite.com/api/v2` as the base URL. Find the official docs [here](https://help.jobvite.com/hc/en-us/articles/8870636608925-Jobvite-API).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Jobylon                      | `jobylon/feed`                     | The [Jobylon Feed API](https://developer.jobylon.com/feed-api/). We automatically authenticate all requests and use `https://\{subdomain\}.jobylon.com/feeds/\{job_hash\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Jobylon                      | `jobylon/push`                     | The [Jobylon Push API](https://developer.jobylon.com/push-api-and-webhooks/). We automatically authenticate all requests and use `https://\{subdomain\}.jobylon.com/p1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| JOIN                         | `join/v2`                          | Join's [V2 API](https://docs.join.com/reference/getting-started). We automatically authenticate all requests and use `https://api.join.com/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Kenjo                        | `kenjo/api`                        | Kenjo's [API](https://kenjo.readme.io/reference/generate-the-api-key). We automatically authenticate all requests using the API key. The base URL is `https://api.kenjo.io/` (or `https://sandbox-api.kenjo.io/` for sandbox environments).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Kula                         | `kula/v1`                          | Kula's [REST API](https://developers.kula.ai/docs/getting-started/overview). We automatically authenticate all requests with the provided credentials and use `https://api.kula.ai/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Lattice Talent               | `latticetalent/talent`             | Lattice's [Talent API](https://developers.lattice.com/reference/introduction). We automatically authenticate all requests using API key credentials with `https://api.latticehq.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                               |
| Lattice                      | `lattice/passthrough`              | Lattice's [API](https://developers.lattice.com/v2/docs/base-url-1). We automatically authenticate all requests using OAuth credentials with `https://api.latticehq.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Lattice                      | `lattice/talent`                   | Lattice's [Talent API](https://developers.lattice.com/docs/introduction-1). We automatically authenticate all requests using OAuth credentials with `https://api.latticehq.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| Laura                        | `laura/api`                        | We automatically authenticate all requests and use `https://\{subdomain\}.rekrytointi.com/api/v1.2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Leapsome                     | `leapsome/scim`                    | Leapsome [SCIM API](https://api.leapsome.com/scim/v1/api-docs/). We automatically authenticate all requests using the credentials supplied by the customer and use `https://api.leapsome.com/scim/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Leapsome                     | `leapsome/v1`                      | Leapsome [API](https://api.leapsome.com/v1/api-docs/). We automatically authenticate all requests using the credentials supplied by the customer and use `https://api.leapsome.com/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Lever                        | `lever/v1`                         | [Lever's v1 API](https://hire.lever.co/developer/documentation). We automatically authenticate all requests using the partner credentials which have been configured in the Lever tool settings (this uses Kombo's partner credentials by default).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| LinkedIn Learning            | `linkedinlearning/v2`              | LinkedIn Learning [API v2](https://learn.microsoft.com/en-us/linkedin/learning/).  We automatically handle authentication and use `https://api.linkedin.com/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| Logic Melon                  | `logicmelon/json`                  | We use `https://api.logicmelon.co.uk` as the base URL. Find the official docs [here](https://api.logicmelon.com/JSON/Multiposter.asmx).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Loket                        | `loket/api`                        | [Loket's REST API](https://developers.loket.nl/). We automatically authenticate all requests and use `https://\{api_domain\}` as the base URL, where `api_domain` is the API domain configured during integration setup (e.g. `api.loket.nl`).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Loxo                         | `loxo/v1`                          | [Loxo's API](https://loxo.readme.io/reference/loxo-api). We automatically authenticate all requests and use '[https://app.loxo.co/api/\\\{agency\_slug\\}](https://app.loxo.co/api/\\\{agency_slug\\})' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Lucca                        | `lucca/api`                        | [Luccas's API](https://developers.lucca.fr/api-reference/legacy/introduction). We automatically authenticate all requests and use 'https\://\{account}.\{ilucca                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | ilucca-demo}.\{region}/' as the base URL.                     |
| Manatal                      | `manatal/career-page`              | Manatal's Career Page API. We use `https://api.manatal.com/open/v3/career-page/\{client_slug\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| Manatal                      | `manatal/open-api-v3`              | [Manatal's Open API v3](https://developers.manatal.com/reference/getting-started). We automatically authenticate all requests and use `https://api.manatal.com/open/v3` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Mercury                      | `mercury/v1`                       | Mercury's [V1 API](https://apim-uks-thirdpartyintegration-prod.azure-api.net/swagger/index.html?urls.primaryName=V1). We automatically authenticate all requests with the `subscription-key` and `tenant-id` headers and use the configured server URL with `/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Mercury                      | `mercury/v2`                       | Mercury's [V2 API](https://apim-uks-thirdpartyintegration-prod.azure-api.net/swagger/index.html?urls.primaryName=V2). We automatically authenticate all requests with the `subscription-key` and `tenant-id` headers and use the configured server URL with `/api/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Mercury                      | `mercury/v3`                       | Mercury's [V3 API](https://apim-uks-thirdpartyintegration-prod.azure-api.net/swagger/index.html?urls.primaryName=V3). We automatically authenticate all requests with the `subscription-key` and `tenant-id` headers and use the configured server URL with `/api/v3` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| MHR People First             | `peoplefirst/v1`                   | MHR People First [v1 API](https://docs.people-first.com/api/api-docs/api-docs.html). We automatically authenticate all requests using the access token and tenant/environment codes. For default environments, we use `https://\{tenant_code\}.people-first.com/api/v1` as the base URL. For non-default environments, we use `https://\{tenant_code\}-\{environment_code\}.people-first.com/api/v1`.                                                                                                                                                                                                                                                                                                                                                                                                               |                                                               |
| Microsoft Azure AD           | `azuread/v1`                       | [AzureAD's API](https://learn.microsoft.com/en-us/graph/api/resources/identity-network-access-overview?view=graph-rest-1.0). We automatically authenticate all requests.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Microsoft Entra ID           | `entraid/v1`                       | [AzureAD's API](https://learn.microsoft.com/en-us/graph/api/resources/identity-network-access-overview?view=graph-rest-1.0). We automatically authenticate all requests.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Moodle                       | `moodle/rest`                      | Moodle REST Web Services API. All calls go to `/webservice/rest/server.php` with `wsfunction` and `wstoken` parameters. We automatically handle authentication and use `\{site_url\}/webservice/rest/server.php` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| Mysolution                   | `mysolution/default`               | [Mysolution's API](https://swagger.mysolution.nl/). We automatically authenticate all requests and use the customer's domain as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Nmbrs                        | `nmbrs/soap`                       | [Nmbrs SOAP API](https://api.nmbrs.nl/soap/v3/). We automatically authenticate all requests and use `https://api.nmbrs.nl/soap/v3/` as the base URL. Set `data` to your raw XML string (the content that will be placed inside the `\<soap:Body\>` tag). Use `/` as your `path`, as we will always send requests to `https://api.nmbrs.nl/soap/v3/\{service_name\}.asmx`. Set your `method` to `POST`. You need to specify the `api_options` object and set `service_name` to the name of the service you want to call. Available services include `EmployeeService` and `CompanyService`.                                                                                                                                                                                                                          |                                                               |
| Odoo                         | `odoo/json2`                       | Odoo's [JSON-2 API](https://www.odoo.com/documentation/19.0/developer/reference/external_api.html). We automatically authenticate all requests and use `https://\{domain\}.odoo.com/json/2` as the base URL. Odoo JSON-2 requests are always `POST` requests and use paths like `/\{model\}/\{method\}` (e.g. `/res.partner/search_read`).                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Okta                         | `okta/v1`                          | [Okta's API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/ApiServiceIntegrations/). We automatically authenticate all request ans use 'https\://\<your-okta-domain>/api/v1' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Onlyfy                       | `onlyfy/v1`                        | Onlyfy's [Public v1 REST API](https://onlyfy.io/doc/v1#section/Introduction). We automatically authenticate all requests using the `apikey` header and use `https://api.prescreenapp.io/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Oracle HCM                   | `oraclehcm/api`                    | Oracle HCM Cloud [REST API](https://docs.oracle.com/en/cloud/saas/human-resources/24d/farws/index.html). We automatically authenticate all requests and use `https://\{domain\}/` as the base URL, where domain is your Oracle Cloud domain.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Oracle Recruiting Cloud      | `oraclerecruiting/rest`            | [Oracle's REST API](https://docs.oracle.com/en/cloud/saas/human-resources/24d/farws/rest-endpoints.html). We automatically authenticate all requests and use 'https\://\{company\_url}' as the base url.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Oracle Recruiting Cloud      | `oraclerecruiting/rest`            | [Oracles's REST API](https://docs.oracle.com/en/cloud/saas/human-resources/24d/farws/rest-endpoints.html). We automatically authenticate all requests and use 'https\://\{company\_url}' as the base url.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Oracle Taleo                 | `taleo/soap`                       | [Taleo's API](https://docs.oracle.com/en/cloud/saas/taleo-enterprise/23b/otwsu/c-taleoapi.html). We automatically authenticate all requests and use 'https\://\{your-subdomain}.taleo.net/enterprise/soap' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| OTYS                         | `otys/json-rpc`                    | [OTYS JSON-RPC API](https://ows.otys.nl/info/). We authenticate with your stored API key and inject the session token as the first element of the JSON-RPC `params` array on each request (except `loginByUid`, which uses `params` as sent). Requests use `https://ows.otys.nl` as the base URL (for example `POST /jservice.php` with the RPC method in the URL fragment, matching OTYS conventions).                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| PageUp People                | `pageup/v1`                        | We use `https://assessment-mock-api.dc0.pageuppeople.com` as the base URL. Find the official docs [here](https://developers.pageuppeople.com/Api/Partners/Assessment).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| PageUp People                | `pageup/v3`                        | We use `https://\<environment\>.\<dataCentreId\>.pageuppeople.com/v3/\<tenantId\>/recruitment` as the base URL. Find the official docs [here](https://developers.pageuppeople.com/Api/Recruitment).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Paradox                      | `paradox/v1`                       | We use `\{api_url\}/api/v1` as the base URL. Find the official docs [here](https://paradox.readme.io/).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Paradox                      | `paradox/v1public`                 | We use `\{api_url\}/api/v1/public` as the base URL. Find the official docs [here](https://paradox.readme.io/).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Paychex                      | `paychex/api`                      | Paychex [REST API](https://developer.paychex.com/documentation). We automatically authenticate all requests and use `https://api.paychex.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Paycom                       | `paycom/v1`                        | Paycom's REST API. We automatically authenticate all requests using the provided SID and API Token and use `https://api.paycomonline.net/v4/rest/index.php/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Paycor                       | `paycor/v1`                        | [Paycors's v1 API](https://developers.paycor.com/explore#section/Getting-Started). We automatically authenticate all requests and use '[https://apis.paycor.com](https://apis.paycor.com)'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| PayFit                       | `payfitcustomer/api`               | PayFit [Partner API](https://developers.payfit.io/reference). We automatically authenticate all requests using the provided API key and use `https://partner-api.payfit.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| PayFit                       | `payfitpartner/partner-api`        | PayFit [Partner API](https://developers.payfit.io/reference). We automatically authenticate all requests using the OAuth access token and use `https://partner-api.payfit.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Paylocity                    | `paylocity/default`                | [Paylocity's Weblink API](https://developer.paylocity.com/integrations/reference/authentication-weblink). We automatically authenticate all requests and use 'https\://\{api                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | dc1demogw}.paylocity.com/' as the base URL.                   |
| Paylocity                    | `paylocity/next-gen`               | [Paylocity's NextGen API](https://developer.paylocity.com/integrations/reference/authentication). We automatically authenticate all requests and use '[https://dc1prodgwext.paylocity.com/](https://dc1prodgwext.paylocity.com/)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| PeopleHR                     | `peoplehr/default`                 | [PeopleHR's API](https://apidocs.peoplehr.com/#). We automatically authenticate all request ans use '[https://api.peoplehr.net](https://api.peoplehr.net)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| PeopleXD                     | `peoplexd/b2b`                     | PeopleXD's [B2B API](https://documenter.getpostman.com/view/3101638/TzeTHUDu#intro). We automatically authenticate all requests and use `https://api.corehr.com/ws/\{tenant_id\}/corehr` or `https://uatapi.corehr.com/ws/\{tenant_id\}/corehr` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| Personio                     | `personio/jobboard`                | API endpoints exposed on Personio's public job board pages ([currently just the XML feed](https://developer.personio.de/reference/get_xml)). We automatically use the right `https://\{company\}.jobs.personio.de` base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Personio                     | `personio/personnel`               | Personio's [Personnel Data API](https://developer.personio.de/reference/get_company-employees). We automatically authenticate all requests using the client ID and secret and use `https://api.personio.de/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Personio                     | `personio/personnelv2`             | Personio's [V2 Personnel Data API](https://developer.personio.de/v2.0/reference/introduction). We automatically authenticate all requests using the client ID and secret and use `https://api.personio.de/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Personio                     | `personio/recruiting`              | Personio's [Recruiting API](https://developer.personio.de/reference/get_company-employees). We automatically authenticate all requests using the Recruiting access token and use `https://api.personio.de/v1/recruiting` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Personio                     | `personio/recruitingV2`            | Personio's [V2 Recruiting API](https://developer.personio.de/reference/get_v2-recruiting-applications). We automatically authenticate all requests using the Recruiting access token, send the `Beta` header and use `https://api.personio.de/v2/recruiting` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Phenom                       | `phenom/rest-api`                  | The [Phenom API](https://developer.phenom.com/). We automatically authenticate all requests and use `https://api-stg.phenompro.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Pinpoint                     | `pinpoint/v1`                      | Pinpoint's [JSON:API](https://developers.pinpointhq.com/docs). We automatically authenticate all requests using the `X-API-KEY` header and use `https://\{subdomain\}.pinpointhq.com/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Planday                      | `planday/api`                      | Planday's [HR API v1.0](https://openapi.planday.com/api/hr?version=v1.0). We automatically authenticate all requests and use `https://openapi.planday.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Recruit CRM                  | `recruitcrm/api`                   | We use `https://api.recruitcrm.io` as the base URL. Find the official docs [here](https://docs.recruitcrm.io/docs/rcrm-api-reference/ZG9jOjMyNzk0NA-getting-started).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                               |
| RecruiterFlow                | `recruiterflow/v1`                 | RecruiterFlow API [docs](https://docs.recruiterflow.com/). We automatically authenticate all requests using the RF-Api-Key header and use `https://api.recruiterflow.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Remote                       | `remotecom/default`                | Remote's [API](https://remote.com/resources/api/getting-started). We automatically authenticate all requests using provided credentials. The base URL is `https://gateway.remote.com/v1` for production API keys (prefixed `ra_live_`), or `https://gateway.remote-sandbox.com/v1` for sandbox API keys.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| rexx systems                 | `rexx/default`                     | Rexx's HRIS export API. There is only one endpoint: `Get /`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Rippling                     | `rippling/api`                     | Rippling's [API](https://developer.rippling.com/documentation). We automatically authenticate all requests and use `https://api.rippling.com/platform/api` or`https://rest.ripplingapis.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Sage HR                      | `sagehr/api`                       | Sage HR's [API](https://developer.sage.com/hr/reference/api-ref). We automatically authenticate all requests and use `https://\{subdomain\}.sage.hr/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Sage People                  | `sagepeople/salesforce-rest-api`   | Sage People is built on Salesforce's [API](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_what_is_rest_api.htm). We automatically authenticate all requests and use `https://\{customer_name\}.my.salesforce.com/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| SAP SuccessFactors           | `successfactors/lms-odata-v4`      | We use `https://\{api_domain\}/learning/odatav4` as the base URL. Find the official docs [here](https://help.sap.com/docs/successfactors-learning/sap-successfactors-learning-odata-apis).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| SAP SuccessFactors           | `successfactors/odata-v2`          | [SuccessFactors' OData V2 API](https://help.sap.com/doc/74597e67f54d4f448252bad4c2b601c9/2211/en-US/SF_HCM_OData_API_REF_en.pdf). We automatically authenticate all requests and use `https://\{api_domain\}\{path?\}/odata/v2` as the base URL (the optional `\{path\}` is used when connecting via proxied/gateway domains).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| SD Worx                      | `sdworx/default`                   | SD Worx's [OData API](https://apistaging.cobra.sdworx.com/Resources). We automatically authenticate all requests using the client ID and secret and use `\{api_url\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Silae                        | `silae/rest`                       | [Silae's REST API](https://silae-api.document360.io/docs). We automatically authenticate all requests and use '[https://payroll-api.silae.fr/payroll](https://payroll-api.silae.fr/payroll)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Simployer                    | `simployer/v1`                     | [AlexisHR's v1 API](https://docs.alexishr.com/) We automatically authenticate all requests and use `https://\{subdomain\}.alexishr.com` as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| SmartRecruiters              | `smartrecruiters/default`          | Smartrecruiters [API](https://developers.smartrecruiters.com/reference/apply-api). We automatically authenticate all requests using OAuth and use `https://api.smartrecruiters.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| SmartRecruiters              | `smartrecruiters/default`          | Smartrecruiters [API](https://developers.smartrecruiters.com/reference/apply-api). We automatically authenticate all requests using the credentials supplied by the customer and use `https://api.smartrecruiters.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Softgarden                   | `softgarden/apply-api`             | [Softgarden's Apply API](https://dev.softgarden.de/apply-api/). We automatically authenticate all requests and use '[https://jobdb.softgarden.de/jobdb/public](https://jobdb.softgarden.de/jobdb/public)' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Softgarden                   | `softgarden/frontend-v3`           | \[Softgarden's Frontend API v3]\([https://dev.softgarden.de/frontend-v3/](https://dev.softgarden.de/frontend-v3/). We automatically authenticate all requests and use '[https://api.softgarden.io/api/rest](https://api.softgarden.io/api/rest)' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Spark Hire Recruit           | `comeet/api`                       | [Spark Hire Recruit's API.](https://developers.comeet.com/reference/recruiting-api-overview)We automatically authenticate all requests and use `https://api.comeet.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Spott                        | `spott/protected`                  | The [Spott API](https://docs.gospott.com). We automatically authenticate all requests and use `https://api.gospott.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Sympa                        | `sympa/api`                        | Sympa's [API](https://documenter.getpostman.com/view/33639379/2sA3kXG1vX#intro). We automatically authenticate all requests and use `https://api.sympahr.net/api/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Taleez                       | `taleez/0`                         | [Taleez's API](https://api.taleez.com/swagger-ui/index.html). We automatically authenticate all requests and use `https://api.taleez.com/0` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Talention                    | `talention/v1`                     | Talention's API. We automatically authenticate all requests and use `https://\{api_domain\}/tms/\{account_id\}/external/api/1.0` as the base URL. Documentation is provided privately by Talention. Contact Kombo support for assistance with specific endpoints.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| TalentLMS                    | `talentlms/v2`                     | We use `https://\{subdomain\}.talentlms.com/api/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Teamtailor Job Boards        | `teamtailorjobboards/direct-apply` | Teamtailor's [Job Board Direct Apply API](https://partner.teamtailor.com/job_boards/direct_apply/#direct-apply). We automatically authenticate all requests and use `https://5qbn6o9x4h.execute-api.eu-west-1.amazonaws.com/production` as the base URL. All requests are automatically signed with HMAC-SHA256 signature.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Teamtailor                   | `teamtailor/v1`                    | We use `https://api.teamtailor.com/v1` as the base URL. Find the official docs [here](https://docs.teamtailor.com/).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Tellent Recruitee            | `recruitee/default`                | The [Recruitee API](https://api.recruitee.com/docs/index.html). We automatically authenticate all requests and use `https://api.recruitee.com/c/\{company_id\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| Tellent Recruitee            | `recruitee/v1`                     | We use `https://api.recruitee.com/c/\{company_id\}` as the base URL. Find the official docs [here](https://docs.recruitee.com/reference).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| TrackerRMS                   | `trackerrms/v1`                    | We use `https://evousapi.tracker-rms.com` as the base URL. Find the official docs [here](https://evousapi.tracker-rms.com/swagger/index.html).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| TRAFFIT                      | `traffit/v2`                       | Traffit's [v2 API](https://api.traffit.com). We authenticate all requests with the Traffit API key and use the base URL `https://yourdomain.traffit.com/api/integration/v2`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| TriNet PEO                   | `trinetpeo/v1`                     | We use `https://api.trinet.com` as the base URL. Find the official docs [here](https://developers.trinet.com).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Ubeeo                        | `ubeeo/api`                        | Ubeeo ATS API. We automatically authenticate all requests using OAuth client credentials and use `https://api.ats-platform.com` as the base URL (sandbox: `https://api.acc.ats-platform.com`).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Udemy Business               | `udemy/learning`                   | Udemy Business REST API. We automatically handle authentication and use `https://\{account_name\}.udemy.com/api-2.0/organizations/\{account_id\}/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| UKG Pro WFM                  | `ukgprowfm/api`                    | UKG Pro WFM's [API](https://developer.ukg.com/wfm/reference/welcome-to-the-ukg-pro-workforce-management-api). We automatically authenticate all requests and use `https://\{hostname\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| UKG Pro                      | `ukgpro/default`                   | [UKG Pro's HRIS API](https://developer.ukg.com/hcm/reference/get_personnel-v1-person-details). We automatically authenticate all requests and use  `https://\{hostname\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| UKG Pro                      | `ukgpro/recruting`                 | [UKG Pro's Recruiting API](https://developer.ukg.com/hcm/reference/retrieveapplications). We automatically authenticate all requests and use  `https://\{hostname\}/talent/recruiting/v2/\{tenantalias\}/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| UKG Ready                    | `ukgready/api`                     | UKG Ready [API](https://secure.saashr.com/ta/docs/rest/public/). We automatically authenticate all requests using the provided credentials and use `https://\{api_domain\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Visma Peple                  | `peple/hrm`                        | [Visma Payroll Reporting API](https://api.analytics1.hrm.visma.net/docs/openapi.html). We automatically authenticate all requests using the client credentials and use '[https://api.analytics1.hrm.visma.net](https://api.analytics1.hrm.visma.net)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Visma Raet - Youforce        | `youforce/v1.0`                    | [Youforce's basic v1.0 API](https://vr-api-integration.github.io/youforce-api-documentation/postman_collections.html). We automatically authenticate all requests and use '[https://api.youforce.com](https://api.youforce.com)' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Visma YouServe               | `youserve/learning`                | Visma YouServe [Learning API](https://youserve-domain-api.github.io/SwaggerUI/learning.html). We automatically authenticate all requests using OAuth 2.0 with the provided credentials and use `https://api.youserve.nl/learning/v1.0` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Workable                     | `workable/v1`                      | **Deprecated: Use `v3` instead.** Workable's [API](https://workable.readme.io/reference/generate-an-access-token). We automatically authenticate all requests using the client ID and secret and use `https://\{subdomain\}.\{environment\}.com/spi/v3` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Workable                     | `workable/v3`                      | Workable's [API](https://workable.readme.io/reference/generate-an-access-token). We automatically authenticate all requests using the client ID and secret and use `https://\{subdomain\}.\{environment\}.com/spi/v3` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Workday                      | `workday/custom-report`            | [Workday's Custom Reports](https://community.workday.com/sites/default/files/file-hosting/productionapi/index.html). We automatically authenticate all requests and use `https://\{domain\}/ccx/service/customreport2/\{tenant\}/` as the base URL. Set your `method` to `GET`. The `path` should be the report path after the tenant, e.g., `/\{report_owner\}/\{report_name\}`. You can include query parameters in the `params` object (e.g., `format=json`).                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| Workday                      | `workday/rest`                     | [Workday's REST API](https://community.workday.com/sites/default/files/file-hosting/restapi/index.html). We automatically authenticate all requests and use the correct Workday REST base URL for your tenant. The base URL follows the format: https\://\{domain}/api/\{service\_name}/\{version}/\{tenant}. You can specify any valid REST endpoint and method. See the Workday REST API documentation for available endpoints. You must specify the `api_options` object and set `service_name` to the name of the service you want to call. You can also specify the `version` (e.g., "v1", "v2"); if omitted, it defaults to "v1".                                                                                                                                                                             |                                                               |
| Workday                      | `workday/soap`                     | [Workday's SOAP API](https://community.workday.com/sites/default/files/file-hosting/productionapi/index.html). We automatically authenticate all requests. Set `data` to your raw xml string. Use `/` as your `path`, as we will always send requests to `https://\{domain\}/ccx/service/\{tenant\}/\{service_name\}`. Set your `method` to `POST`. You need to specify the `api_options` object and set `service_name` to the name of the service you want to call. Find all available services [here](https://community.workday.com/sites/default/files/file-hosting/productionapi/versions/v41.0/index.html). The string that you submit as `data` will be the content of the `soapenv:Body` tag in the request. You can set the `service_version` to any valid Workday service version (the default is `38.2`). |                                                               |
| workforce.com                | `workforcecom/api`                 | Workforce.com [API](https://my.workforce.com/api/v2/documentation). We automatically authenticate all requests using the provided credentials and use `https://my.tanda.co` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Zelt                         | `zelt/partner`                     | Zelt's [Partner API](https://go.zelt.app/apiv2/swagger). We automatically authenticate all requests using the connected OAuth credentials and use `https://go.zelt.app/apiv2/partner` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Zoho Recruit                 | `zohorecruit/v2`                   | Zoho Recruit's [V2 API](https://www.zoho.com/recruit/developer-guide/apiv2/modules-api.html). We automatically authenticate all requests and use `https://recruit.\{domain\}/recruit/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Zvoove Recruit               | `zvooverecruit/applicants`         | [Zvoove Recruit's Applicants API](https://api.zvoove.com/docs/). We automatically authenticate all requests using the applicants API key and use 'https\://\{domain}/api/public' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Zvoove Recruit               | `zvooverecruit/jobs`               | [Zvoove Recruit's Jobs API](https://api.zvoove.com/docs/). We automatically authenticate all requests using the jobs API key and use 'https\://\{domain}/api/public' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |

<Note>Please note that the passthrough API endpoints are only meant for edge cases. That's why we only expose them for new integrations after understanding a concrete customer use case. If you have such a use case in mind, please reach out to Kombo.</Note>


# Set integration enabled
Source: https://docs.kombo.dev/assessment/v1/put-integrations-integration-id-enabled

PUT /integrations/{integration_id}/enabled
Enable or disable the specified integration. When disabling, all currently running syncs will be cancelled.

All authentication credentials and configuration are preserved. Syncs can be resumed by re-enabling the integration.

You may use this to, for example, pause syncing for customers that are temporarily not using the integration.


# Update order result
Source: https://docs.kombo.dev/assessment/v1/put-orders-assessment-order-id-result

PUT /assessment/orders/{assessment_order_id}/result
Updates an assessment or a background check order result.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/assessment/connectors/workday">Workday</a></li>
    <li><img /><a href="/assessment/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/assessment/connectors/smartrecruiters">SmartRecruiters</a></li>
    <li><img /><a href="/assessment/connectors/oraclerecruiting">Oracle Recruiting Cloud</a></li>
    <li><img /><a href="/assessment/connectors/lever">Lever</a></li>
    <li><img /><a href="/assessment/connectors/icims">iCIMS</a></li>
    <li><img /><a href="/assessment/connectors/recruitee">Tellent Recruitee</a></li>
    <li><img /><a href="/assessment/connectors/greenhouse">Greenhouse</a></li>
    <li><img /><a href="/assessment/connectors/teamtailor">Teamtailor</a></li>
    <li><img /><a href="/assessment/connectors/ashby">Ashby</a></li>
    <li><img /><a href="/assessment/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/assessment/connectors/bullhorn">Bullhorn</a></li>
    <li><img /><a href="/assessment/connectors/jobylon">Jobylon</a></li>
    <li><img /><a href="/assessment/connectors/eightfold">Eightfold</a></li>
    <li><img /><a href="/assessment/connectors/avature">Avature</a></li>
    <li><img /><a href="/assessment/connectors/jazzhr">JazzHR</a></li>
    <li><img /><a href="/assessment/connectors/jobvite">Jobvite</a></li>
    <li><img /><a href="/assessment/connectors/pageup">PageUp People</a></li>
    <li><img /><a href="/assessment/connectors/sandbox">Kombo Sandbox</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

### Example Request Body

```json theme={null}
{
  "status": "COMPLETED",
  "score": 90,
  "max_score": 100,
  "result_url": "https://example.com",
  "completed_at": "2023-04-04T00:00:00.000Z",
  "attributes": [
    {
      "type": "TEXT",
      "label": "Role fit",
      "value": "Excellent"
    },
    {
      "type": "SUB_RESULT",
      "id": "<YOUR_INTERNAL_ID_OF_THE_TEST>",
      "label": "Personality test",
      "score": {
        "value": 97,
        "max": 100
      },
      "status": "COMPLETED"
    }
  ],
  "attachments": [
    {
      "name": "Assessment Report.pdf",
      "data": "SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=",
      "content_type": "application/pdf"
    }
  ]
}
```


# Set packages
Source: https://docs.kombo.dev/assessment/v1/put-packages

PUT /assessment/packages
Set packages

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul />

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Replaces the list of available assessment and or background check packages.

Packages that have been previously submitted through this endpoint but aren't included again will be marked as deleted.

### Example Request Body

```json theme={null}
{
  "packages": [
    {
      "id": "1001",
      "type": "SKILLS_TEST",
      "name": "TypeScript",
      "description": "TypeScript coding skills assessments"
    },
    {
      "id": "1002",
      "type": "VIDEO_INTERVIEW",
      "name": "Video Interview",
      "description": "Video interview to assess communication skills"
    }
  ]
}
```


# assessment:order-received
Source: https://docs.kombo.dev/assessment/webhooks/assessment-order-received

openapi.json webhook assessment:order-received
This event is triggered when a new assessment or background check order is created for a candidate within your customer's ATS.



# Attachment type analysis
Source: https://docs.kombo.dev/ats/attachment-restrictions



This document describes the limitations of attachments for selected integrated ATS tools.

# General

|                                    | **Dvinci** | **Greenhouse** | **Personio** | **Recruitee** | **Smartrecruiters** | **Softgarden** | **Workday** |
| ---------------------------------- | :--------: | :------------: | :----------: | :-----------: | :-----------------: | :------------: | :---------: |
| **Supports CV**                    |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **Supports Cover Letter**          |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **Supports Other Attachment**      |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **Requires CV**                    |      ❌     |        ❌       |       ❌      |       ❌       |          ❌          |        ❌       |      ❌      |
| **Requires Cover Letter**          |      ❌     |        ❌       |       ❌      |       ❌       |          ❌          |        ❌       |      ❌      |
| **Multiple CVs Allowed**           |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **Multiple Cover Letters Allowed** |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |

# Malformed

Below is a list of the content restrictions for each integration. Many tools differentiate between accepted file formats for CVs, cover letters and other attachments.

## CV

|                                      | **Dvinci** | **Greenhouse** | **Personio** | **Recruitee** | **Smartrecruiters** | **Softgarden** | **Workday** |
| ------------------------------------ | :--------: | :------------: | :----------: | :-----------: | :-----------------: | :------------: | :---------: |
| **Empty Files Allowed**              |      ❌     |        ✅       |       ❌      |       ✅       |          ❌          |        ❌       |      ❌      |
| **Malformed Files Allowed**          |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **Wrong Image Type Allowed**         |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ❌       |      ✅      |
| **Wrong Image Content Type Allowed** |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ❌       |      ✅      |
| **Wrong File Type Allowed**          |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ❌       |      ✅      |
| **No File Extension Image Allowed**  |      ✅     |        ✅       |       ❌      |       ✅       |          ✅          |        ❌       |      ❌      |
| **No File Extension PDF Allowed**    |      ✅     |        ✅       |       ❌      |       ✅       |          ✅          |        ❌       |      ❌      |

## Cover Letter

|                                      | **Dvinci** | **Greenhouse** | **Personio** | **Recruitee** | **Smartrecruiters** | **Softgarden** | **Workday** |
| ------------------------------------ | :--------: | :------------: | :----------: | :-----------: | :-----------------: | :------------: | :---------: |
| **Empty Files Allowed**              |      ❌     |        ✅       |       ❌      |       ✅       |          ❌          |        ✅       |      ❌      |
| **Malformed Files Allowed**          |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **Wrong Image Type Allowed**         |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **Wrong Image Content Type Allowed** |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **Wrong File Type Allowed**          |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **No File Extension Image Allowed**  |      ✅     |        ✅       |       ❌      |       ✅       |          ✅          |        ✅       |      ❌      |
| **No File Extension PDF Allowed**    |      ✅     |        ✅       |       ❌      |       ✅       |          ✅          |        ✅       |      ❌      |

## Other Attachments

|                                      | **Dvinci** | **Greenhouse** | **Personio** | **Recruitee** | **Smartrecruiters** | **Softgarden** | **Workday** |
| ------------------------------------ | :--------: | :------------: | :----------: | :-----------: | :-----------------: | :------------: | :---------: |
| **Empty Files Allowed**              |      ❌     |        ✅       |       ❌      |       ✅       |          ❌          |        ✅       |      ❌      |
| **Malformed Files Allowed**          |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **Wrong Image Type Allowed**         |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **Wrong Image Content Type Allowed** |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **Wrong File Type Allowed**          |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **No File Extension Image Allowed**  |      ✅     |        ✅       |       ❌      |       ✅       |          ✅          |        ✅       |      ❌      |
| **No File Extension PDF Allowed**    |      ✅     |        ✅       |       ❌      |       ✅       |          ✅          |        ✅       |      ❌      |

# File Size Limations

|                                                   | **Dvinci** | **Greenhouse** | **Personio** | **Recruitee** | **Smartrecruiters** | **Softgarden** | **Workday** |
| ------------------------------------------------- | :--------: | :------------: | :----------: | :-----------: | :-----------------: | :------------: | :---------: |
| **Max Size CV**                                   |    10 MB   |     > 50 MB    |     20 MB    |    > 50 MB    |        10 MB        |      5 MB      |    25 MB    |
| **Max Size Cover Letter**                         |    10 MB   |     > 50 MB    |     20 MB    |    > 50 MB    |        10 MB        |      5 MB      |    25 MB    |
| **Max Size Other**                                |    10 MB   |     > 50 MB    |     20 MB    |    > 50 MB    |        10 MB        |      5 MB      |    25 MB    |
| **Max Size Combined (tested with 3 attachments)** |    20 MB   |     > 50 MB    |    > 50 MB   |    > 50 MB    |        30 MB        |      5 MB      |   > 50 MB   |
| **Max Attachment Count**                          |    > 10    |      > 10      |     > 10     |      > 10     |         > 10        |      > 10      |     > 10    |

# File Formats

Below is a list of the accepted file formats for each integration. Many tools differentiate between accepted file formats for CVs, cover letters and other attachments.

## CV

|            | **Dvinci** | **Greenhouse** | **Personio** | **Recruitee** | **Smartrecruiters** | **Softgarden** | **Workday** |
| ---------- | :--------: | :------------: | :----------: | :-----------: | :-----------------: | :------------: | :---------: |
| **.csv**   |      ❌     |        ✅       |       ✅      |       ❌       |          ✅          |        ❌       |      ✅      |
| **.doc**   |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **.docx**  |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **.jpeg**  |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ❌       |      ✅      |
| **.pages** |      ❌     |        ❌       |       ❌      |       ❌       |          ✅          |        ❌       |      ❌      |
| **.pdf**   |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **.png**   |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ❌       |      ✅      |
| **.svg**   |      ❌     |        ❌       |       ❌      |       ❌       |          ❌          |        ❌       |      ❌      |
| **.txt**   |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **.xls**   |      ❌     |        ✅       |       ✅      |       ❌       |          ✅          |        ❌       |      ✅      |
| **.xlsx**  |      ❌     |        ✅       |       ✅      |       ❌       |          ✅          |        ❌       |      ✅      |
| **.zip**   |      ❌     |        ✅       |       ✅      |       ❌       |          ❌          |        ❌       |      ✅      |

## Cover Letter

|            | **Dvinci** | **Greenhouse** | **Personio** | **Recruitee** | **Smartrecruiters** | **Softgarden** | **Workday** |
| ---------- | :--------: | :------------: | :----------: | :-----------: | :-----------------: | :------------: | :---------: |
| **.csv**   |      ❌     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **.doc**   |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **.docx**  |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **.jpeg**  |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **.pages** |      ❌     |        ❌       |       ❌      |       ✅       |          ✅          |        ✅       |      ❌      |
| **.pdf**   |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **.png**   |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **.svg**   |      ❌     |        ❌       |       ❌      |       ✅       |          ❌          |        ✅       |      ❌      |
| **.txt**   |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **.xls**   |      ❌     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **.xlsx**  |      ❌     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **.zip**   |      ❌     |        ✅       |       ✅      |       ✅       |          ❌          |        ✅       |      ✅      |

## Other Attachments

|            | **Dvinci** | **Greenhouse** | **Personio** | **Recruitee** | **Smartrecruiters** | **Softgarden** | **Workday** |
| ---------- | :--------: | :------------: | :----------: | :-----------: | :-----------------: | :------------: | :---------: |
| **.csv**   |      ❌     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **.doc**   |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **.docx**  |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **.jpeg**  |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **.pages** |      ❌     |        ❌       |       ❌      |       ✅       |          ✅          |        ✅       |      ❌      |
| **.pdf**   |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **.png**   |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **.svg**   |      ❌     |        ❌       |       ❌      |       ✅       |          ❌          |        ✅       |      ❌      |
| **.txt**   |      ✅     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **.xls**   |      ❌     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **.xlsx**  |      ❌     |        ✅       |       ✅      |       ✅       |          ✅          |        ✅       |      ✅      |
| **.zip**   |      ❌     |        ✅       |       ✅      |       ✅       |          ❌          |        ✅       |      ✅      |


# Connect your Lever ATS
Source: https://docs.kombo.dev/ats/connection-guides/lever



<Note>
  This guide assumes you already have a Kombo account. If that's not the case,
  visit [our website](https://www.kombo.dev/) to learn more and get access.
</Note>

# Set the integration up

1. Log in to the [Kombo Dashboard](https://app.kombo.dev/)
2. Go to the "Integrations" page
3. Click "New integration"

<Frame>![](https://files.readme.io/39959e1-Untitled.png)</Frame>

4. Select "Create the integration yourself":

<Frame>![](https://files.readme.io/070ce09-Untitled1.png)</Frame>

5. Enter the metadata for the integration
   Select the ATS of the category

<Frame>
  ![](https://files.readme.io/083f7cb-Screenshot_2023-02-01_at_18.52.03.png)
</Frame>

Enter the name and email of the organization that this Lever instance belongs to (these values are not important and only serve as future reference points)

<Frame>
  ![](https://files.readme.io/3bdd1ef-Screenshot_2023-02-01_at_18.53.22.png)
</Frame>

Optional: configure which data points and write actions should be made available for this integration. If you leave this turned off, your default scopes will be used

<Frame>
  ![](https://files.readme.io/b03b8dc-Screenshot_2023-02-01_at_18.54.50.png)
</Frame>

Scroll to the very bottom and click continue

6. Type in "Lever" in the search bar and click on the logo that just appeared
7. Check the permissions that are configured and click “Continue” if you’re happy with them
8. On the next page click “Continue” to enter the OAuth flow
9. Log into your Lever account on the next page

Congratulations! You now have connected your Lever ATS and should see it in your integrations overview

<Frame>
  ![](https://files.readme.io/00f934d-Screenshot_2023-02-01_at_19.09.30.png)
</Frame>

# Configure the Integration

If you need to configure anything about your integration, find it on the integrations overview (As shown in step 9 of "Set up the Integration") and click on it to get to the integrations details page

## Changing the scope configuration

Once you are on the integrations details page, scroll down to the *Scope config* block

<Frame>
  ![](https://files.readme.io/42b11d6-Screenshot_2023-02-01_at_19.16.12.png)
</Frame>

## Triggering a custom sync

By default, data is synced every three hours. You can trigger a sync earlier than that either by hitting the `/force-sync` api endpoint (documented [here](/ats/v1/post-force-sync)) or by clicking the “Sync now” button in the integrations overview

<Frame>
  ![](https://files.readme.io/cbf5f79-Screenshot_2023-02-01_at_19.20.30.png)
</Frame>

## Updating the integration credentials

If the user that authenticated the integration changed their lever password or some other authentication problems occured, you can relink the integration without having to create a new one.

Go to the integration details page and click on the “Create update link” button.

<Frame>
  ![](https://files.readme.io/327db07-Screenshot_2023-02-01_at_19.22.12.png)
</Frame>

The generated link can be used to re-authenticate the existing Lever integration


# Available ATS Connectors
Source: https://docs.kombo.dev/ats/connectors

Browse all available ATS connectors integrated with Kombo

Through Kombo's Unified ATS API, you can integrate with 117+ ATS systems.

<Note>
  Please note that this page only lists connectors for Kombo's **ATS API**. You can also browse our [HRIS connectors](/hris/connectors) and [Assessment connectors](/assessment/connectors) and [LMS connectors](/lms/connectors).
</Note>

<CardGroup>
  <Card title="Abacus Umantis" icon="https://storage.googleapis.com/kombo-assets/integrations/abacusumantis/icon.svg" href="/ats/connectors/abacusumantis">
    ATS connector
  </Card>

  <Card title="ADP Workforce Now" icon="https://storage.googleapis.com/kombo-assets/integrations/adpworkforcenow/icon.svg" href="/ats/connectors/adpworkforcenow">
    ATS connector
  </Card>

  <Card title="AFAS Software" icon="https://storage.googleapis.com/kombo-assets/integrations/afas/icon.svg" href="/ats/connectors/afas">
    ATS connector
  </Card>

  <Card title="ApplicantStack" icon="https://storage.googleapis.com/kombo-assets/integrations/applicantstack/icon.svg" href="/ats/connectors/applicantstack">
    ATS connector
  </Card>

  <Card title="Apploi" icon="https://storage.googleapis.com/kombo-assets/integrations/apploi/icon.svg" href="/ats/connectors/apploi">
    ATS connector
  </Card>

  <Card title="Ashby" icon="https://storage.googleapis.com/kombo-assets/integrations/ashby/icon.svg" href="/ats/connectors/ashby">
    ATS connector
  </Card>

  <Card title="Asymbl" icon="https://storage.googleapis.com/kombo-assets/integrations/asymbl/icon.svg" href="/ats/connectors/asymbl">
    ATS connector
  </Card>

  <Card title="Avature" icon="https://storage.googleapis.com/kombo-assets/integrations/avature/icon.svg" href="/ats/connectors/avature">
    ATS connector
  </Card>

  <Card title="Avionté" icon="https://storage.googleapis.com/kombo-assets/integrations/avionte/icon.svg" href="/ats/connectors/avionte">
    ATS connector
  </Card>

  <Card title="BambooHR" icon="https://storage.googleapis.com/kombo-assets/integrations/bamboohr/icon.svg" href="/ats/connectors/bamboohr">
    ATS connector
  </Card>

  <Card title="BITE" icon="https://storage.googleapis.com/kombo-assets/integrations/bite/icon.svg" href="/ats/connectors/bite">
    ATS connector
  </Card>

  <Card title="Brass Ring" icon="https://storage.googleapis.com/kombo-assets/integrations/brassring/icon.svg" href="/ats/connectors/brassring">
    ATS connector
  </Card>

  <Card title="Breezy HR" icon="https://storage.googleapis.com/kombo-assets/integrations/breezyhr/icon.svg" href="/ats/connectors/breezyhr">
    ATS connector
  </Card>

  <Card title="Bullhorn" icon="" href="/ats/connectors/bullhorn">
    ATS connector
  </Card>

  <Card title="Bullhorn for Salesforce" icon="" href="/ats/connectors/bullhorn4salesforce">
    ATS connector
  </Card>

  <Card title="Bullhorn Login" icon="" href="/ats/connectors/bullhornlogin">
    ATS connector
  </Card>

  <Card title="CareerPlug" icon="https://storage.googleapis.com/kombo-assets/integrations/careerplug/icon.svg" href="/ats/connectors/careerplug">
    ATS connector
  </Card>

  <Card title="Carerix" icon="https://storage.googleapis.com/kombo-assets/integrations/carerix/icon.svg" href="/ats/connectors/carerix">
    ATS connector
  </Card>

  <Card title="Carerix (GraphQL)" icon="https://storage.googleapis.com/kombo-assets/integrations/carerixgraphql/icon.svg" href="/ats/connectors/carerixgraphql">
    ATS connector
  </Card>

  <Card title="CEGID TalentSoft Customer" icon="https://storage.googleapis.com/kombo-assets/integrations/talentsoftcustomer/icon.svg" href="/ats/connectors/talentsoftcustomer">
    ATS connector
  </Card>

  <Card title="CEGID TalentSoft FrontOffice" icon="https://storage.googleapis.com/kombo-assets/integrations/talentsoft/icon.svg" href="/ats/connectors/talentsoft">
    ATS connector
  </Card>

  <Card title="Ceipal" icon="https://storage.googleapis.com/kombo-assets/integrations/ceipal/icon.svg" href="/ats/connectors/ceipal">
    ATS connector
  </Card>

  <Card title="Compleet (Pitcher API)" icon="https://storage.googleapis.com/kombo-assets/integrations/compleetpitcher/icon.svg" href="/ats/connectors/compleetpitcher">
    ATS connector
  </Card>

  <Card title="Compleet (only PersoProfiler)" icon="https://storage.googleapis.com/kombo-assets/integrations/compleet/icon.svg" href="/ats/connectors/compleet">
    ATS connector
  </Card>

  <Card title="Compleet (Persy API)" icon="https://storage.googleapis.com/kombo-assets/integrations/compleetpersy/icon.svg" href="/ats/connectors/compleetpersy">
    ATS connector
  </Card>

  <Card title="concludis" icon="https://storage.googleapis.com/kombo-assets/integrations/concludis/icon.svg" href="/ats/connectors/concludis">
    ATS connector
  </Card>

  <Card title="Connexys By Bullhorn" icon="" href="/ats/connectors/connexys">
    ATS connector
  </Card>

  <Card title="Cornerstone OnDemand" icon="https://storage.googleapis.com/kombo-assets/integrations/cornerstoneondemand/icon.svg" href="/ats/connectors/cornerstoneondemand">
    ATS connector
  </Card>

  <Card title="Cornerstone TalentLink" icon="https://storage.googleapis.com/kombo-assets/integrations/cornerstonetalentlink/icon.svg" href="/ats/connectors/cornerstonetalentlink">
    ATS connector
  </Card>

  <Card title="Coveto (legacy SOAP API)" icon="https://storage.googleapis.com/kombo-assets/integrations/coveto/icon.svg" href="/ats/connectors/coveto">
    ATS connector
  </Card>

  <Card title="Coveto (REST API)" icon="https://storage.googleapis.com/kombo-assets/integrations/covetorest/icon.svg" href="/ats/connectors/covetorest">
    ATS connector
  </Card>

  <Card title="Crelate" icon="https://storage.googleapis.com/kombo-assets/integrations/crelate/icon.svg" href="/ats/connectors/crelate">
    ATS connector
  </Card>

  <Card title="d.vinci" icon="https://storage.googleapis.com/kombo-assets/integrations/dvinci/icon.svg" href="/ats/connectors/dvinci">
    ATS connector
  </Card>

  <Card title="d.vinci admin" icon="https://storage.googleapis.com/kombo-assets/integrations/dvinciadmin/icon.svg" href="/ats/connectors/dvinciadmin">
    ATS connector
  </Card>

  <Card title="Databites" icon="https://storage.googleapis.com/kombo-assets/integrations/databites/icon.svg" href="/ats/connectors/databites">
    ATS connector
  </Card>

  <Card title="Dayforce" icon="https://storage.googleapis.com/kombo-assets/integrations/dayforce/icon.svg" href="/ats/connectors/dayforce">
    ATS connector
  </Card>

  <Card title="Digital Recruiters" icon="https://storage.googleapis.com/kombo-assets/integrations/digitalrecruiters/icon.svg" href="/ats/connectors/digitalrecruiters">
    ATS connector
  </Card>

  <Card title="Eightfold" icon="https://storage.googleapis.com/kombo-assets/integrations/eightfold/icon.svg" href="/ats/connectors/eightfold">
    ATS connector
  </Card>

  <Card title="Eploy" icon="https://storage.googleapis.com/kombo-assets/integrations/eploy/icon.svg" href="/ats/connectors/eploy">
    ATS connector
  </Card>

  <Card title="eRecruiter" icon="https://storage.googleapis.com/kombo-assets/integrations/erecruiter/icon.svg" href="/ats/connectors/erecruiter">
    ATS connector
  </Card>

  <Card title="Factorial" icon="https://storage.googleapis.com/kombo-assets/integrations/factorial/icon.svg" href="/ats/connectors/factorial">
    ATS connector
  </Card>

  <Card title="Flatchr" icon="https://storage.googleapis.com/kombo-assets/integrations/flatchr/icon.svg" href="/ats/connectors/flatchr">
    ATS connector
  </Card>

  <Card title="Fountain" icon="https://storage.googleapis.com/kombo-assets/integrations/fountain/icon.svg" href="/ats/connectors/fountain">
    ATS connector
  </Card>

  <Card title="Gem" icon="https://storage.googleapis.com/kombo-assets/integrations/gem/icon.svg" href="/ats/connectors/gem">
    ATS connector
  </Card>

  <Card title="Greenhouse (V1)" icon="https://storage.googleapis.com/kombo-assets/integrations/greenhouse/icon.svg" href="/ats/connectors/greenhouse">
    ATS connector
  </Card>

  <Card title="Greenhouse (V3)" icon="https://storage.googleapis.com/kombo-assets/integrations/greenhousev3/icon.svg" href="/ats/connectors/greenhousev3">
    ATS connector
  </Card>

  <Card title="Greenhouse Job Board" icon="https://storage.googleapis.com/kombo-assets/integrations/greenhousejobboard/icon.svg" href="/ats/connectors/greenhousejobboard">
    ATS connector
  </Card>

  <Card title="GuideCom" icon="https://storage.googleapis.com/kombo-assets/integrations/guidecom/icon.svg" href="/ats/connectors/guidecom">
    ATS connector
  </Card>

  <Card title="Haufe Umantis" icon="" href="/ats/connectors/umantis">
    ATS connector
  </Card>

  <Card title="Heyrecruit" icon="https://storage.googleapis.com/kombo-assets/integrations/heyrecruit/icon.svg" href="/ats/connectors/heyrecruit">
    ATS connector
  </Card>

  <Card title="Homerun" icon="https://storage.googleapis.com/kombo-assets/integrations/homerun/icon.svg" href="/ats/connectors/homerun">
    ATS connector
  </Card>

  <Card title="HR Office" icon="https://storage.googleapis.com/kombo-assets/integrations/hroffice/icon.svg" href="/ats/connectors/hroffice">
    ATS connector
  </Card>

  <Card title="HR WORKS" icon="https://storage.googleapis.com/kombo-assets/integrations/hrworks/icon.svg" href="/ats/connectors/hrworks">
    ATS connector
  </Card>

  <Card title="HR4YOU" icon="https://storage.googleapis.com/kombo-assets/integrations/hr4you/icon.svg" href="/ats/connectors/hr4you">
    ATS connector
  </Card>

  <Card title="iCIMS" icon="" href="/ats/connectors/icims">
    ATS connector
  </Card>

  <Card title="InRecruiting by Zucchetti" icon="https://storage.googleapis.com/kombo-assets/integrations/inrecruiting/icon.svg" href="/ats/connectors/inrecruiting">
    ATS connector
  </Card>

  <Card title="JazzHR" icon="https://storage.googleapis.com/kombo-assets/integrations/jazzhr/icon.svg" href="/ats/connectors/jazzhr">
    ATS connector
  </Card>

  <Card title="JobAdder" icon="https://storage.googleapis.com/kombo-assets/integrations/jobadder/icon.svg" href="/ats/connectors/jobadder">
    ATS connector
  </Card>

  <Card title="JobDiva" icon="https://storage.googleapis.com/kombo-assets/integrations/jobdiva/icon.svg" href="/ats/connectors/jobdiva">
    ATS connector
  </Card>

  <Card title="Jobvite" icon="https://storage.googleapis.com/kombo-assets/integrations/jobvite/icon.svg" href="/ats/connectors/jobvite">
    ATS connector
  </Card>

  <Card title="Jobylon" icon="https://storage.googleapis.com/kombo-assets/integrations/jobylon/icon.svg" href="/ats/connectors/jobylon">
    ATS connector
  </Card>

  <Card title="JOIN" icon="https://storage.googleapis.com/kombo-assets/integrations/join/icon.svg" href="/ats/connectors/join">
    ATS connector
  </Card>

  <Card title="Kombo Sandbox" icon="https://storage.googleapis.com/kombo-assets/integrations/sandbox/icon.svg" href="/ats/connectors/sandbox">
    ATS connector
  </Card>

  <Card title="Kula" icon="https://storage.googleapis.com/kombo-assets/integrations/kula/icon.svg" href="/ats/connectors/kula">
    ATS connector
  </Card>

  <Card title="Laura" icon="https://storage.googleapis.com/kombo-assets/integrations/laura/icon.svg" href="/ats/connectors/laura">
    ATS connector
  </Card>

  <Card title="Lever" icon="https://storage.googleapis.com/kombo-assets/integrations/lever/icon.svg" href="/ats/connectors/lever">
    ATS connector
  </Card>

  <Card title="Logic Melon" icon="https://storage.googleapis.com/kombo-assets/integrations/logicmelon/icon.svg" href="/ats/connectors/logicmelon">
    ATS connector
  </Card>

  <Card title="Loxo" icon="https://storage.googleapis.com/kombo-assets/integrations/loxo/icon.svg" href="/ats/connectors/loxo">
    ATS connector
  </Card>

  <Card title="Manatal" icon="https://storage.googleapis.com/kombo-assets/integrations/manatal/icon.svg" href="/ats/connectors/manatal">
    ATS connector
  </Card>

  <Card title="Mercury" icon="https://storage.googleapis.com/kombo-assets/integrations/mercury/icon.svg" href="/ats/connectors/mercury">
    ATS connector
  </Card>

  <Card title="MHM HR" icon="https://storage.googleapis.com/kombo-assets/integrations/mhmhr/icon.svg" href="/ats/connectors/mhmhr">
    ATS connector
  </Card>

  <Card title="Mysolution" icon="https://storage.googleapis.com/kombo-assets/integrations/mysolution/icon.svg" href="/ats/connectors/mysolution">
    ATS connector
  </Card>

  <Card title="Odoo" icon="https://storage.googleapis.com/kombo-assets/integrations/odoo/icon.svg" href="/ats/connectors/odoo">
    ATS connector
  </Card>

  <Card title="Onlyfy" icon="https://storage.googleapis.com/kombo-assets/integrations/onlyfy/icon.svg" href="/ats/connectors/onlyfy">
    ATS connector
  </Card>

  <Card title="Oracle Recruiting Cloud" icon="https://storage.googleapis.com/kombo-assets/integrations/oraclerecruiting/icon.svg" href="/ats/connectors/oraclerecruiting">
    ATS connector
  </Card>

  <Card title="Oracle Taleo" icon="https://storage.googleapis.com/kombo-assets/integrations/taleo/icon.svg" href="/ats/connectors/taleo">
    ATS connector
  </Card>

  <Card title="OTYS" icon="https://storage.googleapis.com/kombo-assets/integrations/otys/icon.svg" href="/ats/connectors/otys">
    ATS connector
  </Card>

  <Card title="P&I Loga" icon="https://storage.googleapis.com/kombo-assets/integrations/piloga/icon.svg" href="/ats/connectors/piloga">
    ATS connector
  </Card>

  <Card title="PageUp People" icon="https://storage.googleapis.com/kombo-assets/integrations/pageup/icon.svg" href="/ats/connectors/pageup">
    ATS connector
  </Card>

  <Card title="Paradox" icon="https://storage.googleapis.com/kombo-assets/integrations/paradox/icon.svg" href="/ats/connectors/paradox">
    ATS connector
  </Card>

  <Card title="Paycor" icon="https://storage.googleapis.com/kombo-assets/integrations/paycor/icon.svg" href="/ats/connectors/paycor">
    ATS connector
  </Card>

  <Card title="Paylocity" icon="https://storage.googleapis.com/kombo-assets/integrations/paylocity/icon.svg" href="/ats/connectors/paylocity">
    ATS connector
  </Card>

  <Card title="Perbility Helix" icon="https://storage.googleapis.com/kombo-assets/integrations/perbilityhelix/icon.svg" href="/ats/connectors/perbilityhelix">
    ATS connector
  </Card>

  <Card title="Personio" icon="https://storage.googleapis.com/kombo-assets/integrations/personio/icon.svg" href="/ats/connectors/personio">
    ATS connector
  </Card>

  <Card title="Perview" icon="https://storage.googleapis.com/kombo-assets/integrations/perview/icon.svg" href="/ats/connectors/perview">
    ATS connector
  </Card>

  <Card title="Phenom" icon="https://storage.googleapis.com/kombo-assets/integrations/phenom/icon.svg" href="/ats/connectors/phenom">
    ATS connector
  </Card>

  <Card title="Pinpoint" icon="https://storage.googleapis.com/kombo-assets/integrations/pinpoint/icon.svg" href="/ats/connectors/pinpoint">
    ATS connector
  </Card>

  <Card title="ReachMee" icon="https://storage.googleapis.com/kombo-assets/integrations/reachmee/icon.svg" href="/ats/connectors/reachmee">
    ATS connector
  </Card>

  <Card title="RECRU" icon="https://storage.googleapis.com/kombo-assets/integrations/recruhr/icon.svg" href="/ats/connectors/recruhr">
    ATS connector
  </Card>

  <Card title="Recruit CRM" icon="https://storage.googleapis.com/kombo-assets/integrations/recruitcrm/icon.svg" href="/ats/connectors/recruitcrm">
    ATS connector
  </Card>

  <Card title="RecruiterFlow" icon="https://storage.googleapis.com/kombo-assets/integrations/recruiterflow/icon.svg" href="/ats/connectors/recruiterflow">
    ATS connector
  </Card>

  <Card title="rexx systems" icon="https://storage.googleapis.com/kombo-assets/integrations/rexx/icon.svg" href="/ats/connectors/rexx">
    ATS connector
  </Card>

  <Card title="Sage HR" icon="https://storage.googleapis.com/kombo-assets/integrations/sagehr/icon.svg" href="/ats/connectors/sagehr">
    ATS connector
  </Card>

  <Card title="SAP SuccessFactors" icon="https://storage.googleapis.com/kombo-assets/integrations/successfactors/icon.svg" href="/ats/connectors/successfactors">
    ATS connector
  </Card>

  <Card title="SmartRecruiters" icon="https://storage.googleapis.com/kombo-assets/integrations/smartrecruiters/icon.svg" href="/ats/connectors/smartrecruiters">
    ATS connector
  </Card>

  <Card title="Softgarden" icon="https://storage.googleapis.com/kombo-assets/integrations/softgarden/icon.svg" href="/ats/connectors/softgarden">
    ATS connector
  </Card>

  <Card title="Softgarden Partner" icon="https://storage.googleapis.com/kombo-assets/integrations/softgardenpartner/icon.svg" href="/ats/connectors/softgardenpartner">
    ATS connector
  </Card>

  <Card title="Spark Hire Recruit" icon="https://storage.googleapis.com/kombo-assets/integrations/comeet/icon.svg" href="/ats/connectors/comeet">
    ATS connector
  </Card>

  <Card title="Spott" icon="https://storage.googleapis.com/kombo-assets/integrations/spott/icon.svg" href="/ats/connectors/spott">
    ATS connector
  </Card>

  <Card title="Taleez" icon="https://storage.googleapis.com/kombo-assets/integrations/taleez/icon.svg" href="/ats/connectors/taleez">
    ATS connector
  </Card>

  <Card title="Talent Clue" icon="https://storage.googleapis.com/kombo-assets/integrations/talentclue/icon.svg" href="/ats/connectors/talentclue">
    ATS connector
  </Card>

  <Card title="Talent360" icon="https://storage.googleapis.com/kombo-assets/integrations/talent360/icon.svg" href="/ats/connectors/talent360">
    ATS connector
  </Card>

  <Card title="TalentAdore" icon="https://storage.googleapis.com/kombo-assets/integrations/talentadore/icon.svg" href="/ats/connectors/talentadore">
    ATS connector
  </Card>

  <Card title="Talention" icon="https://storage.googleapis.com/kombo-assets/integrations/talention/icon.svg" href="/ats/connectors/talention">
    ATS connector
  </Card>

  <Card title="Teamtailor" icon="https://storage.googleapis.com/kombo-assets/integrations/teamtailor/icon.svg" href="/ats/connectors/teamtailor">
    ATS connector
  </Card>

  <Card title="Teamtailor Job Boards" icon="https://storage.googleapis.com/kombo-assets/integrations/teamtailorjobboards/icon.svg" href="/ats/connectors/teamtailorjobboards">
    ATS connector
  </Card>

  <Card title="Tellent Recruitee" icon="https://storage.googleapis.com/kombo-assets/integrations/recruitee/icon.svg" href="/ats/connectors/recruitee">
    ATS connector
  </Card>

  <Card title="TrackerRMS" icon="https://storage.googleapis.com/kombo-assets/integrations/trackerrms/icon.svg" href="/ats/connectors/trackerrms">
    ATS connector
  </Card>

  <Card title="TRAFFIT" icon="https://storage.googleapis.com/kombo-assets/integrations/traffit/icon.svg" href="/ats/connectors/traffit">
    ATS connector
  </Card>

  <Card title="Ubeeo" icon="https://storage.googleapis.com/kombo-assets/integrations/ubeeo/icon.svg" href="/ats/connectors/ubeeo">
    ATS connector
  </Card>

  <Card title="UKG Pro" icon="https://storage.googleapis.com/kombo-assets/integrations/ukgpro/icon.svg" href="/ats/connectors/ukgpro">
    ATS connector
  </Card>

  <Card title="UKG Ready" icon="https://storage.googleapis.com/kombo-assets/integrations/ukgready/icon.svg" href="/ats/connectors/ukgready">
    ATS connector
  </Card>

  <Card title="Welcome to the Jungle" icon="https://storage.googleapis.com/kombo-assets/integrations/welcometothejungle/icon.svg" href="/ats/connectors/welcometothejungle">
    ATS connector
  </Card>

  <Card title="Workable" icon="https://storage.googleapis.com/kombo-assets/integrations/workable/icon.svg" href="/ats/connectors/workable">
    ATS connector
  </Card>

  <Card title="Workday" icon="https://storage.googleapis.com/kombo-assets/integrations/workday/icon.svg" href="/ats/connectors/workday">
    ATS connector
  </Card>

  <Card title="Zoho Recruit" icon="https://storage.googleapis.com/kombo-assets/integrations/zohorecruit/icon.svg" href="/ats/connectors/zohorecruit">
    ATS connector
  </Card>

  <Card title="Zvoove Recruit" icon="https://storage.googleapis.com/kombo-assets/integrations/zvooverecruit/icon.svg" href="/ats/connectors/zvooverecruit">
    ATS connector
  </Card>
</CardGroup>

## Missing something?

We're always expanding our offering of integrations, so if there's a solution that's missing, [let's talk](https://www.kombo.dev/demo)! If you're an existing Kombo customer, please [reach out to support](mailto:support@kombo.dev).


# Abacus Umantis ATS Integration
Source: https://docs.kombo.dev/ats/connectors/abacusumantis

Abacus Umantis connector for Kombo's ATS API

The Abacus Umantis ATS integration allows you to sync ATS data between Abacus Umantis and your application through Kombo's unified API. The tool slug for this connector is `abacusumantis`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/27669880057873">
    Step-by-step instructions to connect your Abacus Umantis account to Kombo.
  </Card>

  <Card title="Source Setup Guide" icon="settings" href="https://help.kombo.dev/hc/en-us/articles/18314081650065">
    Learn how to set up candidate sources in Abacus Umantis.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22562648411537">
    How to view and manage candidate sources in Abacus Umantis.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | description         |       |
      | employment\_type    |       |
      | status              |       |
      | visibility          |       |
      | department          |       |
      | post\_url           |       |
      | experience\_level   |       |
      | salary\_amount      |       |
      | salary\_currency    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | closed\_at          |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Umantis supports uploading at most 14 attachments, not including the CV and cover letter. All additional attachments will be ignored.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.zip\_code              |       |
      | candidate.gender                          |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.expires\_at                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Umantis supports uploading at most 14 attachments, not including the CV and cover letter. All additional attachments will be ignored.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.zip\_code              |       |
      | candidate.gender                          |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.expires\_at                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        Umantis usually only supports uploading PDF attachments by default. Please see this guide to enable other file types: `help.kombo.dev/hc/en-us/articles/23450281362065`
      </Note>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | application\_id      |       |
      | attachment.name      |       |
      | attachment.data\_url |       |
      | attachment.data      |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Reject application">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | application\_id       |       |
      | rejection\_reason\_id |       |
      | note                  |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | label                    |       |
      | url                      |       |
      | details.attributes.key   |       |
      | details.attributes.value |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Delta Syncs                    |       |
    | Custom Field Explorer          |       |
    | Jobs                           |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
    | Prerequisites                  |       |
    | Create credentials             |       |
    | Candidate source tracking      |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Current Umantis integration after Abacus acquisition (recommended)

For **Abacus Umantis**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Haufe Umantis" icon="https://storage.googleapis.com/kombo-assets/integrations/umantis/icon.svg" href="/ats/connectors/umantis">
    Legacy Haufe Umantis integration. This variant is deprecated
  </Card>
</CardGroup>

<Note>You can only use one variant at a time.</Note>


# ADP Workforce Now ATS Integration
Source: https://docs.kombo.dev/ats/connectors/adpworkforcenow

ADP Workforce Now connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The ADP Workforce Now ATS integration allows you to sync ATS data between ADP Workforce Now and your application through Kombo's unified API. The tool slug for this connector is `adpworkforcenow`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/29675977484945">
    Step-by-step instructions to connect your ADP Workforce Now account to Kombo.
  </Card>

  <Card title="Creating Webhooks in ADP Workforce Now" icon="book" href="https://help.kombo.dev/hc/en-us/articles/43799739692561-Creating-Webhooks-in-ADP-Workforce-Now">
    Additional documentation and guides for ADP Workforce Now.
  </Card>

  <Card title="What do test results look like?" icon="book" href="https://help.kombo.dev/hc/en-us/articles/33060915179793">
    Additional documentation and guides for ADP Workforce Now.
  </Card>
</CardGroup>

## General Notes

* This connector is built for **ADP Workforce Now**, a product available only in North America. Please do not confuse it with **ADP Workforce**.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | department           |       |
      | post\_url            |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      <Note>
        ADP Workforce Now only exposes application stages on the respective application. This means that you need to have the *"Applications"* scope enabled to read application stages, and you will only be able to access application stages that have been assigned to at least one application in the system.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes                                                                                                                                                                                                                                                                                        |
      | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
      | id                  |                                                                                                                                                                                                                                                                                              |
      | remote\_id          |                                                                                                                                                                                                                                                                                              |
      | changed\_at         |                                                                                                                                                                                                                                                                                              |
      | remote\_deleted\_at |                                                                                                                                                                                                                                                                                              |
      | current\_stage\_id  |                                                                                                                                                                                                                                                                                              |
      | job\_id             |                                                                                                                                                                                                                                                                                              |
      | candidate\_id       |                                                                                                                                                                                                                                                                                              |
      | custom\_fields      |                                                                                                                                                                                                                                                                                              |
      | integration\_fields |                                                                                                                                                                                                                                                                                              |
      | remote\_created\_at |                                                                                                                                                                                                                                                                                              |
      | remote\_updated\_at | ADP Workforce Now does not expose a last-modified timestamp for applications. The remote\_updated\_at field is filled from the date the application's current status became effective, so it only reflects status changes (not other edits to the application) and only has day granularity. |
      | remote\_data        |                                                                                                                                                                                                                                                                                              |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        ADP Workforce Now exposes one hiring manager slot per job:

        * **hiringManager** (shown as "Hiring Manager" in the UI) maps to unified type `HIRING_MANAGER`
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Add attachment to application">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | label                    |       |
      | url                      |       |
      | details.attributes.key   |       |
      | details.attributes.value |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                         | Notes                                                                                                                                                                                                                                                                                                                                                                                                        |
    | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
    | API Passthrough                 |                                                                                                                                                                                                                                                                                                                                                                                                              |
    | Webhook Subscriptions           | job.application.status.change: triggered when an application stage or status was changed webhooks.test: triggered when ADP sent a test webhook to verify the endpoint is reachable Not covered: job published Not covered: job unpublished Not covered: candidate created Not covered: tag assigned Not covered: screening questions updated Not covered: interview scheduled Not covered: interview updated |
    | Scope Testing                   |                                                                                                                                                                                                                                                                                                                                                                                                              |
    | Per Model Tests                 |                                                                                                                                                                                                                                                                                                                                                                                                              |
    | Sync Only Created Applications  |                                                                                                                                                                                                                                                                                                                                                                                                              |
    | Connection Guide                |                                                                                                                                                                                                                                                                                                                                                                                                              |
    | Prerequisites                   |                                                                                                                                                                                                                                                                                                                                                                                                              |
    | Roles                           |                                                                                                                                                                                                                                                                                                                                                                                                              |
    | Job roles (e.g. Hiring Manager) | ADP Workforce Now exposes one hiring manager slot per job:                                                                                                                                                                                                                                                                                                                                                   |

    * **hiringManager** (shown as "Hiring Manager" in the UI) maps to unified type `HIRING_MANAGER` |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** ADP Workforce Now

For **ADP Workforce Now**, we also offer the following other connector variants:

<CardGroup>
  <Card title="ADP Workforce Now HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/adpworkforcenow/icon.svg" href="/hris/connectors/adpworkforcenow">
    ADP Workforce Now for the HRIS category
  </Card>
</CardGroup>


# AFAS Software ATS Integration
Source: https://docs.kombo.dev/ats/connectors/afas

AFAS Software connector for Kombo's ATS API

The AFAS Software ATS integration allows you to sync ATS data between AFAS Software and your application through Kombo's unified API. The tool slug for this connector is `afas`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/18770528249105">
    Step-by-step instructions to connect your AFAS Software account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | description          |       |
      | status               |       |
      | category             |       |
      | department           |       |
      | experience\_level    |       |
      | remote\_work\_status |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | outcome                 |       |
      | rejection\_reason\_name |       |
      | current\_stage\_id      |       |
      | job\_id                 |       |
      | candidate\_id           |       |
      | remote\_created\_at     |       |
      | remote\_updated\_at     |       |
      | remote\_data            |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        AFAS can only accept one CV without any other attachments.
      </Note>

      | Input Field               | Notes |
      | ------------------------- | ----- |
      | candidate.first\_name     |       |
      | candidate.last\_name      |       |
      | candidate.email\_address  |       |
      | candidate.phone\_number   |       |
      | application.job\_id       |       |
      | attachments.name          |       |
      | attachments.content\_type |       |
      | attachments.data\_url     |       |
      | attachments.data          |       |
      | attachments.type          |       |
      | source.name               |       |
      | source.unified\_key       |       |
      | source.id                 |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        AFAS can only accept one CV without any other attachments.
      </Note>

      | Input Field               | Notes |
      | ------------------------- | ----- |
      | candidate.first\_name     |       |
      | candidate.last\_name      |       |
      | candidate.email\_address  |       |
      | candidate.phone\_number   |       |
      | application.job\_id       |       |
      | attachments.name          |       |
      | attachments.content\_type |       |
      | attachments.data\_url     |       |
      | attachments.data          |       |
      | attachments.type          |       |
      | source.name               |       |
      | source.unified\_key       |       |
      | source.id                 |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | application\_id      |       |
      | attachment.name      |       |
      | attachment.data\_url |       |
      | attachment.data      |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      | Input Field          | Notes |
      | -------------------- | ----- |
      | candidate\_id        |       |
      | attachment.name      |       |
      | attachment.data\_url |       |
      | attachment.data      |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Scope Testing                  |       |
    | Per Model Tests                |       |
    | Per Field Tests                |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** AFAS Software

For **AFAS Software**, we also offer the following other connector variants:

<CardGroup>
  <Card title="AFAS Software HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/afas/icon.svg" href="/hris/connectors/afas">
    AFAS Software for the HRIS category
  </Card>
</CardGroup>


# ApplicantStack ATS Integration
Source: https://docs.kombo.dev/ats/connectors/applicantstack

ApplicantStack connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The ApplicantStack ATS integration allows you to sync ATS data between ApplicantStack and your application through Kombo's unified API. The tool slug for this connector is `applicantstack`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/38127507593489-ApplicantStack-How-do-I-link-my-account">
    Step-by-step instructions to connect your ApplicantStack account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | description         |       |
      | status              |       |
      | visibility          |       |
      | category            |       |
      | department          |       |
      | post\_url           |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.zip\_code              |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.zip\_code              |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
  </Tab>
</Tabs>


# Apploi ATS Integration
Source: https://docs.kombo.dev/ats/connectors/apploi

Apploi connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Apploi ATS integration allows you to sync ATS data between Apploi and your application through Kombo's unified API. The tool slug for this connector is `apploi`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/32844713373457">
    Step-by-step instructions to connect your Apploi account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field                | Notes                                                                                                                                       |
      | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
      | id                   |                                                                                                                                             |
      | remote\_id           |                                                                                                                                             |
      | changed\_at          |                                                                                                                                             |
      | remote\_deleted\_at  |                                                                                                                                             |
      | name                 |                                                                                                                                             |
      | job\_code            |                                                                                                                                             |
      | description          |                                                                                                                                             |
      | employment\_type     |                                                                                                                                             |
      | status               |                                                                                                                                             |
      | visibility           |                                                                                                                                             |
      | post\_url            |                                                                                                                                             |
      | salary\_amount       |                                                                                                                                             |
      | salary\_amount\_from |                                                                                                                                             |
      | salary\_amount\_to   |                                                                                                                                             |
      | salary\_period       |                                                                                                                                             |
      | location             | The location returned by the Apploi API is not standardized. Therefore, the `address` is mapped to the `raw` field of the `location` field. |
      | custom\_fields       |                                                                                                                                             |
      | integration\_fields  |                                                                                                                                             |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | format              |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        It is only possible to submit a `CV` when creating a candidate in Apploi. Attachment of other types will be omitted.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        It is only possible to submit a `CV` when creating a candidate in Apploi. Attachment of other types will be omitted.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Scope Testing                  |       |
    | Per Model Tests                |       |
    | Delta Syncs                    |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
    | Create credentials             |       |
  </Tab>
</Tabs>


# Ashby ATS Integration
Source: https://docs.kombo.dev/ats/connectors/ashby

Ashby connector for Kombo's ATS API

The Ashby ATS integration allows you to sync ATS data between Ashby and your application through Kombo's unified API. The tool slug for this connector is `ashby`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/17847199761553-How-do-I-link-my-Ashby-account-">
    Step-by-step instructions to connect your Ashby account to Kombo.
  </Card>

  <Card title="Source Setup Guide" icon="settings" href="https://help.kombo.dev/hc/en-us/articles/17074979548433">
    Learn how to set up candidate sources in Ashby.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22535409549073-Ashby-How-to-view-a-candidates-source">
    How to view and manage candidate sources in Ashby.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | confidential         |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | department           |       |
      | post\_url            |       |
      | remote\_work\_status |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_url          |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Job postings">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description\_html   |       |
      | status              |       |
      | visibility          |       |
      | url                 |       |
      | job\_id             |       |
    </Accordion>

    <Accordion title="Candidates">
      <Note>
        Ashby allows recruiters to deduplicate candidates based on similar email, name, or social links. Candidate IDs may therefore change after candidate creation. Use application IDs as a source of truth if you want to keep track of a candidate's progression
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | status              |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                        | Notes |
      | ---------------------------- | ----- |
      | id                           |       |
      | remote\_id                   |       |
      | changed\_at                  |       |
      | remote\_deleted\_at          |       |
      | outcome                      |       |
      | rejection\_reason\_name      |       |
      | rejected\_at                 |       |
      | current\_stage\_id           |       |
      | job\_id                      |       |
      | candidate\_id                |       |
      | screening\_question\_answers |       |
      | custom\_fields               |       |
      | integration\_fields          |       |
      | remote\_url                  |       |
      | remote\_created\_at          |       |
      | remote\_updated\_at          |       |
      | remote\_data                 |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
      | category            |       |
    </Accordion>

    <Accordion title="Tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Interviews">
      <Note>
        Ashby implements an Interview Status, but only for the Interview Schedule, not for specific interview events. If the Interview Status is marked as canceled, all interview events are deleted. Therefore, it is not possible to have canceled interviews in Ashby.
      </Note>

      | Field                    | Notes |
      | ------------------------ | ----- |
      | id                       |       |
      | remote\_id               |       |
      | changed\_at              |       |
      | remote\_deleted\_at      |       |
      | title                    |       |
      | starting\_at             |       |
      | ending\_at               |       |
      | video\_conferencing\_url |       |
      | application\_id          |       |
      | stage\_id                |       |
      | remote\_created\_at      |       |
      | remote\_updated\_at      |       |
      | remote\_data             |       |
    </Accordion>

    <Accordion title="Offers">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | status                  |       |
      | employment\_start\_date |       |
      | application\_id         |       |
      | custom\_fields          |       |
      | integration\_fields     |       |
      | remote\_created\_at     |       |
      | remote\_updated\_at     |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Notes">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | candidate\_id       |       |
      | author\_id          |       |
      | content\_html       |       |
      | is\_private         |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        Each job's hiring team lists members with a **role** title; Ashby's defaults include 4 types, and organizations can add custom hiring team roles.

        * **Recruiting Coordinator** (shown as "Recruiting Coordinator" in the UI) maps to `COORDINATOR`
        * **Hiring Manager** (shown as "Hiring Manager" in the UI) maps to `HIRING_MANAGER`
        * **Recruiter** (shown as "Recruiter" in the UI) maps to `RECRUITER`
        * **Sourcer** (shown as "Sourcer" in the UI) maps to `SOURCER`
        * Other **role** values have no unified type.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="User roles">
      <Note>
        Each user has **globalRole** from Ashby (e.g. Organization Admin, Elevated Access, Limited Access, External Recruiter for agency users).

        * **Organization Admin** maps to unified type `ADMIN`
        * **External Recruiter** maps to unified type `RECRUITER`
        * **Limited Access** and **Elevated Access** have no unified type.
        * Any other **globalRole** value has no unified type.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | user\_id            |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Interviewing team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | interview\_id       |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                                           | Notes |
      | ----------------------------------------------------- | ----- |
      | candidate.first\_name                                 |       |
      | candidate.last\_name                                  |       |
      | candidate.email\_address                              |       |
      | candidate.additional\_email\_addresses.email\_address |       |
      | candidate.phone\_number                               |       |
      | candidate.location.city                               |       |
      | candidate.location.country                            |       |
      | candidate.location.state                              |       |
      | candidate.social\_links.url                           |       |
      | application.job\_id                                   |       |
      | application.stage\_id                                 |       |
      | screening\_question\_answers.question\_id             |       |
      | screening\_question\_answers.answer                   |       |
      | attachments.name                                      |       |
      | attachments.content\_type                             |       |
      | attachments.data\_url                                 |       |
      | attachments.data                                      |       |
      | attachments.type                                      |       |
      | source.name                                           |       |
      | source.unified\_key                                   |       |
      | source.id                                             |       |
      | sourced\_by.user\_id                                  |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                                           | Notes |
      | ----------------------------------------------------- | ----- |
      | candidate.first\_name                                 |       |
      | candidate.last\_name                                  |       |
      | candidate.email\_address                              |       |
      | candidate.additional\_email\_addresses.email\_address |       |
      | candidate.phone\_number                               |       |
      | candidate.location.city                               |       |
      | candidate.location.country                            |       |
      | candidate.location.state                              |       |
      | candidate.social\_links.url                           |       |
      | application.job\_id                                   |       |
      | application.stage\_id                                 |       |
      | screening\_question\_answers.question\_id             |       |
      | screening\_question\_answers.answer                   |       |
      | attachments.name                                      |       |
      | attachments.content\_type                             |       |
      | attachments.data\_url                                 |       |
      | attachments.data                                      |       |
      | attachments.type                                      |       |
      | source.name                                           |       |
      | source.unified\_key                                   |       |
      | source.id                                             |       |
      | sourced\_by.user\_id                                  |       |
    </Accordion>

    <Accordion title="Add tag to candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Reject application">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | application\_id       |       |
      | rejection\_reason\_id |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      <Note>
        Due to limitations of the API only the candidate CV can be fetched, the rest of the attachments will be omitted
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      <Note>
        Due to limitations of the API only the candidate CV can be fetched, the rest of the attachments will be omitted
      </Note>

      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Add result link to candidate">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | candidate\_id                       |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
    | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | API Passthrough                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | Webhook Subscriptions          | applicationSubmit: triggered when an application w/ candidate was created applicationUpdate: triggered when an application was updated in any way candidateHire: triggered when a candidate was hired candidateStageChange: triggered when a candidate/application stage was changed candidateDelete: triggered when a candidate was deleted interviewScheduleCreate: triggered when an interview was scheduled interviewScheduleUpdate: triggered when an interview was updated jobCreate: triggered when a job was created jobUpdate: triggered when a job was updated jobPostingDelete: triggered when a job posting was deleted jobPostingUpdate: triggered when a job posting was updated jobPostingPublish: triggered when a job posting was published jobPostingUnpublish: triggered when a job posting was unpublished offerCreate: triggered when an offer was created offerUpdate: triggered when an offer was updated offerDelete: triggered when an offer was deleted ping: triggered when a webhook was configured and the endpoint is checked to confirm it is working Not covered: a tag was assigned to a candidate Not covered: When only screening questions are updated on a job |
    | Automatic Setup                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | Scope Testing                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | Per Model Tests                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | Per Field Tests                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | Delta Syncs                    |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | Source Writing                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | Sync Only Created Applications |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | Connection Guide               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | Prerequisites                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | Create credentials             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | Candidate source tracking      |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | Roles                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | System roles (e.g. Admin)      | Each user has **globalRole** from Ashby (e.g. Organization Admin, Elevated Access, Limited Access, External Recruiter for agency users).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |

    * **Organization Admin** maps to unified type `ADMIN`
    * **External Recruiter** maps to unified type `RECRUITER`
    * **Limited Access** and **Elevated Access** have no unified type.
    * Any other **globalRole** value has no unified type. |
      \|   Job roles (e.g. Hiring Manager) | Each job's hiring team lists members with a **role** title; Ashby's defaults include 4 types, and organizations can add custom hiring team roles.
    * **Recruiting Coordinator** (shown as "Recruiting Coordinator" in the UI) maps to `COORDINATOR`
    * **Hiring Manager** (shown as "Hiring Manager" in the UI) maps to `HIRING_MANAGER`
    * **Recruiter** (shown as "Recruiter" in the UI) maps to `RECRUITER`
    * **Sourcer** (shown as "Sourcer" in the UI) maps to `SOURCER`
    * Other **role** values have no unified type. |
      \| EEO Questions | We support surveys (including surveys with demographic and EEO questions) |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Ashby

For **Ashby**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Ashby Assessment" icon="https://storage.googleapis.com/kombo-assets/integrations/ashby/icon.svg" href="/assessment/connectors/ashby">
    Ashby for the Assessment category
  </Card>
</CardGroup>


# Asymbl ATS Integration
Source: https://docs.kombo.dev/ats/connectors/asymbl

Asymbl connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Asymbl ATS integration allows you to sync ATS data between Asymbl and your application through Kombo's unified API. The tool slug for this connector is `asymbl`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/41623593096977-Asymbl-How-do-I-link-my-account">
    Step-by-step instructions to connect your Asymbl account to Kombo.
  </Card>
</CardGroup>

## General Notes

* Job Board Applications (`bpats__Job_Board_Application__c`) are a separate entity type for external job board submissions and are not currently synced. Only ATS Applicants (`bpats__ATS_Applicant__c`) are synced. If your use case requires syncing Job Board Applications, please clarify this requirement with your customer and reach out to our support team.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | job\_code           |       |
      | description         |       |
      | employment\_type    |       |
      | status              |       |
      | visibility          |       |
      | salary\_amount      |       |
      | salary\_currency    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | opened\_at          |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                   | Notes                                                                                    |
      | ----------------------- | ---------------------------------------------------------------------------------------- |
      | id                      |                                                                                          |
      | remote\_id              |                                                                                          |
      | changed\_at             |                                                                                          |
      | remote\_deleted\_at     |                                                                                          |
      | outcome                 | HIRED outcome depends on the application stage, it should be either "Hired" or "Pending" |
      | rejection\_reason\_name |                                                                                          |
      | current\_stage\_id      |                                                                                          |
      | job\_id                 |                                                                                          |
      | candidate\_id           |                                                                                          |
      | custom\_fields          |                                                                                          |
      | integration\_fields     |                                                                                          |
      | remote\_url             |                                                                                          |
      | remote\_created\_at     |                                                                                          |
      | remote\_updated\_at     |                                                                                          |
      | remote\_data            |                                                                                          |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        If candidate with the same e-mail already exists, the application will be created with an existing contact and the candidate data will not be updated
      </Note>

      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.title                       |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.location.country            |       |
      | candidate.location.zip\_code          |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.amount |       |
      | application.job\_id                   |       |
      | application.stage\_id                 |       |
      | attachments.name                      |       |
      | attachments.content\_type             |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | source.name                           |       |
      | source.unified\_key                   |       |
      | source.id                             |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        If candidate with the same e-mail already exists, the application will be created with an existing contact and the candidate data will not be updated
      </Note>

      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.title                       |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.location.country            |       |
      | candidate.location.zip\_code          |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.amount |       |
      | application.job\_id                   |       |
      | application.stage\_id                 |       |
      | attachments.name                      |       |
      | attachments.content\_type             |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | source.name                           |       |
      | source.unified\_key                   |       |
      | source.id                             |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        Attachments are linked to the candidate (Contact) in Salesforce, not directly to the application.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Scope Testing                  |       |
    | Per Model Tests                |       |
    | Delta Syncs                    |       |
    | Custom Field Explorer          |       |
    | Jobs                           |       |
    | Candidates                     |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
  </Tab>
</Tabs>


# Avature ATS Integration
Source: https://docs.kombo.dev/ats/connectors/avature

Avature connector for Kombo's ATS API

<Note>This connector requires a custom Kombo plan. Please contact us to enable it.</Note>

<Note>This connector is in closed beta. Please contact us to get access.</Note>

The Avature ATS integration allows you to sync ATS data between Avature and your application through Kombo's unified API. The tool slug for this connector is `avature`.

## General Notes

* Avature uses custom API endpoints for every customer. Please contact support if you wish to use this integration.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | confidential         |       |
      | employment\_type     |       |
      | status               |       |
      | category             |       |
      | department           |       |
      | experience\_level    |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | confidential        |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Source writing is **not** possible with the Avature custom API
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.zip\_code              |       |
      | candidate.gender                          |       |
      | candidate.salary\_expectations.period     |       |
      | candidate.salary\_expectations.amount     |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | gdpr\_consent.expires\_at                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Source writing is **not** possible with the Avature custom API
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.zip\_code              |       |
      | candidate.gender                          |       |
      | candidate.salary\_expectations.period     |       |
      | candidate.salary\_expectations.amount     |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | gdpr\_consent.expires\_at                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Scope Testing                  |       |
    | Per Model Tests                |       |
    | Per Field Tests                |       |
    | Delta Syncs                    |       |
    | Sync Only Created Applications |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Avature

For **Avature**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Avature Assessment" icon="https://storage.googleapis.com/kombo-assets/integrations/avature/icon.svg" href="/assessment/connectors/avature">
    Avature for the Assessment category
  </Card>
</CardGroup>


# Avionté ATS Integration
Source: https://docs.kombo.dev/ats/connectors/avionte

Avionté connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

<Note>This connector requires a partnership with Avionté. Please contact us to get access.</Note>

The Avionté ATS integration allows you to sync ATS data between Avionté and your application through Kombo's unified API. The tool slug for this connector is `avionte`.

## Guides and Resources

<CardGroup>
  <Card title="Avionté API Usage Guide and Limitations" icon="book" href="https://help.kombo.dev/hc/en-us/articles/39793857754257-Aviont%C3%A9-ATS-Usage-Guide-and-Limitations">
    Additional documentation and guides for Avionté.
  </Card>

  <Card title="Becoming a Certified Integration & Connection Guide" icon="book" href="https://help.kombo.dev/hc/en-us/articles/39794442144145-Aviont%C3%A9-Partnership-Connection-Guide">
    Additional documentation and guides for Avionté.
  </Card>
</CardGroup>

## General Notes

* Pipeline applications can only be synced if we have previously received information about them through a webhook. Without this webhook data, pipeline applications cannot be fetched from the API.
* By default, Avionte uses "Selected Job Sync" mode. When you trigger a sync, it will always sync stages and rejection reasons, and sync any jobs you've added to your selected jobs list that haven't been synced yet. Each selected job syncs exactly once, including all applicants and candidates for that job, then relies on webhooks for future updates.
* If you switch to "Full Sync" mode, it will only run during the initial setup sync or when you manually trigger it. After the initial setup, full syncs are disabled. Full sync mode only syncs jobs (not candidates or applications).
* Avionté's API billing is usage-based. To prevent unexpected costs, we rely primarily on webhooks for data freshness after the initial sync. Manual syncs can be triggered anytime from the dashboard but should be used carefully, especially for large instances.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | weekly\_hours        |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | department           |       |
      | post\_url            |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | contact\_id          |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | outcome                 |       |
      | rejection\_reason\_name |       |
      | rejected\_at            |       |
      | current\_stage\_id      |       |
      | job\_id                 |       |
      | candidate\_id           |       |
      | remote\_created\_at     |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        CV attachments (type: 'CV') will appear in the Resume section of the talent profile. Other attachments will appear in the Documents section. Uploading a CV attachment will override any existing CV/resume for the candidate.
      </Note>

      | Input Field                  | Notes |
      | ---------------------------- | ----- |
      | candidate.first\_name        |       |
      | candidate.last\_name         |       |
      | candidate.email\_address     |       |
      | candidate.title              |       |
      | candidate.phone\_number      |       |
      | candidate.location.city      |       |
      | candidate.location.country   |       |
      | candidate.location.zip\_code |       |
      | candidate.gender             |       |
      | application.job\_id          |       |
      | attachments.name             |       |
      | attachments.content\_type    |       |
      | attachments.data\_url        |       |
      | attachments.data             |       |
      | attachments.type             |       |
      | source.name                  |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        CV attachments (type: 'CV') will appear in the Resume section of the talent profile. Other attachments will appear in the Documents section. Uploading a CV attachment will override any existing CV/resume for the candidate.
      </Note>

      | Input Field                  | Notes |
      | ---------------------------- | ----- |
      | candidate.first\_name        |       |
      | candidate.last\_name         |       |
      | candidate.email\_address     |       |
      | candidate.title              |       |
      | candidate.phone\_number      |       |
      | candidate.location.city      |       |
      | candidate.location.country   |       |
      | candidate.location.zip\_code |       |
      | candidate.gender             |       |
      | application.job\_id          |       |
      | attachments.name             |       |
      | attachments.content\_type    |       |
      | attachments.data\_url        |       |
      | attachments.data             |       |
      | attachments.type             |       |
      | source.name                  |       |
    </Accordion>

    <Accordion title="Add tag to candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        Avionte uploads attachments to the candidate. Supported file types: txt, doc, docx, pdf, xls, xlsx, png, jpg, jpeg CV attachments (type: 'CV') will appear in the Resume section of the talent profile. Other attachments will appear in the Documents section. Uploading a CV attachment will override any existing CV/resume for the candidate. This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      <Note>
        Kombo uses two internal stages for the Pipeline and Web Application which candidates cannot be moved to. However candidates can be moved to any stage (including stages in the pipeline) which do not have one of the following remote IDs: 'PIPELINE' and 'WEB\_APPLICATION'
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Reject application">
      <Note>
        Reject application is only supported for applications in the nominated stage. Avionte does not support the rejection of applications in the pipeline or web application stage via API.
      </Note>

      | Input Field           | Notes |
      | --------------------- | ----- |
      | application\_id       |       |
      | rejection\_reason\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      <Note>
        Avionte uploads attachments to the candidate. Supported file types: txt, doc, docx, pdf, xls, xlsx, png, jpg, jpeg CV attachments (type: 'CV') will appear in the Resume section of the talent profile. Other attachments will appear in the Documents section. Uploading a CV attachment will override any existing CV/resume for the candidate.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | API Passthrough       |       |
    | Custom Field Explorer |       |
    | Jobs                  |       |
    | Source Writing        |       |
  </Tab>
</Tabs>


# BambooHR ATS Integration
Source: https://docs.kombo.dev/ats/connectors/bamboohr

BambooHR connector for Kombo's ATS API

The BambooHR ATS integration allows you to sync ATS data between BambooHR and your application through Kombo's unified API. The tool slug for this connector is `bamboohr`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/23347384228113-BambooHR-ATS-How-do-I-link-my-account">
    Step-by-step instructions to connect your BambooHR account to Kombo.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22578041315985-BambooHR-How-to-view-a-candidates-source">
    How to view and manage candidate sources in BambooHR.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      <Note>
        The following fields are only available for jobs with status "Open" and will be null for Draft, On Hold, Filled, and other closed statuses: `description`, `department`, `employment_type`, `experience_level`, and screening questions. This is because BambooHR's public careers page endpoint (`/careers/{jobId}/detail`) only returns data for open jobs and returns 404 for all other statuses.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | description         |       |
      | employment\_type    |       |
      | status              |       |
      | visibility          |       |
      | department          |       |
      | post\_url           |       |
      | experience\_level   |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | opened\_at          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Job postings">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description\_html   |       |
      | status              |       |
      | visibility          |       |
      | url                 |       |
      | job\_id             |       |
      | remote\_data        |       |
      | remote\_created\_at |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Applications">
      <Note>
        We can't easily infer the type of questions for screening question answers.
      </Note>

      | Field                        | Notes |
      | ---------------------------- | ----- |
      | id                           |       |
      | remote\_id                   |       |
      | changed\_at                  |       |
      | remote\_deleted\_at          |       |
      | outcome                      |       |
      | rejection\_reason\_name      |       |
      | rejected\_at                 |       |
      | current\_stage\_id           |       |
      | job\_id                      |       |
      | candidate\_id                |       |
      | screening\_question\_answers |       |
      | custom\_fields               |       |
      | integration\_fields          |       |
      | remote\_url                  |       |
      | remote\_created\_at          |       |
      | remote\_data                 |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        BambooHR only exposes the hiring lead on the job.

        * **hiringLead** (shown as "Hiring Lead" in the UI) maps to unified type `HIRING_MANAGER`
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.location.country            |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.period |       |
      | candidate.salary\_expectations.amount |       |
      | application.job\_id                   |       |
      | attachments.name                      |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | attachments.type                      |       |
      | source.name                           |       |
      | source.unified\_key                   |       |
      | source.id                             |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.location.country            |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.period |       |
      | candidate.salary\_expectations.amount |       |
      | application.job\_id                   |       |
      | attachments.name                      |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | attachments.type                      |       |
      | source.name                           |       |
      | source.unified\_key                   |       |
      | source.id                             |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Reject application">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | application\_id       |       |
      | rejection\_reason\_id |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                                | Notes                                             |
    | -------------------------------------- | ------------------------------------------------- |
    | OAuth                                  |                                                   |
    | API Passthrough                        |                                                   |
    | Scope Testing                          |                                                   |
    | Per Model Tests                        |                                                   |
    | Per Field Tests                        |                                                   |
    | Delta Syncs                            |                                                   |
    | Source Writing                         |                                                   |
    | Sync Only Created Applications         |                                                   |
    | Connection Guide                       |                                                   |
    | Create credentials                     |                                                   |
    | Create Candidate Full Attachment Retry |                                                   |
    | Roles                                  |                                                   |
    | Job roles (e.g. Hiring Manager)        | BambooHR only exposes the hiring lead on the job. |

    * **hiringLead** (shown as "Hiring Lead" in the UI) maps to unified type `HIRING_MANAGER` |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** BambooHR

For **BambooHR**, we also offer the following other connector variants:

<CardGroup>
  <Card title="BambooHR HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/bamboohr/icon.svg" href="/hris/connectors/bamboohr">
    BambooHR for the HRIS category
  </Card>
</CardGroup>


# BITE ATS Integration
Source: https://docs.kombo.dev/ats/connectors/bite

BITE connector for Kombo's ATS API

The BITE ATS integration allows you to sync ATS data between BITE and your application through Kombo's unified API. The tool slug for this connector is `bite`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/17861516586641">
    Step-by-step instructions to connect your BITE account to Kombo.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22566001020433-Bite-How-to-view-a-candidates-source">
    How to view and manage candidate sources in BITE.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      <Note>
        Some jobs may have been deleted from the remote system, but exist in Kombo because candidates are still associated with them. This is because BITE does not filter out candidates from jobs that have been deleted.
      </Note>

      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | post\_url            |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      <Note>
        All stages are returned on all jobs, but in practive BITE even allows restricting specific stages to individual candidates through their "processes" feature. BITE does not require applications to have a stage assigned. In these cases `current_stage_id` will be `null`.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.location.country            |       |
      | candidate.gender                      |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.period |       |
      | candidate.salary\_expectations.amount |       |
      | application.job\_id                   |       |
      | application.stage\_id                 |       |
      | attachments.name                      |       |
      | attachments.content\_type             |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | source.name                           |       |
      | source.unified\_key                   |       |
      | source.id                             |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.location.country            |       |
      | candidate.gender                      |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.period |       |
      | candidate.salary\_expectations.amount |       |
      | application.job\_id                   |       |
      | application.stage\_id                 |       |
      | attachments.name                      |       |
      | attachments.content\_type             |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | source.name                           |       |
      | source.unified\_key                   |       |
      | source.id                             |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        BITE attaches documents to candidates rather than specific applications. The attachment will be associated with the candidate who owns the application.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Custom Field Explorer          |       |
    | Jobs                           |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
    | Prerequisites                  |       |
    | Create credentials             |       |
  </Tab>
</Tabs>


# Brass Ring ATS Integration
Source: https://docs.kombo.dev/ats/connectors/brassring

Brass Ring connector for Kombo's ATS API

<Note>This connector is in closed beta. Please contact us to get access.</Note>

The Brass Ring ATS integration allows you to sync ATS data between Brass Ring and your application through Kombo's unified API. The tool slug for this connector is `brassring`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/45799563977745-BrassRing-How-do-I-link-my-account">
    Step-by-step instructions to connect your Brass Ring account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      <Note>
        Each BrassRing instance exposes different job fields under different field IDs. Configure [job-field remapping](https://docs.kombo.dev/ats/features/remapping/introduction) for this instance based on the field IDs available in your BrassRing SearchAPI feed.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | job\_code           |       |
      | status              |       |
      | visibility          |       |
      | post\_url           |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        BrassRing forwards only the first `CV` attachment as the resume file. `COVER_LETTER` and `OTHER` attachments are omitted.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.state                  |       |
      | candidate.location.street\_1              |       |
      | candidate.location.zip\_code              |       |
      | candidate.gender                          |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        BrassRing forwards only the first `CV` attachment as the resume file. `COVER_LETTER` and `OTHER` attachments are omitted.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.state                  |       |
      | candidate.location.street\_1              |       |
      | candidate.location.zip\_code              |       |
      | candidate.gender                          |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | Scope Testing    |       |
    | Connection Guide |       |
  </Tab>
</Tabs>


# Breezy HR ATS Integration
Source: https://docs.kombo.dev/ats/connectors/breezyhr

Breezy HR connector for Kombo's ATS API

The Breezy HR ATS integration allows you to sync ATS data between Breezy HR and your application through Kombo's unified API. The tool slug for this connector is `breezyhr`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/18292447852945">
    Step-by-step instructions to connect your Breezy HR account to Kombo.
  </Card>

  <Card title="Sandbox Environment" icon="flask" href="https://breezy.hr/signup">
    Access the Breezy HR sandbox environment for testing and development.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | job\_code           |       |
      | description         |       |
      | employment\_type    |       |
      | status              |       |
      | visibility          |       |
      | category            |       |
      | department          |       |
      | post\_url           |       |
      | experience\_level   |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Interviews">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | starting\_at        |       |
      | ending\_at          |       |
      | location            |       |
      | application\_id     |       |
      | stage\_id           |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | required            |       |
      | job\_id             |       |
      | question\_id        |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        BreezyHR provides a list of job admins and users

        * Users in **all\_admins** map to unified type `HIRING_MANAGER`
        * Users only in **all\_users** (not in **all\_admins**) have no unified type.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Interviewing team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | interview\_id       |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Due to a limitation in the Breezy API we have to fetch all jobs to find the job the application needs to be created for, even if jobs are disabled in the scope config.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Due to a limitation in the Breezy API we have to fetch all jobs to find the job the application needs to be created for, even if jobs are disabled in the scope config.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        Due to a limitation in the Breezy API we have to fetch all jobs to add the attachments, even if jobs are disabled in the scope config. This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      <Note>
        Due to a limitation in the Breezy API we have to fetch all jobs to move the application stage, even if jobs are disabled in the scope config.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Add result link to application">
      <Note>
        Due to a limitation in the Breezy API we have to fetch all jobs to add a result link, even if jobs are disabled in the scope config.
      </Note>

      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Get application attachments">
      <Note>
        All attachment types are considered as OTHER. Breezy does not provide the attachment type in the API response. Due to a limitation in the Breezy API we have to fetch all jobs to get application attachments, even if jobs are disabled in the scope config.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      <Note>
        Due to a limitation in the Breezy API we have to fetch all jobs to add the attachments, even if jobs are disabled in the scope config.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
    </Accordion>

    <Accordion title="Add result link to candidate">
      <Note>
        Due to a limitation in the Breezy API we have to fetch all jobs to add a result link, even if jobs are disabled in the scope config.
      </Note>

      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | candidate\_id                       |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                         | Notes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | API Passthrough                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    | Webhook Subscriptions           | Webhook subscriptions require a BreezyHR Pro plan. Kombo automatically creates one webhook endpoint per company in the connection. BreezyHR limits customers to 10 endpoints per owner. candidateAdded: triggered when a candidate is created (applied, sourced, recruited, or referred) candidateStatusUpdated: triggered when an application stage changed (candidate moved from one stage in a pipeline to another) candidateDeleted: triggered when a candidate is deleted via the web application (not fired for GDPR auto-delete purges) companyPositionAdded: triggered when a new position is created companyPositionUpdated: triggered when a position's details are updated (name, description, requirements, etc.) companyPositionStateUpdated: triggered when a position's state changes (e.g. a job is published, unpublished, moved to draft, or closed) companyPositionDeleted: triggered when a position is deleted from the company Not covered: a candidate is updated without a stage change (e.g. profile edits) Not covered: a tag was assigned to a candidate Not covered: an interview was scheduled Not covered: an interview was updated Not covered: screening questions were updated for a job Not covered: a candidate is purged via GDPR auto-delete configuration |
    | Automatic Setup                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    | Delta Syncs                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    | Source Writing                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    | Connection Guide                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    | Prerequisites                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    | Create credentials              |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    | Candidate Cutoff Filtering      |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    | Roles                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    | Job roles (e.g. Hiring Manager) | BreezyHR provides a list of job admins and users                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |

    * Users in **all\_admins** map to unified type `HIRING_MANAGER`
    * Users only in **all\_users** (not in **all\_admins**) have no unified type. |
  </Tab>
</Tabs>


# Bullhorn ATS Integration
Source: https://docs.kombo.dev/ats/connectors/bullhorn

Bullhorn connector for Kombo's ATS API

The Bullhorn ATS integration allows you to sync ATS data between Bullhorn and your application through Kombo's unified API. The tool slug for this connector is `bullhorn`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/17847586001297-How-do-I-link-my-Bullhorn-account-">
    Step-by-step instructions to connect your Bullhorn account to Kombo.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22537230486801-Bullhorn-How-to-view-a-candidates-source">
    How to view and manage candidate sources in Bullhorn.
  </Card>

  <Card title="How to setup screening questions in Bullhorn" icon="book" href="https://help.kombo.dev/hc/en-us/articles/24274854500753-Bullhorn-How-to-setup-a-custom-object-as-screening-questions">
    Additional documentation and guides for Bullhorn.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | description         |       |
      | weekly\_hours       |       |
      | employment\_type    |       |
      | status              |       |
      | visibility          |       |
      | category            |       |
      | experience\_level   |       |
      | salary\_amount      |       |
      | salary\_period      |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | closed\_at          |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | outcome                 |       |
      | rejection\_reason\_name |       |
      | current\_stage\_id      |       |
      | job\_id                 |       |
      | candidate\_id           |       |
      | custom\_fields          |       |
      | integration\_fields     |       |
      | remote\_created\_at     |       |
      | remote\_updated\_at     |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        Bullhorn exposes two user relations per job.

        * **clientContact** (shown as "Contact" in the UI) maps to `HIRING_MANAGER`
        * **owner** (shown as "Consultant" in the UI) maps to `RECRUITER`
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="User roles">
      <Note>
        Bullhorn assigns each CorporateUser a `userType` object with an id and name. ClientContact users are external contacts and have no system role synced.

        * `Administrator` maps to unified type `ADMIN`
        * All other userType names sync without a unified type.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | user\_id            |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Screening question answers are stored on the candidate, not the submission. Therefore, if a candidate applies to multiple jobs it will not be apparent in the UI which screening question answer set belongs to which submission.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.zip\_code              |       |
      | candidate.gender                          |       |
      | candidate.availability\_date              |       |
      | candidate.salary\_expectations.period     |       |
      | candidate.salary\_expectations.amount     |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | sourced\_by.user\_id                      |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Screening question answers are stored on the candidate, not the submission. Therefore, if a candidate applies to multiple jobs it will not be apparent in the UI which screening question answer set belongs to which submission.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.zip\_code              |       |
      | candidate.gender                          |       |
      | candidate.availability\_date              |       |
      | candidate.salary\_expectations.period     |       |
      | candidate.salary\_expectations.amount     |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | sourced\_by.user\_id                      |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Reject application">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | application\_id       |       |
      | rejection\_reason\_id |       |
      | note                  |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      <Note>
        In Bullhorn an applications may be deleted when a position is filled. Consider calling [get candidate attachments](/ats/v1/get-candidates-candidate-id-attachments) instead, because it will return attachments related to a candidate, including all attachments from all of their applications.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Add result link to candidate">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | candidate\_id                       |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes                                                                                                                                                  |
    | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
    | OAuth                          |                                                                                                                                                        |
    | API Passthrough                |                                                                                                                                                        |
    | Delta Syncs                    |                                                                                                                                                        |
    | Source Writing                 |                                                                                                                                                        |
    | Sync Only Created Applications |                                                                                                                                                        |
    | Connection Guide               |                                                                                                                                                        |
    | Prerequisites                  |                                                                                                                                                        |
    | Create credentials             |                                                                                                                                                        |
    | Candidate Cutoff Filtering     |                                                                                                                                                        |
    | Roles                          |                                                                                                                                                        |
    | System roles (e.g. Admin)      | Bullhorn assigns each CorporateUser a `userType` object with an id and name. ClientContact users are external contacts and have no system role synced. |

    * `Administrator` maps to unified type `ADMIN`
    * All other userType names sync without a unified type. |
      \|   Job roles (e.g. Hiring Manager) | Bullhorn exposes two user relations per job.
    * **clientContact** (shown as "Contact" in the UI) maps to `HIRING_MANAGER`
    * **owner** (shown as "Consultant" in the UI) maps to `RECRUITER` |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Choose this variant to use OAuth-based authentication (recommended)

For **Bullhorn**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Bullhorn Login" icon="https://storage.googleapis.com/kombo-assets/integrations/bullhornlogin/icon.svg" href="/ats/connectors/bullhornlogin">
    Legacy login-based variant. This variant is deprecated and merged into the regular Bullhorn integration
  </Card>

  <Card title="Bullhorn Assessment" icon="https://storage.googleapis.com/kombo-assets/integrations/bullhorn/icon.svg" href="/assessment/connectors/bullhorn">
    Bullhorn for the Assessment category
  </Card>
</CardGroup>

<Note>You can only use one variant at a time.</Note>


# Bullhorn for Salesforce ATS Integration
Source: https://docs.kombo.dev/ats/connectors/bullhorn4salesforce

Bullhorn for Salesforce connector for Kombo's ATS API

<Note>This connector is in closed beta. Please contact us to get access.</Note>

The Bullhorn for Salesforce ATS integration allows you to sync ATS data between Bullhorn for Salesforce and your application through Kombo's unified API. The tool slug for this connector is `bullhorn4salesforce`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/46620810469649-Bullhorn-for-Salesforce-Setup-Guide">
    Step-by-step instructions to connect your Bullhorn for Salesforce account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | confidential         |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | category             |       |
      | department           |       |
      | post\_url            |       |
      | experience\_level    |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_url          |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | outcome                 |       |
      | rejection\_reason\_name |       |
      | current\_stage\_id      |       |
      | job\_id                 |       |
      | candidate\_id           |       |
      | custom\_fields          |       |
      | integration\_fields     |       |
      | remote\_url             |       |
      | remote\_created\_at     |       |
      | remote\_updated\_at     |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Add attachment to application">
      <Note>
        Attachments are linked to the candidate (Contact) in Salesforce, not directly to the application. This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      <Note>
        Moving a Job Board Application converts it into a new Application: the Job Board Application is marked as `Converted` in Bullhorn and a fresh Application record is created in its place. Job Board Applications can only be converted once — moving the same Job Board Application twice fails with `APPLICATION_ALREADY_EXISTS`. Application stages are surfaced per job RecordType, but — depending on the org's Salesforce config — not every stage exposed on a job is selectable: `TR1__Stage__c` may be a restricted picklist, in which case moving to a value it doesn't accept fails with `INVALID_OR_NULL_FOR_RESTRICTED_PICKLIST`.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Add result link to application">
      <Note>
        Result links are created as Salesforce Tasks.
      </Note>

      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      <Note>
        Notes are created as Salesforce Tasks.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      <Note>
        Attachments are linked to the candidate (Contact) in Salesforce, not directly to the application.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes                                                                                                                                                                                                                                                           |
    | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | API Passthrough       |                                                                                                                                                                                                                                                                 |
    | Scope Testing         |                                                                                                                                                                                                                                                                 |
    | Per Model Tests       |                                                                                                                                                                                                                                                                 |
    | Per Field Tests       | Read-side: asserts every field in BH4SF\_SYNC\_QUERY\_FIELDS.contact/.application/.job is present in the describe response. Write-side: asserts updateable on each field written by a known action (currently: TR1\_\_Stage\_\_c for kpAtsSetApplicationStage). |
    | Delta Syncs           |                                                                                                                                                                                                                                                                 |
    | Custom Field Explorer |                                                                                                                                                                                                                                                                 |
    | Jobs                  |                                                                                                                                                                                                                                                                 |
    | Candidates            |                                                                                                                                                                                                                                                                 |
    | Applications          |                                                                                                                                                                                                                                                                 |
    | Connection Guide      |                                                                                                                                                                                                                                                                 |
  </Tab>
</Tabs>


# Bullhorn Login ATS Integration
Source: https://docs.kombo.dev/ats/connectors/bullhornlogin

Bullhorn Login connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Bullhorn Login ATS integration allows you to sync ATS data between Bullhorn Login and your application through Kombo's unified API. The tool slug for this connector is `bullhornlogin`.

## Guides and Resources

<CardGroup>
  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22537230486801-Bullhorn-How-to-view-a-candidates-source">
    How to view and manage candidate sources in Bullhorn Login.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | description         |       |
      | weekly\_hours       |       |
      | employment\_type    |       |
      | status              |       |
      | visibility          |       |
      | category            |       |
      | experience\_level   |       |
      | salary\_amount      |       |
      | salary\_period      |       |
      | location            |       |
      | closed\_at          |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.company                     |       |
      | candidate.title                       |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.gender                      |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.period |       |
      | candidate.salary\_expectations.amount |       |
      | application.job\_id                   |       |
      | application.stage\_id                 |       |
      | attachments.name                      |       |
      | attachments.content\_type             |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | attachments.type                      |       |
      | source.name                           |       |
      | source.unified\_key                   |       |
      | source.id                             |       |
      | sourced\_by.user\_id                  |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.company                     |       |
      | candidate.title                       |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.gender                      |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.period |       |
      | candidate.salary\_expectations.amount |       |
      | application.job\_id                   |       |
      | application.stage\_id                 |       |
      | attachments.name                      |       |
      | attachments.content\_type             |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | attachments.type                      |       |
      | source.name                           |       |
      | source.unified\_key                   |       |
      | source.id                             |       |
      | sourced\_by.user\_id                  |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Add result link to candidate">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | candidate\_id                       |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Legacy login-based variant. This variant is deprecated and merged into the regular Bullhorn integration

For **Bullhorn Login**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Bullhorn" icon="https://storage.googleapis.com/kombo-assets/integrations/bullhorn/icon.svg" href="/ats/connectors/bullhorn">
    Choose this variant to use OAuth-based authentication (recommended)
  </Card>
</CardGroup>

<Note>You can only use one variant at a time.</Note>


# CareerPlug ATS Integration
Source: https://docs.kombo.dev/ats/connectors/careerplug

CareerPlug connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The CareerPlug ATS integration allows you to sync ATS data between CareerPlug and your application through Kombo's unified API. The tool slug for this connector is `careerplug`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/28145726571665-CareerPlug-ATS-How-do-I-link-my-account">
    Step-by-step instructions to connect your CareerPlug account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | description         |       |
      | employment\_type    |       |
      | status              |       |
      | visibility          |       |
      | department          |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | contact\_id         |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        CareerPlug only exposes an owner for the job

        * **owner** maps to unified type `HIRING_MANAGER`
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="User roles">
      <Note>
        Each user in Careerplug has a single **role** id

        * **owner** maps to unified type `ADMIN`
        * **recruiter** maps to unified type `RECRUITER`
        * **recruiter\_admin**, **employee**, and any other **role** have no unified type.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | user\_id            |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        CareerPlug only supports submitting 1 CV attachment and not other types of attachments. CareerPlug requires a CV to be submitted.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.salary\_expectations.period     |       |
      | candidate.salary\_expectations.amount     |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        CareerPlug only supports submitting 1 CV attachment and not other types of attachments. CareerPlug requires a CV to be submitted.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.salary\_expectations.period     |       |
      | candidate.salary\_expectations.amount     |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes                                            |
    | ------------------------------ | ------------------------------------------------ |
    | API Passthrough                |                                                  |
    | Source Writing                 |                                                  |
    | Sync Only Created Applications |                                                  |
    | Connection Guide               |                                                  |
    | Prerequisites                  |                                                  |
    | Roles                          |                                                  |
    | System roles (e.g. Admin)      | Each user in Careerplug has a single **role** id |

    * **owner** maps to unified type `ADMIN`
    * **recruiter** maps to unified type `RECRUITER`
    * **recruiter\_admin**, **employee**, and any other **role** have no unified type. |
      \|   Job roles (e.g. Hiring Manager) | CareerPlug only exposes an owner for the job
    * **owner** maps to unified type `HIRING_MANAGER` |
  </Tab>
</Tabs>


# Carerix ATS Integration
Source: https://docs.kombo.dev/ats/connectors/carerix

Carerix connector for Kombo's ATS API

The Carerix ATS integration allows you to sync ATS data between Carerix and your application through Kombo's unified API. The tool slug for this connector is `carerix`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/22346577290769-Carerix-ATS-How-do-I-link-my-account">
    Step-by-step instructions to connect your Carerix account to Kombo.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22570160748561-Carerix-How-to-view-a-candidates-source">
    How to view and manage candidate sources in Carerix.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | confidential         |       |
      | weekly\_hours        |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | category             |       |
      | department           |       |
      | experience\_level    |       |
      | remote\_work\_status |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | contact\_id          |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | title               |       |
      | confidential        |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      <Note>
        Carerix exposes hiring team via the contact (toContact), owner, and vacancyUsers fields. You can ask our support team to configure this for you.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.title                       |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.amount |       |
      | candidate.social\_links.url           |       |
      | application.job\_id                   |       |
      | attachments.name                      |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | source.name                           |       |
      | source.unified\_key                   |       |
      | source.id                             |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.title                       |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.amount |       |
      | candidate.social\_links.url           |       |
      | application.job\_id                   |       |
      | attachments.name                      |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | source.name                           |       |
      | source.unified\_key                   |       |
      | source.id                             |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | application\_id      |       |
      | attachment.name      |       |
      | attachment.data\_url |       |
      | attachment.data      |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      | Input Field          | Notes |
      | -------------------- | ----- |
      | candidate\_id        |       |
      | attachment.name      |       |
      | attachment.data\_url |       |
      | attachment.data      |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Custom Field Explorer          |       |
    | Jobs                           |       |
    | Applications                   |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
    | Prerequisites                  |       |
    | Create credentials             |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Legacy Carerix XML/REST API. Carerix provides no further updates or support for it, so prefer the GraphQL variant for new integrations.

For **Carerix**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Carerix (GraphQL)" icon="https://storage.googleapis.com/kombo-assets/integrations/carerixgraphql/icon.svg" href="/ats/connectors/carerixgraphql">
    Carerix GraphQL API. Recommended for new integrations.
  </Card>
</CardGroup>

<Note>Multiple variants can be used within your Kombo environment at the same time.</Note>


# Carerix (GraphQL) ATS Integration
Source: https://docs.kombo.dev/ats/connectors/carerixgraphql

Carerix connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Carerix ATS integration allows you to sync ATS data between Carerix and your application through Kombo's unified API. The tool slug for this connector is `carerixgraphql`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/48749227451665-Carerix-GraphQL-Connection-Guide">
    Step-by-step instructions to connect your Carerix account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | confidential         |       |
      | weekly\_hours        |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | category             |       |
      | department           |       |
      | post\_url            |       |
      | experience\_level    |       |
      | remote\_work\_status |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | contact\_id          |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Job postings">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description\_html   |       |
      | status              |       |
      | visibility          |       |
      | url                 |       |
      | job\_id             |       |
      | remote\_data        |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | confidential        |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes                                                                                                       |
      | ------------------- | ----------------------------------------------------------------------------------------------------------- |
      | id                  |                                                                                                             |
      | remote\_id          |                                                                                                             |
      | changed\_at         |                                                                                                             |
      | remote\_deleted\_at |                                                                                                             |
      | outcome             | Carerix match statuses carry `isFinal` and `isSuccessfullyFilled` flags, from which the outcome is derived: |

      * A non-final status (or a match with no status) maps to `PENDING`.
      * A final, successfully-filled status maps to `HIRED`.
      * Any other final status maps to `DECLINED`. |
        \| rejection\_reason\_name |  |
        \| current\_stage\_id |  |
        \| job\_id |  |
        \| candidate\_id |  |
        \| custom\_fields |  |
        \| integration\_fields |  |
        \| remote\_created\_at |  |
        \| remote\_updated\_at |  |
        \| remote\_data |  |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        Carerix assigns hiring-team members to a vacancy via `vacancyUsers`, each optionally carrying a role node. Role names are admin-configurable free text (often Dutch) and mapped by keyword.

        * "recruit"/"consultant" maps to `RECRUITER`
        * "hoofdcontactpersoon"/"hiring"/"manager" maps to `HIRING_MANAGER`
        * "coordinator" maps to `COORDINATOR`, "sourcer" to `SOURCER`, "interviewer" to `INTERVIEWER`
        * Members without a role, or with an unrecognized role, sync without a unified type.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="User roles">
      <Note>
        Carerix assigns each user a single system role (its user-role profile). Role names are admin-configurable free text (often Dutch) and mapped by keyword.

        * Names containing "admin"/"beheerder" map to `ADMIN`
        * "recruit"/"consultant" maps to `RECRUITER`
        * "hoofdcontactpersoon"/"hiring"/"manager" maps to `HIRING_MANAGER`
        * "coordinator" maps to `COORDINATOR`, "sourcer" to `SOURCER`, "interviewer" to `INTERVIEWER`
        * Candidate profiles (role "Kandidaat") are excluded from users and synced as candidates instead.
        * Other roles sync without a unified type.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | user\_id            |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.title                       |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.amount |       |
      | application.job\_id                   |       |
      | application.stage\_id                 |       |
      | attachments.name                      |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | source.name                           |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.title                       |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.amount |       |
      | application.job\_id                   |       |
      | application.stage\_id                 |       |
      | attachments.name                      |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | source.name                           |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        Carerix stores attachments on the candidate, so a file added to an application is attached to that application's candidate. Carerix stores attachments on the candidate, so the file is attached directly to the candidate record.
      </Note>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | application\_id      |       |
      | attachment.name      |       |
      | attachment.data\_url |       |
      | attachment.data      |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Add result link to application">
      <Note>
        Carerix has no native result-link feature, so the link is added as a note on the application: the label becomes the note subject, and the URL (plus any score/attribute details) is written into the note body.
      </Note>

      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      <Note>
        Carerix stores attachments on the candidate, so the file is attached directly to the candidate record.
      </Note>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | candidate\_id        |       |
      | attachment.name      |       |
      | attachment.data\_url |       |
      | attachment.data      |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes                                                                                                                                                    |
    | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | API Passthrough                |                                                                                                                                                          |
    | Scope Testing                  |                                                                                                                                                          |
    | Per Model Tests                |                                                                                                                                                          |
    | Delta Syncs                    |                                                                                                                                                          |
    | Custom Field Explorer          |                                                                                                                                                          |
    | Jobs                           |                                                                                                                                                          |
    | Candidates                     |                                                                                                                                                          |
    | Applications                   |                                                                                                                                                          |
    | Source Writing                 |                                                                                                                                                          |
    | Sync Only Created Applications |                                                                                                                                                          |
    | Connection Guide               |                                                                                                                                                          |
    | Roles                          |                                                                                                                                                          |
    | System roles (e.g. Admin)      | Carerix assigns each user a single system role (its user-role profile). Role names are admin-configurable free text (often Dutch) and mapped by keyword. |

    * Names containing "admin"/"beheerder" map to `ADMIN`
    * "recruit"/"consultant" maps to `RECRUITER`
    * "hoofdcontactpersoon"/"hiring"/"manager" maps to `HIRING_MANAGER`
    * "coordinator" maps to `COORDINATOR`, "sourcer" to `SOURCER`, "interviewer" to `INTERVIEWER`
    * Candidate profiles (role "Kandidaat") are excluded from users and synced as candidates instead.
    * Other roles sync without a unified type. |
      \|   Job roles (e.g. Hiring Manager) | Carerix assigns hiring-team members to a vacancy via `vacancyUsers`, each optionally carrying a role node. Role names are admin-configurable free text (often Dutch) and mapped by keyword.
    * "recruit"/"consultant" maps to `RECRUITER`
    * "hoofdcontactpersoon"/"hiring"/"manager" maps to `HIRING_MANAGER`
    * "coordinator" maps to `COORDINATOR`, "sourcer" to `SOURCER`, "interviewer" to `INTERVIEWER`
    * Members without a role, or with an unrecognized role, sync without a unified type. |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Carerix GraphQL API. Recommended for new integrations.

For **Carerix**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Carerix" icon="https://storage.googleapis.com/kombo-assets/integrations/carerix/icon.svg" href="/ats/connectors/carerix">
    Legacy Carerix XML/REST API. Carerix provides no further updates or support for it, so prefer the GraphQL variant for new integrations.
  </Card>
</CardGroup>

<Note>Multiple variants can be used within your Kombo environment at the same time.</Note>


# Ceipal ATS Integration
Source: https://docs.kombo.dev/ats/connectors/ceipal

Ceipal connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Ceipal ATS integration allows you to sync ATS data between Ceipal and your application through Kombo's unified API. The tool slug for this connector is `ceipal`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/42080358551825-Ceipal-How-do-I-link-my-account">
    Step-by-step instructions to connect your Ceipal account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | weekly\_hours        |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | category             |       |
      | department           |       |
      | post\_url            |       |
      | experience\_level    |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Job postings">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description\_html   |       |
      | status              |       |
      | visibility          |       |
      | url                 |       |
      | job\_id             |       |
      | remote\_data        |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Ceipal API does not pass through the salary period. We combine this with the amount you provided to send through a combined text
      </Note>

      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.title                       |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.location.country            |       |
      | candidate.location.state              |       |
      | candidate.location.zip\_code          |       |
      | candidate.gender                      |       |
      | candidate.salary\_expectations.period |       |
      | candidate.salary\_expectations.amount |       |
      | candidate.social\_links.url           |       |
      | application.job\_id                   |       |
      | attachments.name                      |       |
      | attachments.content\_type             |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | attachments.type                      |       |
      | source.name                           |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Ceipal API does not pass through the salary period. We combine this with the amount you provided to send through a combined text
      </Note>

      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.title                       |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.location.country            |       |
      | candidate.location.state              |       |
      | candidate.location.zip\_code          |       |
      | candidate.gender                      |       |
      | candidate.salary\_expectations.period |       |
      | candidate.salary\_expectations.amount |       |
      | candidate.social\_links.url           |       |
      | application.job\_id                   |       |
      | attachments.name                      |       |
      | attachments.content\_type             |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | attachments.type                      |       |
      | source.name                           |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
    | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
    | API Passthrough       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    | Webhook Subscriptions | applicant\_created: triggered when a candidate (applicant) was created applicant\_updated: triggered when a candidate (applicant) was updated applicant\_status\_changed: triggered when a candidate (applicant) status was changed submission\_created: triggered when a submission (application) was created submission\_status\_change: triggered when an application/submission stage was changed submission\_status\_changed: triggered when an application/submission stage was changed pipeline\_status\_changed: triggered when an application pipeline stage was changed pipeline\_updated: triggered when an application pipeline was updated job\_created: triggered when a job posting was created job\_updated: triggered when a job posting was updated job\_status\_changed: triggered when a job posting status was changed Not covered: a tag was assigned to a candidate Not covered: an interview was scheduled Not covered: an interview was updated Not covered: a job was published to a job board Not covered: a job was unpublished from a job board Not covered: screening questions updated on a job |
    | Scope Testing         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    | Per Model Tests       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    | Delta Syncs           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    | Source Writing        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    | Connection Guide      |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
  </Tab>
</Tabs>


# Spark Hire Recruit ATS Integration
Source: https://docs.kombo.dev/ats/connectors/comeet

Spark Hire Recruit connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Spark Hire Recruit ATS integration allows you to sync ATS data between Spark Hire Recruit and your application through Kombo's unified API. The tool slug for this connector is `comeet`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/30828293023889-Spark-Hire-Recruit-How-do-I-link-my-account">
    Step-by-step instructions to connect your Spark Hire Recruit account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | department           |       |
      | post\_url            |       |
      | experience\_level    |       |
      | remote\_work\_status |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_url          |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | outcome                 |       |
      | rejection\_reason\_name |       |
      | rejected\_at            |       |
      | current\_stage\_id      |       |
      | job\_id                 |       |
      | candidate\_id           |       |
      | remote\_url             |       |
      | remote\_created\_at     |       |
      | remote\_updated\_at     |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | remote\_data        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.location.country            |       |
      | candidate.location.zip\_code          |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.period |       |
      | candidate.salary\_expectations.amount |       |
      | candidate.social\_links.url           |       |
      | application.job\_id                   |       |
      | attachments.name                      |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | attachments.type                      |       |
      | gdpr\_consent.given                   |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.location.country            |       |
      | candidate.location.zip\_code          |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.period |       |
      | candidate.salary\_expectations.amount |       |
      | candidate.social\_links.url           |       |
      | application.job\_id                   |       |
      | attachments.name                      |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | attachments.type                      |       |
      | gdpr\_consent.given                   |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      <Note>
        We can only read attachmnets of type resume.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Scope Testing                  |       |
    | Per Model Tests                |       |
    | Per Field Tests                |       |
    | Delta Syncs                    |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
    | Prerequisites                  |       |
    | Create credentials             |       |
  </Tab>
</Tabs>


# Compleet (only PersoProfiler) ATS Integration
Source: https://docs.kombo.dev/ats/connectors/compleet

Compleet (PersoProfiler) connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Compleet (PersoProfiler) ATS integration allows you to sync ATS data between Compleet (PersoProfiler) and your application through Kombo's unified API. The tool slug for this connector is `compleet`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/30302293907729-Compleet-How-do-I-link-my-account">
    Step-by-step instructions to connect your Compleet (PersoProfiler) account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      <Note>
        Compleet API does not support pagination, we can only fetch the first 3500 jobs.
      </Note>

      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | weekly\_hours        |       |
      | employment\_type     |       |
      | category             |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      <Note>
        Candidates can't be read from Compleet but can be created.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Applications">
      <Note>
        Applications can't be read from Compleet but can be created.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.location.country            |       |
      | candidate.location.zip\_code          |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.amount |       |
      | application.job\_id                   |       |
      | attachments.name                      |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | gdpr\_consent.given                   |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.location.country            |       |
      | candidate.location.zip\_code          |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.amount |       |
      | application.job\_id                   |       |
      | attachments.name                      |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | gdpr\_consent.given                   |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | Connection Guide |       |
    | Prerequisites    |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Legacy variant using the older PersoProfiler API. Prefer the Pitcher or Persy variants for new integrations.

For **Compleet (PersoProfiler)**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Compleet (Pitcher API)" icon="https://storage.googleapis.com/kombo-assets/integrations/compleetpitcher/icon.svg" href="/ats/connectors/compleetpitcher">
    We recommend using the Compleet Pitcher variant as it supports multiple Compleet products and is easier to configure.
  </Card>

  <Card title="Compleet (Persy API)" icon="https://storage.googleapis.com/kombo-assets/integrations/compleetpersy/icon.svg" href="/ats/connectors/compleetpersy">
    Choose this variant to read candidate profiles and attachments from the Persy REST API.
  </Card>
</CardGroup>

<Note>Multiple variants can be used within your Kombo environment at the same time.</Note>


# Compleet (Persy API) ATS Integration
Source: https://docs.kombo.dev/ats/connectors/compleetpersy

Compleet (Persy) connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Compleet (Persy) ATS integration allows you to sync ATS data between Compleet (Persy) and your application through Kombo's unified API. The tool slug for this connector is `compleetpersy`.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      <Note>
        Jobs are derived from the `PositionOpening` attached to candidates returned by the candidates endpoint, since the API has no dedicated jobs endpoint. Only the ID and title of the opening are available.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | confidential        |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      <Note>
        The API has no application ID, so we derive a deterministic one from the candidate ID and the position opening ID.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                    | Notes |
    | -------------------------- | ----- |
    | API Passthrough            |       |
    | Delta Syncs                |       |
    | Custom Field Explorer      |       |
    | Candidates                 |       |
    | Candidate Cutoff Filtering |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Choose this variant to read candidate profiles and attachments from the Persy REST API.

For **Compleet (Persy)**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Compleet (Pitcher API)" icon="https://storage.googleapis.com/kombo-assets/integrations/compleetpitcher/icon.svg" href="/ats/connectors/compleetpitcher">
    We recommend using the Compleet Pitcher variant as it supports multiple Compleet products and is easier to configure.
  </Card>

  <Card title="Compleet (only PersoProfiler)" icon="https://storage.googleapis.com/kombo-assets/integrations/compleet/icon.svg" href="/ats/connectors/compleet">
    Legacy variant using the older PersoProfiler API. Prefer the Pitcher or Persy variants for new integrations.
  </Card>
</CardGroup>

<Note>Multiple variants can be used within your Kombo environment at the same time.</Note>


# Compleet (Pitcher API) ATS Integration
Source: https://docs.kombo.dev/ats/connectors/compleetpitcher

Compleet connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Compleet ATS integration allows you to sync ATS data between Compleet and your application through Kombo's unified API. The tool slug for this connector is `compleetpitcher`.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      <Note>
        We extract job data from XML feeds. Date parsing assumes DD.MM.YYYY format.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | job\_code           |       |
      | description         |       |
      | employment\_type    |       |
      | status              |       |
      | visibility          |       |
      | department          |       |
      | post\_url           |       |
      | experience\_level   |       |
      | salary\_currency    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | opened\_at          |       |
      | closed\_at          |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.location.country            |       |
      | candidate.location.zip\_code          |       |
      | candidate.gender                      |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.period |       |
      | candidate.salary\_expectations.amount |       |
      | application.job\_id                   |       |
      | attachments.name                      |       |
      | attachments.content\_type             |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | attachments.type                      |       |
      | source.name                           |       |
      | source.unified\_key                   |       |
      | source.id                             |       |
      | gdpr\_consent.expires\_at             |       |
      | gdpr\_consent.given                   |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.location.country            |       |
      | candidate.location.zip\_code          |       |
      | candidate.gender                      |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.period |       |
      | candidate.salary\_expectations.amount |       |
      | application.job\_id                   |       |
      | attachments.name                      |       |
      | attachments.content\_type             |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | attachments.type                      |       |
      | source.name                           |       |
      | source.unified\_key                   |       |
      | source.id                             |       |
      | gdpr\_consent.expires\_at             |       |
      | gdpr\_consent.given                   |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature         | Notes |
    | --------------- | ----- |
    | API Passthrough |       |
    | Source Writing  |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** We recommend using the Compleet Pitcher variant as it supports multiple Compleet products and is easier to configure.

For **Compleet**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Compleet (Persy API)" icon="https://storage.googleapis.com/kombo-assets/integrations/compleetpersy/icon.svg" href="/ats/connectors/compleetpersy">
    Choose this variant to read candidate profiles and attachments from the Persy REST API.
  </Card>

  <Card title="Compleet (only PersoProfiler)" icon="https://storage.googleapis.com/kombo-assets/integrations/compleet/icon.svg" href="/ats/connectors/compleet">
    Legacy variant using the older PersoProfiler API. Prefer the Pitcher or Persy variants for new integrations.
  </Card>
</CardGroup>

<Note>Multiple variants can be used within your Kombo environment at the same time.</Note>


# concludis ATS Integration
Source: https://docs.kombo.dev/ats/connectors/concludis

concludis connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

<Note>This connector requires a partnership with concludis. Check out our [partnership guide](https://help.kombo.dev/hc/en-us/articles/29131010771601-Concludis-How-to-get-your-Partner-Credentials) to learn more.</Note>

The concludis ATS integration allows you to sync ATS data between concludis and your application through Kombo's unified API. The tool slug for this connector is `concludis`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/20307469634577">
    Step-by-step instructions to connect your concludis account to Kombo.
  </Card>

  <Card title="Partnership Guide" icon="handshake" href="https://help.kombo.dev/hc/en-us/articles/29131010771601-Concludis-How-to-get-your-Partner-Credentials">
    Learn how to become a partner with concludis to enable this integration.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22571476002065">
    How to view and manage candidate sources in concludis.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | description         |       |
      | employment\_type    |       |
      | status              |       |
      | visibility          |       |
      | category            |       |
      | post\_url           |       |
      | experience\_level   |       |
      | location            |       |
      | custom\_fields      |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        WebP attachments are skipped because Concludis fails to preprocess them
      </Note>

      | Input Field                               | Notes                                                                                          |
      | ----------------------------------------- | ---------------------------------------------------------------------------------------------- |
      | candidate.first\_name                     |                                                                                                |
      | candidate.last\_name                      |                                                                                                |
      | candidate.email\_address                  |                                                                                                |
      | candidate.company                         |                                                                                                |
      | candidate.title                           |                                                                                                |
      | candidate.phone\_number                   |                                                                                                |
      | candidate.location.city                   |                                                                                                |
      | candidate.location.country                |                                                                                                |
      | candidate.location.street\_1              |                                                                                                |
      | candidate.location.zip\_code              |                                                                                                |
      | candidate.gender                          |                                                                                                |
      | application.job\_id                       |                                                                                                |
      | screening\_question\_answers.question\_id |                                                                                                |
      | screening\_question\_answers.answer       |                                                                                                |
      | attachments.name                          |                                                                                                |
      | attachments.content\_type                 |                                                                                                |
      | attachments.data\_url                     |                                                                                                |
      | attachments.data                          |                                                                                                |
      | attachments.type                          |                                                                                                |
      | source.name                               | Concludis can only be used as a partner and you can set the Source ID in the partner settings. |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        WebP attachments are skipped because Concludis fails to preprocess them
      </Note>

      | Input Field                               | Notes                                                                                          |
      | ----------------------------------------- | ---------------------------------------------------------------------------------------------- |
      | candidate.first\_name                     |                                                                                                |
      | candidate.last\_name                      |                                                                                                |
      | candidate.email\_address                  |                                                                                                |
      | candidate.company                         |                                                                                                |
      | candidate.title                           |                                                                                                |
      | candidate.phone\_number                   |                                                                                                |
      | candidate.location.city                   |                                                                                                |
      | candidate.location.country                |                                                                                                |
      | candidate.location.street\_1              |                                                                                                |
      | candidate.location.zip\_code              |                                                                                                |
      | candidate.gender                          |                                                                                                |
      | application.job\_id                       |                                                                                                |
      | screening\_question\_answers.question\_id |                                                                                                |
      | screening\_question\_answers.answer       |                                                                                                |
      | attachments.name                          |                                                                                                |
      | attachments.content\_type                 |                                                                                                |
      | attachments.data\_url                     |                                                                                                |
      | attachments.data                          |                                                                                                |
      | attachments.type                          |                                                                                                |
      | source.name                               | Concludis can only be used as a partner and you can set the Source ID in the partner settings. |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | Source Writing   |       |
    | Connection Guide |       |
    | Prerequisites    |       |
  </Tab>
</Tabs>


# Connexys By Bullhorn ATS Integration
Source: https://docs.kombo.dev/ats/connectors/connexys

Connexys By Bullhorn connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Connexys By Bullhorn ATS integration allows you to sync ATS data between Connexys By Bullhorn and your application through Kombo's unified API. The tool slug for this connector is `connexys`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/27683919131025-Connexys-by-Bullhorn-How-do-I-link-my-account">
    Step-by-step instructions to connect your Connexys By Bullhorn account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | weekly\_hours        |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | department           |       |
      | post\_url            |       |
      | experience\_level    |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | contact\_id          |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.company                     |       |
      | candidate.title                       |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.location.country            |       |
      | candidate.gender                      |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.period |       |
      | candidate.salary\_expectations.amount |       |
      | candidate.social\_links.url           |       |
      | application.job\_id                   |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.company                     |       |
      | candidate.title                       |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.location.country            |       |
      | candidate.gender                      |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.period |       |
      | candidate.salary\_expectations.amount |       |
      | candidate.social\_links.url           |       |
      | application.job\_id                   |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | API Passthrough  |       |
    | Scope Testing    |       |
    | Per Model Tests  |       |
    | Connection Guide |       |
    | Prerequisites    |       |
  </Tab>
</Tabs>


# Cornerstone OnDemand ATS Integration
Source: https://docs.kombo.dev/ats/connectors/cornerstoneondemand

Cornerstone OnDemand connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Cornerstone OnDemand ATS integration allows you to sync ATS data between Cornerstone OnDemand and your application through Kombo's unified API. The tool slug for this connector is `cornerstoneondemand`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/28100174339217-Cornerstone-OnDemand-ATS-How-do-I-link-my-account">
    Step-by-step instructions to connect your Cornerstone OnDemand account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      <Note>
        Only the primary location is supported. AdditionalLocations can be found via custom fields or remote\_data.
      </Note>

      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | department           |       |
      | post\_url            |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | contact\_id          |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | remote\_created\_at |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        Cornerstone OnDemand exposes one hiring manager on the hiring team:

        * **HiringManager** maps to unified type `HIRING_MANAGER`
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Cornerstone OnDemand only supports 1 `CV` and 1 `Cover_Letter` attachment Creating a candidate in Cornerstone OnDemand can take a while. We'll keep trying for **5 minutes**. Retrying the request with the same candidate email and job will resume the creation process without creating a duplicate candidate.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Cornerstone OnDemand only supports 1 `CV` and 1 `Cover_Letter` attachment Creating a candidate in Cornerstone OnDemand can take a while. We'll keep trying for **5 minutes**. Retrying the request with the same candidate email and job will resume the creation process without creating a duplicate candidate.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                         | Notes                                                               |
    | ------------------------------- | ------------------------------------------------------------------- |
    | API Passthrough                 |                                                                     |
    | Scope Testing                   |                                                                     |
    | Per Model Tests                 |                                                                     |
    | Custom Field Explorer           |                                                                     |
    | Jobs                            |                                                                     |
    | Source Writing                  |                                                                     |
    | Sync Only Created Applications  |                                                                     |
    | Connection Guide                |                                                                     |
    | Roles                           |                                                                     |
    | Job roles (e.g. Hiring Manager) | Cornerstone OnDemand exposes one hiring manager on the hiring team: |

    * **HiringManager** maps to unified type `HIRING_MANAGER` |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Cornerstone OnDemand

For **Cornerstone OnDemand**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Cornerstone OnDemand HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/cornerstoneondemand/icon.svg" href="/hris/connectors/cornerstoneondemand">
    Cornerstone OnDemand for the HRIS category
  </Card>

  <Card title="Cornerstone OnDemand LMS" icon="https://storage.googleapis.com/kombo-assets/integrations/cornerstoneondemand/icon.svg" href="/lms/connectors/cornerstoneondemand">
    Cornerstone OnDemand for the LMS category
  </Card>
</CardGroup>


# Cornerstone TalentLink ATS Integration
Source: https://docs.kombo.dev/ats/connectors/cornerstonetalentlink

Cornerstone TalentLink connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Cornerstone TalentLink ATS integration allows you to sync ATS data between Cornerstone TalentLink and your application through Kombo's unified API. The tool slug for this connector is `cornerstonetalentlink`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/24081682624017">
    Step-by-step instructions to connect your Cornerstone TalentLink account to Kombo.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/24082942383761">
    How to view and manage candidate sources in Cornerstone TalentLink.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      <Note>
        Users embedded in TalentLink position teams do not include email addresses or user status.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      <Note>
        We sync one job advert per job. To ensure best results, your customer should only assign one advert per job to your integration.
      </Note>

      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | post\_url            |       |
      | remote\_work\_status |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | format              |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        TalentLink recruiters map to the unified `RECRUITER` role.
        Operational team members are collapsed into a single `Operational` role without a unified type, because TalentLink lovValues under that key mix hiring managers, HR, and other roles.
        Position approvers are excluded because TalentLink documents them as approval-workflow participants rather than hiring-team members.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Creating applications will fail when screening questions are marked as required but are not answered. TalentLink requires querying a separate endpoint to get the status of a submission. This action will time out if, after 5 minutes, the status does not return "SUBMITTED". It is possible that the application is still created after the action timed out. TalentLink requires phone numbers to include a regional prefix (such as +49). If the input does not contain it, we attempt to use the candidate's location. If neither of these options work, the phone number will not be submitted.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.street\_1              |       |
      | candidate.location.zip\_code              |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Creating applications will fail when screening questions are marked as required but are not answered. TalentLink requires querying a separate endpoint to get the status of a submission. This action will time out if, after 5 minutes, the status does not return "SUBMITTED". It is possible that the application is still created after the action timed out. TalentLink requires phone numbers to include a regional prefix (such as +49). If the input does not contain it, we attempt to use the candidate's location. If neither of these options work, the phone number will not be submitted.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.street\_1              |       |
      | candidate.location.zip\_code              |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      <Note>
        Moving an application has the same effects as changing its status manually in TalentLink, including any configured workflows.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Add note to application">
      <Note>
        Notes are appended to the application memo in TalentLink instead of creating separate timeline entries. Adding a note uses TalentLink's status update operation and may trigger configured workflows.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                                                                                                                                                                               | Notes                                                      |
    | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
    | API Passthrough                                                                                                                                                                       |                                                            |
    | Delta Syncs                                                                                                                                                                           |                                                            |
    | Source Writing                                                                                                                                                                        |                                                            |
    | Sync Only Created Applications                                                                                                                                                        |                                                            |
    | Connection Guide                                                                                                                                                                      |                                                            |
    | Prerequisites                                                                                                                                                                         |                                                            |
    | Roles                                                                                                                                                                                 |                                                            |
    | Job roles (e.g. Hiring Manager)                                                                                                                                                       | TalentLink recruiters map to the unified `RECRUITER` role. |
    | Operational team members are collapsed into a single `Operational` role without a unified type, because TalentLink lovValues under that key mix hiring managers, HR, and other roles. |                                                            |
    | Position approvers are excluded because TalentLink documents them as approval-workflow participants rather than hiring-team members.                                                  |                                                            |
  </Tab>
</Tabs>


# Coveto (legacy SOAP API) ATS Integration
Source: https://docs.kombo.dev/ats/connectors/coveto

Coveto (legacy SOAP API) connector for Kombo's ATS API

The Coveto (legacy SOAP API) ATS integration allows you to sync ATS data between Coveto (legacy SOAP API) and your application through Kombo's unified API. The tool slug for this connector is `coveto`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/34367096810257-Coveto-How-do-I-link-my-account">
    Step-by-step instructions to connect your Coveto (legacy SOAP API) account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field                | Notes                                            |
      | -------------------- | ------------------------------------------------ |
      | id                   |                                                  |
      | remote\_id           |                                                  |
      | changed\_at          |                                                  |
      | remote\_deleted\_at  |                                                  |
      | name                 |                                                  |
      | job\_code            |                                                  |
      | description          |                                                  |
      | weekly\_hours        |                                                  |
      | employment\_type     | Only the first value of employment\_type is used |
      | status               |                                                  |
      | visibility           |                                                  |
      | category             |                                                  |
      | post\_url            |                                                  |
      | remote\_work\_status |                                                  |
      | salary\_amount\_from |                                                  |
      | salary\_amount\_to   |                                                  |
      | salary\_currency     |                                                  |
      | salary\_period       |                                                  |
      | location             |                                                  |
      | custom\_fields       |                                                  |
      | integration\_fields  |                                                  |
      | opened\_at           |                                                  |
      | closed\_at           |                                                  |
      | remote\_created\_at  |                                                  |
      | remote\_updated\_at  |                                                  |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | rejected\_at        |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | format              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        At most 5 attachments can be added
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.zip\_code              |       |
      | candidate.gender                          |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        At most 5 attachments can be added
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.zip\_code              |       |
      | candidate.gender                          |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Custom Field Explorer          |       |
    | Jobs                           |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Choose this variant if you want to use the legacy Coveto SOAP API. New Coveto will no longer be given access to the SOAP API.

For **Coveto (legacy SOAP API)**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Coveto (REST API)" icon="https://storage.googleapis.com/kombo-assets/integrations/covetorest/icon.svg" href="/ats/connectors/covetorest">
    Choose this variant if you want to use the official Coveto REST API
  </Card>
</CardGroup>

<Note>Multiple variants can be used within your Kombo environment at the same time.</Note>


# Coveto (REST API) ATS Integration
Source: https://docs.kombo.dev/ats/connectors/covetorest

Coveto (REST API) connector for Kombo's ATS API

The Coveto (REST API) ATS integration allows you to sync ATS data between Coveto (REST API) and your application through Kombo's unified API. The tool slug for this connector is `covetorest`.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | weekly\_hours        |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | category             |       |
      | post\_url            |       |
      | remote\_work\_status |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | contact\_id          |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                  | Notes |
      | ---------------------------- | ----- |
      | candidate.first\_name        |       |
      | candidate.last\_name         |       |
      | candidate.email\_address     |       |
      | candidate.company            |       |
      | candidate.title              |       |
      | candidate.phone\_number      |       |
      | candidate.location.city      |       |
      | candidate.location.country   |       |
      | candidate.location.zip\_code |       |
      | candidate.gender             |       |
      | application.job\_id          |       |
      | attachments.name             |       |
      | attachments.content\_type    |       |
      | attachments.data\_url        |       |
      | attachments.data             |       |
      | attachments.type             |       |
      | source.name                  |       |
      | source.unified\_key          |       |
      | source.id                    |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                  | Notes |
      | ---------------------------- | ----- |
      | candidate.first\_name        |       |
      | candidate.last\_name         |       |
      | candidate.email\_address     |       |
      | candidate.company            |       |
      | candidate.title              |       |
      | candidate.phone\_number      |       |
      | candidate.location.city      |       |
      | candidate.location.country   |       |
      | candidate.location.zip\_code |       |
      | candidate.gender             |       |
      | application.job\_id          |       |
      | attachments.name             |       |
      | attachments.content\_type    |       |
      | attachments.data\_url        |       |
      | attachments.data             |       |
      | attachments.type             |       |
      | source.name                  |       |
      | source.unified\_key          |       |
      | source.id                    |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                                | Notes |
    | -------------------------------------- | ----- |
    | API Passthrough                        |       |
    | Scope Testing                          |       |
    | Custom Field Explorer                  |       |
    | Jobs                                   |       |
    | Source Writing                         |       |
    | Sync Only Created Applications         |       |
    | Create Candidate Full Attachment Retry |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Choose this variant if you want to use the official Coveto REST API

For **Coveto (REST API)**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Coveto (legacy SOAP API)" icon="https://storage.googleapis.com/kombo-assets/integrations/coveto/icon.svg" href="/ats/connectors/coveto">
    Choose this variant if you want to use the legacy Coveto SOAP API. New Coveto will no longer be given access to the SOAP API.
  </Card>
</CardGroup>

<Note>Multiple variants can be used within your Kombo environment at the same time.</Note>


# Crelate ATS Integration
Source: https://docs.kombo.dev/ats/connectors/crelate

Crelate connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Crelate ATS integration allows you to sync ATS data between Crelate and your application through Kombo's unified API. The tool slug for this connector is `crelate`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/36336662281873">
    Step-by-step instructions to connect your Crelate account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | job\_code           |       |
      | description         |       |
      | status              |       |
      | visibility          |       |
      | salary\_amount      |       |
      | salary\_currency    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | opened\_at          |       |
      | closed\_at          |       |
      | remote\_updated\_at |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Interviews">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | starting\_at        |       |
      | ending\_at          |       |
      | application\_id     |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        Crelate exposes job **Owners**

        * Each **Owners** entry (shown as "Owner" in the UI) maps to unified type `HIRING_MANAGER`
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="User roles">
      <Note>
        Crelate exposes **UserType.Title** for each user

        * All values (e.g. Client Portal User, Standard) have no unified type.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | user\_id            |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Interviewing team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | interview\_id       |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Crelate requires us to assign an application stage when creating applications. If an application stage ID is not provided in the request body, we will assign the candidate to the first application stage in the Crelate instance. Phone numbers are only supported for US numbers. Non-US phone numbers are skipped.
      </Note>

      | Input Field                                           | Notes |
      | ----------------------------------------------------- | ----- |
      | candidate.first\_name                                 |       |
      | candidate.last\_name                                  |       |
      | candidate.email\_address                              |       |
      | candidate.additional\_email\_addresses.email\_address |       |
      | candidate.company                                     |       |
      | candidate.title                                       |       |
      | candidate.phone\_number                               |       |
      | candidate.location.city                               |       |
      | candidate.location.country                            |       |
      | candidate.location.state                              |       |
      | candidate.location.zip\_code                          |       |
      | candidate.availability\_date                          |       |
      | candidate.salary\_expectations.period                 |       |
      | candidate.salary\_expectations.amount                 |       |
      | candidate.social\_links.url                           |       |
      | application.job\_id                                   |       |
      | application.stage\_id                                 |       |
      | attachments.name                                      |       |
      | attachments.content\_type                             |       |
      | attachments.data\_url                                 |       |
      | attachments.data                                      |       |
      | attachments.type                                      |       |
      | source.name                                           |       |
      | source.unified\_key                                   |       |
      | source.id                                             |       |
      | sourced\_by.user\_id                                  |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Crelate requires us to assign an application stage when creating applications. If an application stage ID is not provided in the request body, we will assign the candidate to the first application stage in the Crelate instance. Phone numbers are only supported for US numbers. Non-US phone numbers are skipped.
      </Note>

      | Input Field                                           | Notes |
      | ----------------------------------------------------- | ----- |
      | candidate.first\_name                                 |       |
      | candidate.last\_name                                  |       |
      | candidate.email\_address                              |       |
      | candidate.additional\_email\_addresses.email\_address |       |
      | candidate.company                                     |       |
      | candidate.title                                       |       |
      | candidate.phone\_number                               |       |
      | candidate.location.city                               |       |
      | candidate.location.country                            |       |
      | candidate.location.state                              |       |
      | candidate.location.zip\_code                          |       |
      | candidate.availability\_date                          |       |
      | candidate.salary\_expectations.period                 |       |
      | candidate.salary\_expectations.amount                 |       |
      | candidate.social\_links.url                           |       |
      | application.job\_id                                   |       |
      | application.stage\_id                                 |       |
      | attachments.name                                      |       |
      | attachments.content\_type                             |       |
      | attachments.data\_url                                 |       |
      | attachments.data                                      |       |
      | attachments.type                                      |       |
      | source.name                                           |       |
      | source.unified\_key                                   |       |
      | source.id                                             |       |
      | sourced\_by.user\_id                                  |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      <Note>
        Crelate's API only allows us to retrieve the candidate's CV.
      </Note>

      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                   | Notes                                            |
    | ------------------------- | ------------------------------------------------ |
    | API Passthrough           |                                                  |
    | Delta Syncs               |                                                  |
    | Source Writing            |                                                  |
    | Connection Guide          |                                                  |
    | Roles                     |                                                  |
    | System roles (e.g. Admin) | Crelate exposes **UserType.Title** for each user |

    * All values (e.g. Client Portal User, Standard) have no unified type. |
      \|   Job roles (e.g. Hiring Manager) | Crelate exposes job **Owners**
    * Each **Owners** entry (shown as "Owner" in the UI) maps to unified type `HIRING_MANAGER` |
  </Tab>
</Tabs>


# Databites ATS Integration
Source: https://docs.kombo.dev/ats/connectors/databites

Databites connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Databites ATS integration allows you to sync ATS data between Databites and your application through Kombo's unified API. The tool slug for this connector is `databites`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/47875115266833">
    Step-by-step instructions to connect your Databites account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | weekly\_hours        |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | category             |       |
      | department           |       |
      | post\_url            |       |
      | remote\_work\_status |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_url          |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Job postings">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description\_html   |       |
      | status              |       |
      | visibility          |       |
      | url                 |       |
      | job\_id             |       |
      | remote\_data        |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                        | Notes |
      | ---------------------------- | ----- |
      | id                           |       |
      | remote\_id                   |       |
      | changed\_at                  |       |
      | remote\_deleted\_at          |       |
      | outcome                      |       |
      | rejection\_reason\_name      |       |
      | current\_stage\_id           |       |
      | job\_id                      |       |
      | candidate\_id                |       |
      | screening\_question\_answers |       |
      | custom\_fields               |       |
      | integration\_fields          |       |
      | remote\_url                  |       |
      | remote\_created\_at          |       |
      | remote\_updated\_at          |       |
      | remote\_data                 |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.zip\_code              |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | gdpr\_consent.expires\_at                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.zip\_code              |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | gdpr\_consent.expires\_at                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Delta Syncs                    |       |
    | Custom Field Explorer          |       |
    | Jobs                           |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
  </Tab>
</Tabs>


# Dayforce ATS Integration
Source: https://docs.kombo.dev/ats/connectors/dayforce

Dayforce connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Dayforce ATS integration allows you to sync ATS data between Dayforce and your application through Kombo's unified API. The tool slug for this connector is `dayforce`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/42631590483089-Dayforce-ATS-How-do-I-link-my-account">
    Step-by-step instructions to connect your Dayforce account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      <Note>
        Dayforce supports multiple locations per job, but we only expose the first at the moment. Other locations are merged into the `location.raw` field. The Dayforce API doesn't provide salary period information, so the salary amount can be yearly, monthly, or hourly The Dayforce API returns only jobs, which have active (means OPEN and PUBLIC) job postings. Other jobs will be marked by Kombo with `remote\_deleted\_at`.
      </Note>

      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | status               |       |
      | visibility           |       |
      | post\_url            |       |
      | remote\_work\_status |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      <Note>
        Only candidates created via Kombo are tracked. Candidates from Dayforce are not synced.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      <Note>
        Application stages are created dynamically based on status names encountered. The full list of possible statuses is not known in advance.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      <Note>
        Only applications created via Kombo are tracked. Applications from Dayforce are not synced.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Screening questions">
      <Note>
        Pagebreaks from Dayforce are skipped
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | format              |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Only one CV attachment is supported.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.state                  |       |
      | candidate.location.street\_1              |       |
      | candidate.location.zip\_code              |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Only one CV attachment is supported.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.state                  |       |
      | candidate.location.street\_1              |       |
      | candidate.location.zip\_code              |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | API Passthrough       |       |
    | Custom Field Explorer |       |
    | Jobs                  |       |
    | Source Writing        |       |
    | Connection Guide      |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Dayforce

For **Dayforce**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Dayforce HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/dayforce/icon.svg" href="/hris/connectors/dayforce">
    Dayforce for the HRIS category
  </Card>
</CardGroup>


# Digital Recruiters ATS Integration
Source: https://docs.kombo.dev/ats/connectors/digitalrecruiters

Digital Recruiters connector for Kombo's ATS API

<Note>This connector is in closed beta. Please contact us to get access.</Note>

The Digital Recruiters ATS integration allows you to sync ATS data between Digital Recruiters and your application through Kombo's unified API. The tool slug for this connector is `digitalrecruiters`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/44404331016593-Digital-Recruiters-How-do-I-link-my-account">
    Step-by-step instructions to connect your Digital Recruiters account to Kombo.
  </Card>

  <Card title="Docs" icon="book" href="https://cegid-hr-developers.talentsoft.net/docs/tutorial-basics/Talent%20Acquisition/Getting%20Started">
    Additional documentation and guides for Digital Recruiters.
  </Card>
</CardGroup>

## General Notes

* Digital Recruiters API only supports the standard job board use case: Reading Jobs and Applying.
* Application status levels are mapped to seven global stages (Application, Preselection, Qualification, Interview, Offer, Hiring, Refusal). In observed Digital Recruiters tenants, these levels appear non-editable.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes                                                                                                                                                      |
      | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
      | id                   |                                                                                                                                                            |
      | remote\_id           |                                                                                                                                                            |
      | changed\_at          |                                                                                                                                                            |
      | remote\_deleted\_at  |                                                                                                                                                            |
      | name                 |                                                                                                                                                            |
      | job\_code            |                                                                                                                                                            |
      | description          |                                                                                                                                                            |
      | confidential         |                                                                                                                                                            |
      | employment\_type     |                                                                                                                                                            |
      | status               | Digital Recruiters only exposes a job feed of the currently open jobs, we therefore sync all as open. Once a job is closed it will be returned as deleted. |
      | visibility           |                                                                                                                                                            |
      | department           |                                                                                                                                                            |
      | post\_url            |                                                                                                                                                            |
      | experience\_level    |                                                                                                                                                            |
      | salary\_amount\_from |                                                                                                                                                            |
      | salary\_amount\_to   |                                                                                                                                                            |
      | salary\_currency     |                                                                                                                                                            |
      | location             |                                                                                                                                                            |
      | custom\_fields       |                                                                                                                                                            |
      | integration\_fields  |                                                                                                                                                            |
      | opened\_at           |                                                                                                                                                            |
      | remote\_created\_at  |                                                                                                                                                            |
      | contact\_id          |                                                                                                                                                            |
      | remote\_data         |                                                                                                                                                            |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        DigitalRecruiters supports one file payload (`file`). If multiple attachments are submitted, only one attachment is sent (CV preferred). DigitalRecruiters only supports `gender` values `1` (male) and `2` (female). `OTHER` is not sent. The DigitalRecruiters API doesn't expose an error when applying to closed jobs or when the same candidate applies twice, we therefore don't throw our AlreadyApplied and JobClosed Errors.
      </Note>

      | Input Field                  | Notes |
      | ---------------------------- | ----- |
      | candidate.first\_name        |       |
      | candidate.last\_name         |       |
      | candidate.email\_address     |       |
      | candidate.title              |       |
      | candidate.phone\_number      |       |
      | candidate.location.city      |       |
      | candidate.location.street\_1 |       |
      | candidate.location.zip\_code |       |
      | candidate.gender             |       |
      | application.job\_id          |       |
      | attachments.name             |       |
      | attachments.data\_url        |       |
      | attachments.data             |       |
      | attachments.type             |       |
      | source.name                  |       |
      | gdpr\_consent.given          |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        DigitalRecruiters supports one file payload (`file`). If multiple attachments are submitted, only one attachment is sent (CV preferred). DigitalRecruiters only supports `gender` values `1` (male) and `2` (female). `OTHER` is not sent. The DigitalRecruiters API doesn't expose an error when applying to closed jobs or when the same candidate applies twice, we therefore don't throw our AlreadyApplied and JobClosed Errors.
      </Note>

      | Input Field                  | Notes |
      | ---------------------------- | ----- |
      | candidate.first\_name        |       |
      | candidate.last\_name         |       |
      | candidate.email\_address     |       |
      | candidate.title              |       |
      | candidate.phone\_number      |       |
      | candidate.location.city      |       |
      | candidate.location.street\_1 |       |
      | candidate.location.zip\_code |       |
      | candidate.gender             |       |
      | application.job\_id          |       |
      | attachments.name             |       |
      | attachments.data\_url        |       |
      | attachments.data             |       |
      | attachments.type             |       |
      | source.name                  |       |
      | gdpr\_consent.given          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Scope Testing                  |       |
    | Per Model Tests                |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
  </Tab>
</Tabs>


# d.vinci ATS Integration
Source: https://docs.kombo.dev/ats/connectors/dvinci

d.vinci connector for Kombo's ATS API

The d.vinci ATS integration allows you to sync ATS data between d.vinci and your application through Kombo's unified API. The tool slug for this connector is `dvinci`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/17863050139409">
    Step-by-step instructions to connect your d.vinci account to Kombo.
  </Card>

  <Card title="Source Setup Guide" icon="settings" href="https://help.kombo.dev/hc/en-us/articles/17101707028369-d-vinci-How-to-add-a-candidate-source">
    Learn how to set up candidate sources in d.vinci.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22542854291857-d-vinci-How-to-view-a-candidates-source">
    How to view and manage candidate sources in d.vinci.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      <Note>
        d.vinci supports multiple locations per job, but we only expose the first at the moment.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | job\_code           |       |
      | description         |       |
      | employment\_type    |       |
      | status              |       |
      | category            |       |
      | department          |       |
      | post\_url           |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | opened\_at          |       |
      | remote\_created\_at |       |
      | contact\_id         |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Applications">
      <Note>
        This d.vinci variant only supports reading applications that were created through the Kombo API. Use the Admin version to read all applications in d.vinci.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.street\_1              |       |
      | candidate.location.zip\_code              |       |
      | candidate.gender                          |       |
      | candidate.availability\_date              |       |
      | candidate.salary\_expectations.period     |       |
      | candidate.salary\_expectations.amount     |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.street\_1              |       |
      | candidate.location.zip\_code              |       |
      | candidate.gender                          |       |
      | candidate.availability\_date              |       |
      | candidate.salary\_expectations.period     |       |
      | candidate.salary\_expectations.amount     |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      | Input Field          | Notes |
      | -------------------- | ----- |
      | application\_id      |       |
      | attachment.name      |       |
      | attachment.data\_url |       |
      | attachment.data      |       |
      | attachment.type      |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                                | Notes |
    | -------------------------------------- | ----- |
    | API Passthrough                        |       |
    | Scope Testing                          |       |
    | Per Model Tests                        |       |
    | Custom Field Explorer                  |       |
    | Jobs                                   |       |
    | Source Writing                         |       |
    | Sync Only Created Applications         |       |
    | Connection Guide                       |       |
    | Prerequisites                          |       |
    | Create credentials                     |       |
    | Candidate source tracking              |       |
    | Create Candidate Full Attachment Retry |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Choose this variant if your product primarily requires reading jobs, creating applications, and reading application updates.

For **d.vinci**, we also offer the following other connector variants:

<CardGroup>
  <Card title="d.vinci admin" icon="https://storage.googleapis.com/kombo-assets/integrations/dvinciadmin/icon.svg" href="/ats/connectors/dvinciadmin">
    Choose this variant if you require reading all available candidates and applications in the d.vinci system. This variant requires additional permissions from your customer.
  </Card>
</CardGroup>

<Note>You can only use one variant at a time.</Note>


# d.vinci admin ATS Integration
Source: https://docs.kombo.dev/ats/connectors/dvinciadmin

d.vinci admin connector for Kombo's ATS API

<Note>This connector is in closed beta. Please contact us to get access.</Note>

The d.vinci admin ATS integration allows you to sync ATS data between d.vinci admin and your application through Kombo's unified API. The tool slug for this connector is `dvinciadmin`.

## Guides and Resources

<CardGroup>
  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22542854291857-d-vinci-How-to-view-a-candidates-source">
    How to view and manage candidate sources in d.vinci admin.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      <Note>
        d.vinci supports multiple locations per job, but we only expose the first at the moment.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | job\_code           |       |
      | description         |       |
      | employment\_type    |       |
      | status              |       |
      | category            |       |
      | department          |       |
      | post\_url           |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | opened\_at          |       |
      | remote\_created\_at |       |
      | contact\_id         |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes                                                                                                                                              |
      | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
      | id                  |                                                                                                                                                    |
      | remote\_id          |                                                                                                                                                    |
      | changed\_at         |                                                                                                                                                    |
      | remote\_deleted\_at |                                                                                                                                                    |
      | first\_name         |                                                                                                                                                    |
      | last\_name          |                                                                                                                                                    |
      | title               |                                                                                                                                                    |
      | confidential        |                                                                                                                                                    |
      | source              | The source field is taken from the first application of the candidate from d.vinci. All source are available as custom fields on each application. |
      | phone\_numbers      |                                                                                                                                                    |
      | email\_addresses    |                                                                                                                                                    |
      | social\_media       |                                                                                                                                                    |
      | location            |                                                                                                                                                    |
      | custom\_fields      |                                                                                                                                                    |
      | integration\_fields |                                                                                                                                                    |
      | remote\_data        |                                                                                                                                                    |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | outcome                 |       |
      | rejection\_reason\_name |       |
      | rejected\_at            |       |
      | current\_stage\_id      |       |
      | job\_id                 |       |
      | candidate\_id           |       |
      | custom\_fields          |       |
      | integration\_fields     |       |
      | remote\_created\_at     |       |
      | remote\_updated\_at     |       |
      | remote\_data            |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Add attachment to application">
      <Note>
        The Attachment type will be added to the description property in d.vinci.
      </Note>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | application\_id      |       |
      | attachment.name      |       |
      | attachment.data\_url |       |
      | attachment.data      |       |
      | attachment.type      |       |
    </Accordion>

    <Accordion title="Move application to stage">
      <Note>
        d.vinci enforces a configured status workflow, so not every stage is reachable from an application's current status. Moving to a stage that isn't a valid transition fails with a validation error.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      <Note>
        d.vinci does not expose an attachment type, so all attachments are returned with the type OTHER.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature         | Notes |
    | --------------- | ----- |
    | API Passthrough |       |
    | Scope Testing   |       |
    | Per Model Tests |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Choose this variant if you require reading all available candidates and applications in the d.vinci system. This variant requires additional permissions from your customer.

For **d.vinci admin**, we also offer the following other connector variants:

<CardGroup>
  <Card title="d.vinci" icon="https://storage.googleapis.com/kombo-assets/integrations/dvinci/icon.svg" href="/ats/connectors/dvinci">
    Choose this variant if your product primarily requires reading jobs, creating applications, and reading application updates.
  </Card>
</CardGroup>

<Note>You can only use one variant at a time.</Note>


# Eightfold ATS Integration
Source: https://docs.kombo.dev/ats/connectors/eightfold

Eightfold connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Eightfold ATS integration allows you to sync ATS data between Eightfold and your application through Kombo's unified API. The tool slug for this connector is `eightfold`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/32350490678801-Eightfold-How-do-I-link-my-account">
    Step-by-step instructions to connect your Eightfold account to Kombo.
  </Card>
</CardGroup>

## General Notes

* Eightfold does not support reading a list of application stages. Application stages are inferred from the application data.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | job\_code           |       |
      | description         |       |
      | confidential        |       |
      | status              |       |
      | visibility          |       |
      | category            |       |
      | post\_url           |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | confidential        |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
    </Accordion>

    <Accordion title="Tags">
      <Note>
        Eightfold only allows fetching a maximum of 10,000 profile tags. If more tags exist, only the first 10,000 will be synced.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Creating an application in Eightfold can take up to 5 minutes
      </Note>

      | Input Field                | Notes |
      | -------------------------- | ----- |
      | candidate.first\_name      |       |
      | candidate.last\_name       |       |
      | candidate.email\_address   |       |
      | candidate.phone\_number    |       |
      | candidate.location.city    |       |
      | candidate.location.country |       |
      | candidate.gender           |       |
      | application.job\_id        |       |
      | application.stage\_id      |       |
      | attachments.name           |       |
      | attachments.content\_type  |       |
      | attachments.data\_url      |       |
      | attachments.data           |       |
      | attachments.type           |       |
      | source.name                |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Creating an application in Eightfold can take up to 5 minutes
      </Note>

      | Input Field                | Notes |
      | -------------------------- | ----- |
      | candidate.first\_name      |       |
      | candidate.last\_name       |       |
      | candidate.email\_address   |       |
      | candidate.phone\_number    |       |
      | candidate.location.city    |       |
      | candidate.location.country |       |
      | candidate.gender           |       |
      | application.job\_id        |       |
      | application.stage\_id      |       |
      | attachments.name           |       |
      | attachments.content\_type  |       |
      | attachments.data\_url      |       |
      | attachments.data           |       |
      | attachments.type           |       |
      | source.name                |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | url             |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Scope Testing                  |       |
    | Per Model Tests                |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Eightfold

For **Eightfold**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Eightfold Assessment" icon="https://storage.googleapis.com/kombo-assets/integrations/eightfold/icon.svg" href="/assessment/connectors/eightfold">
    Eightfold for the Assessment category
  </Card>
</CardGroup>


# Eploy ATS Integration
Source: https://docs.kombo.dev/ats/connectors/eploy

Eploy connector for Kombo's ATS API

The Eploy ATS integration allows you to sync ATS data between Eploy and your application through Kombo's unified API. The tool slug for this connector is `eploy`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/22315585782673-Eploy-How-do-I-link-my-account">
    Step-by-step instructions to connect your Eploy account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | weekly\_hours        |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | category             |       |
      | department           |       |
      | post\_url            |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      <Note>
        Eploy application stages are very complex compared to most other tools. We create permutations of multiple concepts in Eploy (stages, statuses, outcomes and placements) to cover all possible stages an application can be in. This leads to a high number of application stages.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | outcome                 |       |
      | rejection\_reason\_name |       |
      | current\_stage\_id      |       |
      | job\_id                 |       |
      | candidate\_id           |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | format              |       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.gender                          |       |
      | candidate.availability\_date              |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.gender                          |       |
      | candidate.availability\_date              |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>

    <Accordion title="Move application to stage">
      <Note>
        Stages can only be moved according to the recruiting workflow within Eploy.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Reject application">
      <Note>
        Eploy rejects an application by assigning a terminated application status, which can only be set on the "Applications" workflow stage. The application is therefore always moved to that stage first, even if it is currently in an interview or other downstream stage. The available rejection reasons are the terminated application statuses configured via the "Rejection status IDs" integration setting.
      </Note>

      | Input Field           | Notes |
      | --------------------- | ----- |
      | application\_id       |       |
      | rejection\_reason\_id |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      <Note>
        We only fetch attachments from the CVs endpoint.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      <Note>
        We only fetch attachments from the CVs endpoint.
      </Note>

      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Scope Testing                  |       |
    | Per Model Tests                |       |
    | Delta Syncs                    |       |
    | Custom Field Explorer          |       |
    | Jobs                           |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
    | Create credentials             |       |
  </Tab>
</Tabs>


# eRecruiter ATS Integration
Source: https://docs.kombo.dev/ats/connectors/erecruiter

eRecruiter connector for Kombo's ATS API

The eRecruiter ATS integration allows you to sync ATS data between eRecruiter and your application through Kombo's unified API. The tool slug for this connector is `erecruiter`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/18353393847185">
    Step-by-step instructions to connect your eRecruiter account to Kombo.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22544948033041-eRecruiters-How-to-view-a-candidates-source">
    How to view and manage candidate sources in eRecruiter.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      <Note>
        We select the first post url that we find for the job. It could have multiple.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | description         |       |
      | employment\_type    |       |
      | status              |       |
      | post\_url           |       |
      | experience\_level   |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | opened\_at          |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Salary expectation cannot be a decimal number. We will round it to the nearest integer.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.gender                          |       |
      | candidate.availability\_date              |       |
      | candidate.salary\_expectations.period     |       |
      | candidate.salary\_expectations.amount     |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Salary expectation cannot be a decimal number. We will round it to the nearest integer.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.gender                          |       |
      | candidate.availability\_date              |       |
      | candidate.salary\_expectations.period     |       |
      | candidate.salary\_expectations.amount     |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>

    <Accordion title="Add tag to candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Remove tag from candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | application\_id      |       |
      | attachment.name      |       |
      | attachment.data\_url |       |
      | attachment.data      |       |
      | attachment.type      |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | label                    |       |
      | url                      |       |
      | details.attributes.key   |       |
      | details.attributes.value |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      | Input Field          | Notes |
      | -------------------- | ----- |
      | candidate\_id        |       |
      | attachment.name      |       |
      | attachment.data\_url |       |
      | attachment.data      |       |
      | attachment.type      |       |
    </Accordion>

    <Accordion title="Add result link to candidate">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | label                    |       |
      | url                      |       |
      | details.attributes.key   |       |
      | details.attributes.value |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Custom Field Explorer          |       |
    | Jobs                           |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
    | Prerequisites                  |       |
    | Create credentials             |       |
  </Tab>
</Tabs>


# Factorial ATS Integration
Source: https://docs.kombo.dev/ats/connectors/factorial

Factorial connector for Kombo's ATS API

The Factorial ATS integration allows you to sync ATS data between Factorial and your application through Kombo's unified API. The tool slug for this connector is `factorial`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/18743884123409">
    Step-by-step instructions to connect your Factorial account to Kombo.
  </Card>

  <Card title="Sandbox Environment" icon="flask" href="https://factorialhr.com/get-started">
    Access the Factorial sandbox environment for testing and development.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | department           |       |
      | post\_url            |       |
      | remote\_work\_status |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_created\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | source              |       |
      | email\_addresses    |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | outcome                 |       |
      | rejection\_reason\_name |       |
      | current\_stage\_id      |       |
      | job\_id                 |       |
      | candidate\_id           |       |
      | remote\_created\_at     |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Factorial only supports uploading a single attachment of the type `CV`. Please contact Kombo if you need to submit cover letters.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Factorial only supports uploading a single attachment of the type `CV`. Please contact Kombo if you need to submit cover letters.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        Factorial only supports adding attachment of the type `CV` to applications.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | OAuth                          |       |
    | API Passthrough                |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
    | Prerequisites                  |       |
    | Create credentials             |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Factorial

For **Factorial**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Factorial HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/factorial/icon.svg" href="/hris/connectors/factorial">
    Factorial for the HRIS category
  </Card>
</CardGroup>


# Flatchr ATS Integration
Source: https://docs.kombo.dev/ats/connectors/flatchr

Flatchr connector for Kombo's ATS API

The Flatchr ATS integration allows you to sync ATS data between Flatchr and your application through Kombo's unified API. The tool slug for this connector is `flatchr`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/18567822877457">
    Step-by-step instructions to connect your Flatchr account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | category             |       |
      | department           |       |
      | post\_url            |       |
      | experience\_level    |       |
      | remote\_work\_status |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      <Note>
        Stages that are hidden for a specific job will still be returned in its `stages` array.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | remote\_url         |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Fatchr only allows uploading a single CV. Kombo will upload the first attachment in the request body of type "CV". Source writing: Use offerer\_id (Tools > Flatchr > Settings) for official Flatchr job boards, or source\_id (integration setting or source.id in the request) for custom sources. Screening questions: TEXT, BOOLEAN, SINGLE\_SELECT, MULTI\_SELECT, NUMBER, and DATE answers are submitted via the answers array. FILE screening questions are not supported on create.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Fatchr only allows uploading a single CV. Kombo will upload the first attachment in the request body of type "CV". Source writing: Use offerer\_id (Tools > Flatchr > Settings) for official Flatchr job boards, or source\_id (integration setting or source.id in the request) for custom sources. Screening questions: TEXT, BOOLEAN, SINGLE\_SELECT, MULTI\_SELECT, NUMBER, and DATE answers are submitted via the answers array. FILE screening questions are not supported on create.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | API Passthrough    |       |
    | Source Writing     |       |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
  </Tab>
</Tabs>


# Fountain ATS Integration
Source: https://docs.kombo.dev/ats/connectors/fountain

Fountain connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Fountain ATS integration allows you to sync ATS data between Fountain and your application through Kombo's unified API. The tool slug for this connector is `fountain`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/26795058016913">
    Step-by-step instructions to connect your Fountain account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_created\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        Fountain only exposes a job owner.

        * **owner** (shown as "Opening Owner" in the UI) maps to unified type `HIRING_MANAGER`
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="User roles">
      <Note>
        Fountain links each user to one role (**name** on the role).

        * **name** exactly Admin or Administrator (case-insensitive) maps to unified type `ADMIN` (partial matches like FR - People Administration do not).
        * **name** containing recruiter (case-insensitive) maps to unified type `RECRUITER`.
        * Any other **name** has no unified type.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | user\_id            |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Fountain requires a phone number to create a candidate
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.gender                          |       |
      | candidate.availability\_date              |       |
      | candidate.salary\_expectations.period     |       |
      | candidate.salary\_expectations.amount     |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Fountain requires a phone number to create a candidate
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.gender                          |       |
      | candidate.availability\_date              |       |
      | candidate.salary\_expectations.period     |       |
      | candidate.salary\_expectations.amount     |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes                                                        |
    | ------------------------------ | ------------------------------------------------------------ |
    | API Passthrough                |                                                              |
    | Custom Field Explorer          |                                                              |
    | Jobs                           |                                                              |
    | Source Writing                 |                                                              |
    | Sync Only Created Applications |                                                              |
    | Connection Guide               |                                                              |
    | Roles                          |                                                              |
    | System roles (e.g. Admin)      | Fountain links each user to one role (**name** on the role). |

    * **name** exactly Admin or Administrator (case-insensitive) maps to unified type `ADMIN` (partial matches like FR - People Administration do not).
    * **name** containing recruiter (case-insensitive) maps to unified type `RECRUITER`.
    * Any other **name** has no unified type. |
      \|   Job roles (e.g. Hiring Manager) | Fountain only exposes a job owner.
    * **owner** (shown as "Opening Owner" in the UI) maps to unified type `HIRING_MANAGER` |
  </Tab>
</Tabs>


# Gem ATS Integration
Source: https://docs.kombo.dev/ats/connectors/gem

Gem connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

<Note>This connector requires a partnership with Gem. Check out our [partnership guide](https://help.kombo.dev/hc/en-us/articles/39858527044881-Gem-integration-partner-guide-How-do-I-prepare-the-integration-set-up-for-my-customers) to learn more.</Note>

The Gem ATS integration allows you to sync ATS data between Gem and your application through Kombo's unified API. The tool slug for this connector is `gem`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/32279370914449-Gem-ATS-How-do-I-link-my-account">
    Step-by-step instructions to connect your Gem account to Kombo.
  </Card>

  <Card title="Partnership Guide" icon="handshake" href="https://help.kombo.dev/hc/en-us/articles/39858527044881-Gem-integration-partner-guide-How-do-I-prepare-the-integration-set-up-for-my-customers">
    Learn how to become a partner with Gem to enable this integration.
  </Card>
</CardGroup>

## General Notes

* You need to be a Gem integration partner to set up this tool. Please refer to the [partnership guide](https://help.kombo.dev/hc/en-us/articles/39858527044881-Gem-integration-partner-guide-How-do-I-prepare-the-integration-set-up-for-my-customers).

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      <Note>
        We only map the first location of the offices array. All locations are available via our [custom fields feature](https://docs.kombo.dev/ats/features/custom-fields). We only map the first department of the departments array. All departments are available via our [custom fields feature](https://docs.kombo.dev/ats/features/custom-fields). The `description` and `post_url` are taken from the most recent live and active job posting.
      </Note>

      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | confidential         |       |
      | status               |       |
      | department           |       |
      | post\_url            |       |
      | remote\_work\_status |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Job postings">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description\_html   |       |
      | status              |       |
      | visibility          |       |
      | url                 |       |
      | job\_id             |       |
      | remote\_data        |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
    </Accordion>

    <Accordion title="Candidates">
      <Note>
        The initial application source will be recorded as the candidate's source. Each application includes a [custom field](https://docs.kombo.dev/ats/features/custom-fields) that specifies its own source.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | confidential        |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | outcome                 |       |
      | rejection\_reason\_name |       |
      | rejected\_at            |       |
      | current\_stage\_id      |       |
      | job\_id                 |       |
      | candidate\_id           |       |
      | custom\_fields          |       |
      | integration\_fields     |       |
      | remote\_created\_at     |       |
      | remote\_updated\_at     |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Interviews">
      | Field                    | Notes |
      | ------------------------ | ----- |
      | id                       |       |
      | remote\_id               |       |
      | changed\_at              |       |
      | remote\_deleted\_at      |       |
      | title                    |       |
      | starting\_at             |       |
      | ending\_at               |       |
      | video\_conferencing\_url |       |
      | application\_id          |       |
      | stage\_id                |       |
      | canceled                 |       |
      | remote\_created\_at      |       |
      | remote\_updated\_at      |       |
      | remote\_data             |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Interviewing team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | interview\_id       |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        All attachments will be uploaded as resumes. This is a limitation of the Gem API. Gem only allows writing personal email addresses. All emails will be created as personal emails.
      </Note>

      | Input Field                 | Notes |
      | --------------------------- | ----- |
      | candidate.first\_name       |       |
      | candidate.last\_name        |       |
      | candidate.email\_address    |       |
      | candidate.company           |       |
      | candidate.title             |       |
      | candidate.phone\_number     |       |
      | candidate.social\_links.url |       |
      | application.job\_id         |       |
      | application.stage\_id       |       |
      | attachments.name            |       |
      | attachments.content\_type   |       |
      | attachments.data\_url       |       |
      | attachments.data            |       |
      | attachments.type            |       |
      | source.name                 |       |
      | source.unified\_key         |       |
      | source.id                   |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        All attachments will be uploaded as resumes. This is a limitation of the Gem API. Gem only allows writing personal email addresses. All emails will be created as personal emails.
      </Note>

      | Input Field                 | Notes |
      | --------------------------- | ----- |
      | candidate.first\_name       |       |
      | candidate.last\_name        |       |
      | candidate.email\_address    |       |
      | candidate.company           |       |
      | candidate.title             |       |
      | candidate.phone\_number     |       |
      | candidate.social\_links.url |       |
      | application.job\_id         |       |
      | application.stage\_id       |       |
      | attachments.name            |       |
      | attachments.content\_type   |       |
      | attachments.data\_url       |       |
      | attachments.data            |       |
      | attachments.type            |       |
      | source.name                 |       |
      | source.unified\_key         |       |
      | source.id                   |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>

    <Accordion title="Add result link to candidate">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | candidate\_id                       |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Delta Syncs                    |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
    | Create credentials             |       |
  </Tab>
</Tabs>


# Greenhouse (V1) ATS Integration
Source: https://docs.kombo.dev/ats/connectors/greenhouse

Greenhouse (V1) connector for Kombo's ATS API

The Greenhouse (V1) ATS integration allows you to sync ATS data between Greenhouse (V1) and your application through Kombo's unified API. The tool slug for this connector is `greenhouse`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/17653682834833">
    Step-by-step instructions to connect your Greenhouse (V1) account to Kombo.
  </Card>

  <Card title="Source Setup Guide" icon="settings" href="https://help.kombo.dev/hc/en-us/articles/17075876539665">
    Learn how to set up candidate sources in Greenhouse (V1).
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22528461077777-Greenhouse-How-to-view-a-candidates-source">
    How to view and manage candidate sources in Greenhouse (V1).
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | confidential         |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | department           |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_url          |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Job postings">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description\_html   |       |
      | status              |       |
      | visibility          |       |
      | url                 |       |
      | job\_id             |       |
      | remote\_data        |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | confidential        |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      <Note>
        We can't easily infer the type of questions for screening question answers.
      </Note>

      | Field                        | Notes |
      | ---------------------------- | ----- |
      | id                           |       |
      | remote\_id                   |       |
      | changed\_at                  |       |
      | remote\_deleted\_at          |       |
      | outcome                      |       |
      | rejection\_reason\_name      |       |
      | rejected\_at                 |       |
      | current\_stage\_id           |       |
      | job\_id                      |       |
      | candidate\_id                |       |
      | screening\_question\_answers |       |
      | custom\_fields               |       |
      | integration\_fields          |       |
      | remote\_url                  |       |
      | remote\_created\_at          |       |
      | remote\_updated\_at          |       |
      | remote\_data                 |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Interviews">
      <Note>
        Greenhouse only gives us the response status of the interviewers, not the candidate's. Therefore, we assume that if all interviewers decline the interview, it is considered canceled.
      </Note>

      | Field                    | Notes |
      | ------------------------ | ----- |
      | id                       |       |
      | remote\_id               |       |
      | changed\_at              |       |
      | remote\_deleted\_at      |       |
      | title                    |       |
      | starting\_at             |       |
      | ending\_at               |       |
      | location                 |       |
      | video\_conferencing\_url |       |
      | application\_id          |       |
      | canceled                 |       |
      | remote\_data             |       |
    </Accordion>

    <Accordion title="Offers">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | status                  |       |
      | employment\_start\_date |       |
      | application\_id         |       |
      | custom\_fields          |       |
      | integration\_fields     |       |
      | remote\_created\_at     |       |
      | remote\_updated\_at     |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        Greenhouse exposes 4 hiring team lists per job. We also look at per-user job permissions (e.g. **Job Admin**).

        * **coordinators** (shown as "Coordinators" in the UI) maps to `COORDINATOR`
        * **hiring\_managers** (shown as "Hiring Managers" in the UI) maps to `HIRING_MANAGER`
        * **recruiters** (shown as "Recruiters" in the UI) maps to `RECRUITER`
        * **sourcers** (shown as "Sourcers" in the UI) maps to `SOURCER`
        * Custom job permissions role **name** values show as-is and have no unified type.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="User roles">
      <Note>
        Greenhouse derives roles from **site\_admin** on the user and job-assignment state. If job-admin data cannot be fetched, no system role rows are created.

        * When **site\_admin** is true, Kombo maps to unified type `ADMIN`
        * When **site\_admin** is false, Kombo maps to either **Job Admin** or **Basic** depending on assignments; both have no unified type.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | user\_id            |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Interviewing team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | interview\_id       |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                                           | Notes                                                                                               |
      | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
      | candidate.first\_name                                 |                                                                                                     |
      | candidate.last\_name                                  |                                                                                                     |
      | candidate.email\_address                              |                                                                                                     |
      | candidate.additional\_email\_addresses.email\_address |                                                                                                     |
      | candidate.company                                     |                                                                                                     |
      | candidate.title                                       |                                                                                                     |
      | candidate.phone\_number                               |                                                                                                     |
      | candidate.additional\_phone\_numbers.phone\_number    |                                                                                                     |
      | candidate.location.city                               |                                                                                                     |
      | candidate.location.country                            |                                                                                                     |
      | candidate.social\_links.url                           |                                                                                                     |
      | application.job\_id                                   |                                                                                                     |
      | application.stage\_id                                 |                                                                                                     |
      | attachments.name                                      |                                                                                                     |
      | attachments.content\_type                             |                                                                                                     |
      | attachments.data\_url                                 |                                                                                                     |
      | attachments.data                                      |                                                                                                     |
      | attachments.type                                      | Attachments of type "OTHER" will only be visible to admins due to a limitation in Greenhouse's API. |
      | source.name                                           |                                                                                                     |
      | source.unified\_key                                   |                                                                                                     |
      | source.id                                             |                                                                                                     |
      | sourced\_by.user\_id                                  |                                                                                                     |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                                           | Notes                                                                                               |
      | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
      | candidate.first\_name                                 |                                                                                                     |
      | candidate.last\_name                                  |                                                                                                     |
      | candidate.email\_address                              |                                                                                                     |
      | candidate.additional\_email\_addresses.email\_address |                                                                                                     |
      | candidate.company                                     |                                                                                                     |
      | candidate.title                                       |                                                                                                     |
      | candidate.phone\_number                               |                                                                                                     |
      | candidate.additional\_phone\_numbers.phone\_number    |                                                                                                     |
      | candidate.location.city                               |                                                                                                     |
      | candidate.location.country                            |                                                                                                     |
      | candidate.social\_links.url                           |                                                                                                     |
      | application.job\_id                                   |                                                                                                     |
      | application.stage\_id                                 |                                                                                                     |
      | attachments.name                                      |                                                                                                     |
      | attachments.content\_type                             |                                                                                                     |
      | attachments.data\_url                                 |                                                                                                     |
      | attachments.data                                      |                                                                                                     |
      | attachments.type                                      | Attachments of type "OTHER" will only be visible to admins due to a limitation in Greenhouse's API. |
      | source.name                                           |                                                                                                     |
      | source.unified\_key                                   |                                                                                                     |
      | source.id                                             |                                                                                                     |
      | sourced\_by.user\_id                                  |                                                                                                     |
    </Accordion>

    <Accordion title="Add tag to candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Remove tag from candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      | Input Field              | Notes                                                                                               |
      | ------------------------ | --------------------------------------------------------------------------------------------------- |
      | application\_id          |                                                                                                     |
      | attachment.name          |                                                                                                     |
      | attachment.content\_type |                                                                                                     |
      | attachment.data\_url     |                                                                                                     |
      | attachment.data          |                                                                                                     |
      | attachment.type          | Attachments of type "OTHER" will only be visible to admins due to a limitation in Greenhouse's API. |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Reject application">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | application\_id       |       |
      | rejection\_reason\_id |       |
      | note                  |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      | Input Field              | Notes                                                                                               |
      | ------------------------ | --------------------------------------------------------------------------------------------------- |
      | candidate\_id            |                                                                                                     |
      | attachment.name          |                                                                                                     |
      | attachment.content\_type |                                                                                                     |
      | attachment.data\_url     |                                                                                                     |
      | attachment.data          |                                                                                                     |
      | attachment.type          | Attachments of type "OTHER" will only be visible to admins due to a limitation in Greenhouse's API. |
    </Accordion>

    <Accordion title="Add result link to candidate">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | candidate\_id                       |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                                | Notes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
    | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
    | API Passthrough                        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    | Webhook Subscriptions                  | application\_updated: triggered when an application was updated candidate\_stage\_change: triggered when a candidate/application stage was changed new\_candidate\_application: triggered when a new candidate application was created new\_prospect\_application: triggered when a new prospect application was created delete\_application: triggered when an application was deleted hire\_candidate: triggered when a candidate was hired unhire\_candidate: triggered when a candidate was unhired reject\_candidate: triggered when a candidate was rejected unreject\_candidate: triggered when a candidate was unrejected candidate\_anonymized: triggered when a candidate was anonymized update\_candidate: triggered when a candidate was updated including tag assigned/unassigned delete\_candidate: triggered when a candidate was deleted interview\_deleted: triggered when an interview was deleted job\_created: triggered when a job was created job\_deleted: triggered when a job was deleted job\_updated: triggered when a job was updated job\_approved: triggered when a job was approved job\_post\_deleted: triggered when a job post was deleted job\_post\_created: triggered when a job post was created job\_post\_updated: triggered when a job post was updated including published/unpublished merge\_candidate: triggered when a candidate was merged offer\_created: triggered when an offer was created offer\_approved: triggered when an offer was approved offer\_updated: triggered when an offer was updated offer\_deleted: triggered when an offer was deleted ping: triggered when a webhook was configured and the endpoint is checked to confirm it is working Not covered: interview scheduled or updated Not covered: screening questions updated for a job |
    | Scope Testing                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    | Delta Syncs                            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    | Source Writing                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    | Sync Only Created Applications         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    | Connection Guide                       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    | Prerequisites                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    | Locate Admin                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    | Create credentials                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    | Candidate source tracking              |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    | Create Candidate Full Attachment Retry |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    | Candidate Cutoff Filtering             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    | Roles                                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    | System roles (e.g. Admin)              | Greenhouse derives roles from **site\_admin** on the user and job-assignment state. If job-admin data cannot be fetched, no system role rows are created.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |

    * When **site\_admin** is true, Kombo maps to unified type `ADMIN`
    * When **site\_admin** is false, Kombo maps to either **Job Admin** or **Basic** depending on assignments; both have no unified type. |
      \|   Job roles (e.g. Hiring Manager) | Greenhouse exposes 4 hiring team lists per job. We also look at per-user job permissions (e.g. **Job Admin**).
    * **coordinators** (shown as "Coordinators" in the UI) maps to `COORDINATOR`
    * **hiring\_managers** (shown as "Hiring Managers" in the UI) maps to `HIRING_MANAGER`
    * **recruiters** (shown as "Recruiters" in the UI) maps to `RECRUITER`
    * **sourcers** (shown as "Sourcers" in the UI) maps to `SOURCER`
    * Custom job permissions role **name** values show as-is and have no unified type. |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Choose this variant if you want to use the Greenhouse Harvest v1 API

For **Greenhouse (V1)**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Greenhouse (V3)" icon="https://storage.googleapis.com/kombo-assets/integrations/greenhousev3/icon.svg" href="/ats/connectors/greenhousev3">
    This is the recommended Greenhouse integration
  </Card>

  <Card title="Greenhouse Job Board" icon="https://storage.googleapis.com/kombo-assets/integrations/greenhousejobboard/icon.svg" href="/ats/connectors/greenhousejobboard">
    Choose this variant if you want to write Screening Question Answers with the Greenhouse Job Board API, this integration's coverage is limited
  </Card>

  <Card title="Greenhouse Assessment" icon="https://storage.googleapis.com/kombo-assets/integrations/greenhouse/icon.svg" href="/assessment/connectors/greenhouse">
    Greenhouse for the Assessment category
  </Card>
</CardGroup>

<Note>Multiple variants can be used within your Kombo environment at the same time.</Note>


# Greenhouse Job Board ATS Integration
Source: https://docs.kombo.dev/ats/connectors/greenhousejobboard

Greenhouse Job Board connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Greenhouse Job Board ATS integration allows you to sync ATS data between Greenhouse Job Board and your application through Kombo's unified API. The tool slug for this connector is `greenhousejobboard`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/24016766684689">
    Step-by-step instructions to connect your Greenhouse Job Board account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | confidential         |       |
      | status               |       |
      | visibility           |       |
      | department           |       |
      | post\_url            |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Job postings">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description\_html   |       |
      | status              |       |
      | visibility          |       |
      | url                 |       |
      | job\_id             |       |
      | remote\_data        |       |
      | remote\_updated\_at |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                               | Notes                                                                       |
      | ----------------------------------------- | --------------------------------------------------------------------------- |
      | candidate.first\_name                     |                                                                             |
      | candidate.last\_name                      |                                                                             |
      | candidate.email\_address                  |                                                                             |
      | candidate.phone\_number                   |                                                                             |
      | candidate.location.city                   |                                                                             |
      | candidate.location.country                |                                                                             |
      | application.job\_id                       |                                                                             |
      | screening\_question\_answers.question\_id |                                                                             |
      | screening\_question\_answers.answer       |                                                                             |
      | attachments.name                          |                                                                             |
      | attachments.content\_type                 |                                                                             |
      | attachments.data\_url                     |                                                                             |
      | attachments.data                          |                                                                             |
      | attachments.type                          | Attachments of type "OTHER" is not supported by Greenhouse's Job Board API. |
      | source.name                               |                                                                             |
      | source.unified\_key                       |                                                                             |
      | source.id                                 |                                                                             |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                               | Notes                                                                       |
      | ----------------------------------------- | --------------------------------------------------------------------------- |
      | candidate.first\_name                     |                                                                             |
      | candidate.last\_name                      |                                                                             |
      | candidate.email\_address                  |                                                                             |
      | candidate.phone\_number                   |                                                                             |
      | candidate.location.city                   |                                                                             |
      | candidate.location.country                |                                                                             |
      | application.job\_id                       |                                                                             |
      | screening\_question\_answers.question\_id |                                                                             |
      | screening\_question\_answers.answer       |                                                                             |
      | attachments.name                          |                                                                             |
      | attachments.content\_type                 |                                                                             |
      | attachments.data\_url                     |                                                                             |
      | attachments.data                          |                                                                             |
      | attachments.type                          | Attachments of type "OTHER" is not supported by Greenhouse's Job Board API. |
      | source.name                               |                                                                             |
      | source.unified\_key                       |                                                                             |
      | source.id                                 |                                                                             |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes                                    |
    | ------------------ | ---------------------------------------- |
    | API Passthrough    |                                          |
    | Scope Testing      |                                          |
    | Source Writing     |                                          |
    | Connection Guide   |                                          |
    | Prerequisites      |                                          |
    | Locate Admin       |                                          |
    | Create credentials |                                          |
    | EEO Questions      | We support demographic and EEO questions |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Choose this variant if you want to write Screening Question Answers with the Greenhouse Job Board API, this integration's coverage is limited

For **Greenhouse Job Board**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Greenhouse (V1)" icon="https://storage.googleapis.com/kombo-assets/integrations/greenhouse/icon.svg" href="/ats/connectors/greenhouse">
    Choose this variant if you want to use the Greenhouse Harvest v1 API
  </Card>

  <Card title="Greenhouse (V3)" icon="https://storage.googleapis.com/kombo-assets/integrations/greenhousev3/icon.svg" href="/ats/connectors/greenhousev3">
    This is the recommended Greenhouse integration
  </Card>
</CardGroup>

<Note>Multiple variants can be used within your Kombo environment at the same time.</Note>


# Greenhouse (V3) ATS Integration
Source: https://docs.kombo.dev/ats/connectors/greenhousev3

Greenhouse (V3) connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

<Note>This connector requires a partnership with Greenhouse (V3). Please contact us to get access.</Note>

The Greenhouse (V3) ATS integration allows you to sync ATS data between Greenhouse (V3) and your application through Kombo's unified API. The tool slug for this connector is `greenhousev3`.

## Guides and Resources

<CardGroup>
  <Card title="Source Setup Guide" icon="settings" href="https://help.kombo.dev/hc/en-us/articles/17075876539665">
    Learn how to set up candidate sources in Greenhouse (V3).
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | confidential         |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | department           |       |
      | post\_url            |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_url          |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Job postings">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description\_html   |       |
      | status              |       |
      | visibility          |       |
      | url                 |       |
      | job\_id             |       |
      | remote\_data        |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | confidential        |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                        | Notes |
      | ---------------------------- | ----- |
      | id                           |       |
      | remote\_id                   |       |
      | changed\_at                  |       |
      | remote\_deleted\_at          |       |
      | outcome                      |       |
      | rejection\_reason\_name      |       |
      | rejected\_at                 |       |
      | current\_stage\_id           |       |
      | job\_id                      |       |
      | candidate\_id                |       |
      | screening\_question\_answers |       |
      | custom\_fields               |       |
      | integration\_fields          |       |
      | remote\_url                  |       |
      | remote\_created\_at          |       |
      | remote\_updated\_at          |       |
      | remote\_data                 |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Interviews">
      | Field                    | Notes                                                                |
      | ------------------------ | -------------------------------------------------------------------- |
      | id                       |                                                                      |
      | remote\_id               |                                                                      |
      | changed\_at              |                                                                      |
      | remote\_deleted\_at      |                                                                      |
      | title                    |                                                                      |
      | starting\_at             |                                                                      |
      | ending\_at               |                                                                      |
      | location                 |                                                                      |
      | video\_conferencing\_url |                                                                      |
      | application\_id          |                                                                      |
      | stage\_id                |                                                                      |
      | canceled                 | If all interviewers decline the interview, it is considered canceled |
      | remote\_created\_at      |                                                                      |
      | remote\_updated\_at      |                                                                      |
      | remote\_data             |                                                                      |
    </Accordion>

    <Accordion title="Offers">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | status                  |       |
      | employment\_start\_date |       |
      | application\_id         |       |
      | custom\_fields          |       |
      | integration\_fields     |       |
      | remote\_created\_at     |       |
      | remote\_updated\_at     |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Notes">
      <Note>
        Greenhouse provides a wide variety of notes. We expose only those that provide direct signal about a candidate: `NOTE`, `INTERVIEW`, `FORM`, `FEEDBACK`
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | candidate\_id       |       |
      | application\_id     |       |
      | author\_id          |       |
      | title               |       |
      | content\_html       |       |
      | is\_private         |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        Greenhouse V3 exposes hiring team data via three flat endpoints plus per-user job admin permissions.

        * **job\_hiring\_managers** maps to `HIRING_MANAGER`
        * **job\_owners** with type `recruiter` maps to `RECRUITER`
        * **job\_owners** with type `coordinator` maps to `COORDINATOR`
        * **job\_owners** with type `sourcer` maps to `SOURCER`
        * **user\_job\_permissions** role names (e.g. "Standard", "Private") sync without a unified role type.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="User roles">
      <Note>
        Greenhouse derives roles from **site\_admin** on the user and job-assignment state. If job-permission data cannot be fetched, no system role rows are created.

        * When **site\_admin** is true, Kombo maps to unified type `ADMIN`
        * When **site\_admin** is false, Kombo maps to either **Job Admin** or **Basic** depending on assignments; both have no unified type.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | user\_id            |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Interviewing team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | interview\_id       |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                                           | Notes |
      | ----------------------------------------------------- | ----- |
      | candidate.first\_name                                 |       |
      | candidate.last\_name                                  |       |
      | candidate.email\_address                              |       |
      | candidate.additional\_email\_addresses.email\_address |       |
      | candidate.company                                     |       |
      | candidate.title                                       |       |
      | candidate.phone\_number                               |       |
      | candidate.additional\_phone\_numbers.phone\_number    |       |
      | candidate.location.city                               |       |
      | candidate.location.country                            |       |
      | candidate.social\_links.url                           |       |
      | application.job\_id                                   |       |
      | application.stage\_id                                 |       |
      | attachments.name                                      |       |
      | attachments.content\_type                             |       |
      | attachments.data\_url                                 |       |
      | attachments.data                                      |       |
      | attachments.type                                      |       |
      | source.name                                           |       |
      | source.unified\_key                                   |       |
      | source.id                                             |       |
      | sourced\_by.user\_id                                  |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                                           | Notes |
      | ----------------------------------------------------- | ----- |
      | candidate.first\_name                                 |       |
      | candidate.last\_name                                  |       |
      | candidate.email\_address                              |       |
      | candidate.additional\_email\_addresses.email\_address |       |
      | candidate.company                                     |       |
      | candidate.title                                       |       |
      | candidate.phone\_number                               |       |
      | candidate.additional\_phone\_numbers.phone\_number    |       |
      | candidate.location.city                               |       |
      | candidate.location.country                            |       |
      | candidate.social\_links.url                           |       |
      | application.job\_id                                   |       |
      | application.stage\_id                                 |       |
      | attachments.name                                      |       |
      | attachments.content\_type                             |       |
      | attachments.data\_url                                 |       |
      | attachments.data                                      |       |
      | attachments.type                                      |       |
      | source.name                                           |       |
      | source.unified\_key                                   |       |
      | source.id                                             |       |
      | sourced\_by.user\_id                                  |       |
    </Accordion>

    <Accordion title="Add tag to candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Remove tag from candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      | Input Field              | Notes                                                                                               |
      | ------------------------ | --------------------------------------------------------------------------------------------------- |
      | application\_id          |                                                                                                     |
      | attachment.name          |                                                                                                     |
      | attachment.content\_type |                                                                                                     |
      | attachment.data\_url     |                                                                                                     |
      | attachment.data          |                                                                                                     |
      | attachment.type          | Attachments of type "OTHER" will only be visible to admins due to a limitation in Greenhouse's API. |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Reject application">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | application\_id       |       |
      | rejection\_reason\_id |       |
      | note                  |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
    | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | OAuth                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | API Passthrough                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | Webhook Subscriptions          | ping: triggered when a webhook was configured and the endpoint is checked to confirm it is working update\_candidate: triggered when a candidate or prospect is updated, including when a tag is assigned or unassigned candidate\_anonymized: triggered when a candidate or prospect is anonymized, scrubbing PII from the candidate and their applications delete\_candidate: triggered when a candidate is deleted merge\_candidate: triggered when two candidates are merged application\_updated: triggered when an application is updated candidate\_stage\_change: triggered when an application's stage is changed hire\_candidate: triggered when a candidate is hired new\_candidate\_application: triggered when a new candidate application is created new\_prospect\_application: triggered when a new prospect application is created unhire\_candidate: triggered when a candidate is unhired reject\_candidate: triggered when a candidate or prospect is rejected unreject\_candidate: triggered when a candidate or prospect is unrejected delete\_application: triggered when an application is deleted job\_approved: triggered when a job is approved job\_created: triggered when a job is created job\_updated: triggered when a job is updated job\_deleted: triggered when a job is deleted job\_post\_created: triggered when a job post is created (a job is published) job\_post\_updated: triggered when a job post is updated job\_post\_deleted: triggered when a job post is deleted (a job is unpublished) interview\_deleted: triggered when an interview is deleted offer\_approved: triggered when an offer is approved offer\_created: triggered when an offer is created offer\_updated: triggered when an offer is updated offer\_deleted: triggered when an offer is deleted Not covered: screening questions updated for a job Not covered: interview scheduled or updated |
    | Automatic Setup                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | Scope Testing                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | Per Model Tests                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | Per Field Tests                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | Delta Syncs                    |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | Custom Field Explorer          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | Jobs                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | Candidates                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | Applications                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | Offers                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | Source Writing                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | Sync Only Created Applications |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | Candidate Cutoff Filtering     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | Roles                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | System roles (e.g. Admin)      | Greenhouse derives roles from **site\_admin** on the user and job-assignment state. If job-permission data cannot be fetched, no system role rows are created.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |

    * When **site\_admin** is true, Kombo maps to unified type `ADMIN`
    * When **site\_admin** is false, Kombo maps to either **Job Admin** or **Basic** depending on assignments; both have no unified type. |
      \|   Job roles (e.g. Hiring Manager) | Greenhouse V3 exposes hiring team data via three flat endpoints plus per-user job admin permissions.
    * **job\_hiring\_managers** maps to `HIRING_MANAGER`
    * **job\_owners** with type `recruiter` maps to `RECRUITER`
    * **job\_owners** with type `coordinator` maps to `COORDINATOR`
    * **job\_owners** with type `sourcer` maps to `SOURCER`
    * **user\_job\_permissions** role names (e.g. "Standard", "Private") sync without a unified role type. |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** This is the recommended Greenhouse integration

For **Greenhouse (V3)**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Greenhouse (V1)" icon="https://storage.googleapis.com/kombo-assets/integrations/greenhouse/icon.svg" href="/ats/connectors/greenhouse">
    Choose this variant if you want to use the Greenhouse Harvest v1 API
  </Card>

  <Card title="Greenhouse Job Board" icon="https://storage.googleapis.com/kombo-assets/integrations/greenhousejobboard/icon.svg" href="/ats/connectors/greenhousejobboard">
    Choose this variant if you want to write Screening Question Answers with the Greenhouse Job Board API, this integration's coverage is limited
  </Card>
</CardGroup>

<Note>Multiple variants can be used within your Kombo environment at the same time.</Note>


# GuideCom ATS Integration
Source: https://docs.kombo.dev/ats/connectors/guidecom

GuideCom connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The GuideCom ATS integration allows you to sync ATS data between GuideCom and your application through Kombo's unified API. The tool slug for this connector is `guidecom`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/27091381099025">
    Step-by-step instructions to connect your GuideCom account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | description         |       |
      | confidential        |       |
      | employment\_type    |       |
      | status              |       |
      | visibility          |       |
      | post\_url           |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | opened\_at          |       |
      | closed\_at          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.gender                          |       |
      | candidate.availability\_date              |       |
      | candidate.salary\_expectations.amount     |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.gender                          |       |
      | candidate.availability\_date              |       |
      | candidate.salary\_expectations.amount     |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | API Passthrough  |       |
    | Scope Testing    |       |
    | Source Writing   |       |
    | Connection Guide |       |
    | Prerequisites    |       |
  </Tab>
</Tabs>


# Heyrecruit ATS Integration
Source: https://docs.kombo.dev/ats/connectors/heyrecruit

Heyrecruit connector for Kombo's ATS API

The Heyrecruit ATS integration allows you to sync ATS data between Heyrecruit and your application through Kombo's unified API. The tool slug for this connector is `heyrecruit`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/25316265423505-Heyrecruit-How-do-I-link-my-account">
    Step-by-step instructions to connect your Heyrecruit account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | department           |       |
      | post\_url            |       |
      | remote\_work\_status |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.gender                          |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.expires\_at                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.gender                          |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.expires\_at                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | API Passthrough    |       |
    | Scope Testing      |       |
    | Per Model Tests    |       |
    | Source Writing     |       |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
  </Tab>
</Tabs>


# Homerun ATS Integration
Source: https://docs.kombo.dev/ats/connectors/homerun

Homerun connector for Kombo's ATS API

The Homerun ATS integration allows you to sync ATS data between Homerun and your application through Kombo's unified API. The tool slug for this connector is `homerun`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/17855632460305">
    Step-by-step instructions to connect your Homerun account to Kombo.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22569053876113-Homerun-How-to-view-a-candidates-source">
    How to view and manage candidate sources in Homerun.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | description          |       |
      | status               |       |
      | visibility           |       |
      | department           |       |
      | post\_url            |       |
      | remote\_work\_status |       |
      | location             |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                 | Notes |
      | --------------------------- | ----- |
      | candidate.first\_name       |       |
      | candidate.last\_name        |       |
      | candidate.email\_address    |       |
      | candidate.phone\_number     |       |
      | candidate.location.city     |       |
      | candidate.location.country  |       |
      | candidate.social\_links.url |       |
      | application.job\_id         |       |
      | attachments.name            |       |
      | attachments.content\_type   |       |
      | attachments.data\_url       |       |
      | attachments.data            |       |
      | attachments.type            |       |
      | source.name                 |       |
      | source.unified\_key         |       |
      | source.id                   |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                 | Notes |
      | --------------------------- | ----- |
      | candidate.first\_name       |       |
      | candidate.last\_name        |       |
      | candidate.email\_address    |       |
      | candidate.phone\_number     |       |
      | candidate.location.city     |       |
      | candidate.location.country  |       |
      | candidate.social\_links.url |       |
      | application.job\_id         |       |
      | attachments.name            |       |
      | attachments.content\_type   |       |
      | attachments.data\_url       |       |
      | attachments.data            |       |
      | attachments.type            |       |
      | source.name                 |       |
      | source.unified\_key         |       |
      | source.id                   |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      <Note>
        Homerun's API does not allow move application to "New" stage.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Add result link to candidate">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | candidate\_id                       |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | Scope Testing                  |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
    | Create credentials             |       |
  </Tab>
</Tabs>


# HR4YOU ATS Integration
Source: https://docs.kombo.dev/ats/connectors/hr4you

HR4YOU connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The HR4YOU ATS integration allows you to sync ATS data between HR4YOU and your application through Kombo's unified API. The tool slug for this connector is `hr4you`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/27216771733393-HR4YOU-Wie-verbinde-ich-meinen-Account">
    Step-by-step instructions to connect your HR4YOU account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | description         |       |
      | employment\_type    |       |
      | status              |       |
      | visibility          |       |
      | category            |       |
      | post\_url           |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | opened\_at          |       |
      | closed\_at          |       |
      | contact\_id         |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                | Notes |
      | -------------------------- | ----- |
      | candidate.first\_name      |       |
      | candidate.last\_name       |       |
      | candidate.email\_address   |       |
      | candidate.phone\_number    |       |
      | candidate.location.city    |       |
      | candidate.location.country |       |
      | candidate.gender           |       |
      | application.job\_id        |       |
      | application.stage\_id      |       |
      | attachments.name           |       |
      | attachments.content\_type  |       |
      | attachments.data\_url      |       |
      | attachments.data           |       |
      | attachments.type           |       |
      | source.name                |       |
      | source.unified\_key        |       |
      | source.id                  |       |
      | gdpr\_consent.given        |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                | Notes |
      | -------------------------- | ----- |
      | candidate.first\_name      |       |
      | candidate.last\_name       |       |
      | candidate.email\_address   |       |
      | candidate.phone\_number    |       |
      | candidate.location.city    |       |
      | candidate.location.country |       |
      | candidate.gender           |       |
      | application.job\_id        |       |
      | application.stage\_id      |       |
      | attachments.name           |       |
      | attachments.content\_type  |       |
      | attachments.data\_url      |       |
      | attachments.data           |       |
      | attachments.type           |       |
      | source.name                |       |
      | source.unified\_key        |       |
      | source.id                  |       |
      | gdpr\_consent.given        |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Custom Field Explorer          |       |
    | Jobs                           |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** HR4YOU

For **HR4YOU**, we also offer the following other connector variants:

<CardGroup>
  <Card title="HR4YOU HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/hr4you/icon.svg" href="/hris/connectors/hr4you">
    HR4YOU for the HRIS category
  </Card>
</CardGroup>


# HR Office ATS Integration
Source: https://docs.kombo.dev/ats/connectors/hroffice

HR Office connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The HR Office ATS integration allows you to sync ATS data between HR Office and your application through Kombo's unified API. The tool slug for this connector is `hroffice`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/24727324595345-HROffice-How-do-I-link-my-account">
    Step-by-step instructions to connect your HR Office account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      <Note>
        HROffice supports a range of weekly working hours. We expose the minimum of that range via the `weekly_hours` field.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | description         |       |
      | weekly\_hours       |       |
      | employment\_type    |       |
      | status              |       |
      | visibility          |       |
      | category            |       |
      | experience\_level   |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | opened\_at          |       |
      | closed\_at          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Creating applications requires the screening questions to be answered. The following fields might be required when submitting an application: `phone_number`, `salary_expectations`, `availability_date`, `location`, `cv`.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.availability\_date              |       |
      | candidate.salary\_expectations.period     |       |
      | candidate.salary\_expectations.amount     |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Creating applications requires the screening questions to be answered. The following fields might be required when submitting an application: `phone_number`, `salary_expectations`, `availability_date`, `location`, `cv`.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.availability\_date              |       |
      | candidate.salary\_expectations.period     |       |
      | candidate.salary\_expectations.amount     |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | API Passthrough  |       |
    | Connection Guide |       |
    | Prerequisites    |       |
  </Tab>
</Tabs>


# HR WORKS ATS Integration
Source: https://docs.kombo.dev/ats/connectors/hrworks

HR WORKS connector for Kombo's ATS API

The HR WORKS ATS integration allows you to sync ATS data between HR WORKS and your application through Kombo's unified API. The tool slug for this connector is `hrworks`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/23512851256465">
    Step-by-step instructions to connect your HR WORKS account to Kombo.
  </Card>

  <Card title="Source Setup Guide" icon="settings" href="https://help.kombo.dev/hc/en-us/articles/23496671552529">
    Learn how to set up candidate sources in HR WORKS.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | category             |       |
      | department           |       |
      | experience\_level    |       |
      | remote\_work\_status |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | contact\_id          |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Job postings">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description\_html   |       |
      | status              |       |
      | visibility          |       |
      | job\_id             |       |
      | remote\_data        |       |
      | remote\_created\_at |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Creating candidates in HRWorks might take longer than for other integrations.
      </Note>

      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.title                       |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.location.country            |       |
      | candidate.gender                      |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.period |       |
      | candidate.salary\_expectations.amount |       |
      | application.job\_id                   |       |
      | attachments.name                      |       |
      | attachments.content\_type             |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | source.name                           |       |
      | source.unified\_key                   |       |
      | source.id                             |       |
      | gdpr\_consent.given                   |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Creating candidates in HRWorks might take longer than for other integrations.
      </Note>

      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.title                       |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.location.country            |       |
      | candidate.gender                      |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.period |       |
      | candidate.salary\_expectations.amount |       |
      | application.job\_id                   |       |
      | attachments.name                      |       |
      | attachments.content\_type             |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | source.name                           |       |
      | source.unified\_key                   |       |
      | source.id                             |       |
      | gdpr\_consent.given                   |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | label                    |       |
      | url                      |       |
      | details.attributes.key   |       |
      | details.attributes.value |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                                | Notes |
    | -------------------------------------- | ----- |
    | API Passthrough                        |       |
    | Scope Testing                          |       |
    | Per Model Tests                        |       |
    | Source Writing                         |       |
    | Sync Only Created Applications         |       |
    | Connection Guide                       |       |
    | Prerequisites                          |       |
    | Create credentials                     |       |
    | Candidate source tracking              |       |
    | Create Candidate Full Attachment Retry |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** HR WORKS

For **HR WORKS**, we also offer the following other connector variants:

<CardGroup>
  <Card title="HR WORKS HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/hrworks/icon.svg" href="/hris/connectors/hrworks">
    HR WORKS for the HRIS category
  </Card>
</CardGroup>


# iCIMS ATS Integration
Source: https://docs.kombo.dev/ats/connectors/icims

iCIMS connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The iCIMS ATS integration allows you to sync ATS data between iCIMS and your application through Kombo's unified API. The tool slug for this connector is `icims`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/23339682549393--iCIMS-ATS-How-do-I-link-my-account">
    Step-by-step instructions to connect your iCIMS account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes                                                                                          |
      | -------------------- | ---------------------------------------------------------------------------------------------- |
      | id                   |                                                                                                |
      | remote\_id           |                                                                                                |
      | changed\_at          |                                                                                                |
      | remote\_deleted\_at  |                                                                                                |
      | name                 |                                                                                                |
      | job\_code            |                                                                                                |
      | description          |                                                                                                |
      | employment\_type     |                                                                                                |
      | status               |                                                                                                |
      | visibility           |                                                                                                |
      | category             |                                                                                                |
      | department           |                                                                                                |
      | post\_url            |                                                                                                |
      | remote\_work\_status | We infer the remote work status from the job location if it includes "remote" or "hybrid"      |
      | salary\_amount\_from |                                                                                                |
      | salary\_amount\_to   |                                                                                                |
      | salary\_currency     |                                                                                                |
      | salary\_period       |                                                                                                |
      | location             |                                                                                                |
      | custom\_fields       |                                                                                                |
      | integration\_fields  |                                                                                                |
      | remote\_url          | The direct link only resolves when "Direct Links" are enabled in the customer's iCIMS Platform |
      | opened\_at           |                                                                                                |
      | closed\_at           |                                                                                                |
      | remote\_created\_at  |                                                                                                |
      | remote\_updated\_at  |                                                                                                |
      | remote\_data         |                                                                                                |
    </Accordion>

    <Accordion title="Job postings">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | status              |       |
      | url                 |       |
      | job\_id             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes                                                                                          |
      | ------------------- | ---------------------------------------------------------------------------------------------- |
      | id                  |                                                                                                |
      | remote\_id          |                                                                                                |
      | changed\_at         |                                                                                                |
      | remote\_deleted\_at |                                                                                                |
      | first\_name         |                                                                                                |
      | last\_name          |                                                                                                |
      | company             |                                                                                                |
      | title               |                                                                                                |
      | source              |                                                                                                |
      | phone\_numbers      |                                                                                                |
      | email\_addresses    |                                                                                                |
      | social\_media       |                                                                                                |
      | location            |                                                                                                |
      | custom\_fields      |                                                                                                |
      | integration\_fields |                                                                                                |
      | remote\_url         | The direct link only resolves when "Direct Links" are enabled in the customer's iCIMS Platform |
      | remote\_created\_at |                                                                                                |
      | remote\_data        |                                                                                                |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | status              |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                        | Notes                                                                                                                   |
      | ---------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
      | id                           |                                                                                                                         |
      | remote\_id                   |                                                                                                                         |
      | changed\_at                  |                                                                                                                         |
      | remote\_deleted\_at          |                                                                                                                         |
      | outcome                      | Outcome is only available if the application is using a default application stage, custom stages do not have an outcome |
      | current\_stage\_id           |                                                                                                                         |
      | job\_id                      |                                                                                                                         |
      | candidate\_id                |                                                                                                                         |
      | screening\_question\_answers |                                                                                                                         |
      | custom\_fields               |                                                                                                                         |
      | integration\_fields          |                                                                                                                         |
      | remote\_created\_at          |                                                                                                                         |
      | remote\_data                 |                                                                                                                         |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        iCIMS exposes 2 standard job roles:

        * **hiringmanager** maps to unified type `HIRING_MANAGER`
        * **recruiter** maps to unified type `RECRUITER`

        Additional hiring team members can be surfaced via the `hiring_team_role_field_mappings` setting. People referenced by those custom job fields sync with the mapping's configured label and no unified type.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                 | Notes |
      | --------------------------- | ----- |
      | candidate.first\_name       |       |
      | candidate.last\_name        |       |
      | candidate.email\_address    |       |
      | candidate.phone\_number     |       |
      | candidate.gender            |       |
      | candidate.social\_links.url |       |
      | application.job\_id         |       |
      | application.stage\_id       |       |
      | attachments.name            |       |
      | attachments.content\_type   |       |
      | attachments.data\_url       |       |
      | attachments.data            |       |
      | attachments.type            |       |
      | source.name                 |       |
      | source.unified\_key         |       |
      | source.id                   |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                 | Notes |
      | --------------------------- | ----- |
      | candidate.first\_name       |       |
      | candidate.last\_name        |       |
      | candidate.email\_address    |       |
      | candidate.phone\_number     |       |
      | candidate.gender            |       |
      | candidate.social\_links.url |       |
      | application.job\_id         |       |
      | application.stage\_id       |       |
      | attachments.name            |       |
      | attachments.content\_type   |       |
      | attachments.data\_url       |       |
      | attachments.data            |       |
      | attachments.type            |       |
      | source.name                 |       |
      | source.unified\_key         |       |
      | source.id                   |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        Only attachment of the type `CV` is supported by iCIMS. This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      <Note>
        Only CVs are supported by iCIMS. Other attachments can't be retrieved.
      </Note>

      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      <Note>
        Only attachment of the type `CV` is supported by iCIMS.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                         | Notes                               |
    | ------------------------------- | ----------------------------------- |
    | API Passthrough                 |                                     |
    | Delta Syncs                     |                                     |
    | Source Writing                  |                                     |
    | Sync Only Created Applications  |                                     |
    | Connection Guide                |                                     |
    | Prerequisites                   |                                     |
    | Candidate Cutoff Filtering      |                                     |
    | Roles                           |                                     |
    | Job roles (e.g. Hiring Manager) | iCIMS exposes 2 standard job roles: |

    * **hiringmanager** maps to unified type `HIRING_MANAGER`
    * **recruiter** maps to unified type `RECRUITER`

    Additional hiring team members can be surfaced via the `hiring_team_role_field_mappings` setting. People referenced by those custom job fields sync with the mapping's configured label and no unified type. |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** iCIMS

For **iCIMS**, we also offer the following other connector variants:

<CardGroup>
  <Card title="iCIMS Assessment" icon="https://storage.googleapis.com/kombo-assets/integrations/icims/icon.svg" href="/assessment/connectors/icims">
    iCIMS for the Assessment category
  </Card>
</CardGroup>


# InRecruiting by Zucchetti ATS Integration
Source: https://docs.kombo.dev/ats/connectors/inrecruiting

InRecruiting by Zucchetti connector for Kombo's ATS API

The InRecruiting by Zucchetti ATS integration allows you to sync ATS data between InRecruiting by Zucchetti and your application through Kombo's unified API. The tool slug for this connector is `inrecruiting`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/26071358545681-InRecruiting-How-do-I-link-my-account">
    Step-by-step instructions to connect your InRecruiting by Zucchetti account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | confidential         |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | category             |       |
      | department           |       |
      | post\_url            |       |
      | experience\_level    |       |
      | remote\_work\_status |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Only the first CV attachment is processed. Valid extensions are pdf, doc, docx, odt, txt, rtf, pptx, jpeg, png, jpg, tif, tiff. Attachment type Other is used for the profile picture. Valid extensions are jpeg, png, jpg, tif, tiff. The attachment type COVER\_LETTER is not implemented yet.
      </Note>

      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.company                     |       |
      | candidate.title                       |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.location.country            |       |
      | candidate.gender                      |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.period |       |
      | candidate.salary\_expectations.amount |       |
      | candidate.social\_links.url           |       |
      | application.job\_id                   |       |
      | application.stage\_id                 |       |
      | attachments.name                      |       |
      | attachments.content\_type             |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | attachments.type                      |       |
      | source.name                           |       |
      | source.unified\_key                   |       |
      | source.id                             |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Only the first CV attachment is processed. Valid extensions are pdf, doc, docx, odt, txt, rtf, pptx, jpeg, png, jpg, tif, tiff. Attachment type Other is used for the profile picture. Valid extensions are jpeg, png, jpg, tif, tiff. The attachment type COVER\_LETTER is not implemented yet.
      </Note>

      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.company                     |       |
      | candidate.title                       |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.location.country            |       |
      | candidate.gender                      |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.period |       |
      | candidate.salary\_expectations.amount |       |
      | candidate.social\_links.url           |       |
      | application.job\_id                   |       |
      | application.stage\_id                 |       |
      | attachments.name                      |       |
      | attachments.content\_type             |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | attachments.type                      |       |
      | source.name                           |       |
      | source.unified\_key                   |       |
      | source.id                             |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        The attachment type COVER\_LETTER is not implemented yet. This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      <Note>
        The attachment type COVER\_LETTER is not implemented yet.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
    | Create credentials             |       |
  </Tab>
</Tabs>


# JazzHR ATS Integration
Source: https://docs.kombo.dev/ats/connectors/jazzhr

JazzHR connector for Kombo's ATS API

The JazzHR ATS integration allows you to sync ATS data between JazzHR and your application through Kombo's unified API. The tool slug for this connector is `jazzhr`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/32538982026513">
    Step-by-step instructions to connect your JazzHR account to Kombo.
  </Card>

  <Card title="Sandbox Environment" icon="flask" href="https://info.jazzhr.com/free-trial.html">
    Access the JazzHR sandbox environment for testing and development.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/30632976513297">
    How to view and manage candidate sources in JazzHR.
  </Card>

  <Card title="Automated exports for webhooks" icon="book" href="https://apidoc.jazzhrapis.com/candidate-export/#automatic-candidate-export">
    Additional documentation and guides for JazzHR.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | department           |       |
      | post\_url            |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | remote\_created\_at  |       |
      | contact\_id          |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                        | Notes |
      | ---------------------------- | ----- |
      | id                           |       |
      | remote\_id                   |       |
      | changed\_at                  |       |
      | remote\_deleted\_at          |       |
      | outcome                      |       |
      | current\_stage\_id           |       |
      | job\_id                      |       |
      | candidate\_id                |       |
      | screening\_question\_answers |       |
      | remote\_created\_at          |       |
      | remote\_data                 |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        JazzHR exposes one hiring lead per job

        * **hiring\_lead** maps to unified type `HIRING_MANAGER`
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="User roles">
      <Note>
        JazzHR assigns each user one system role (**type**)

        * **type** Super Admin, Recruiting Admin, or Super User maps to unified type `ADMIN`
        * **type** Recruiting User or External Recruiter maps to unified type `RECRUITER`
        * **type** Interviewer maps to unified type `INTERVIEWER`
        * Any other **type** (e.g. Developer) has no unified type
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | user\_id            |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                               | Notes                                                                                             |
      | ----------------------------------------- | ------------------------------------------------------------------------------------------------- |
      | candidate.first\_name                     |                                                                                                   |
      | candidate.last\_name                      |                                                                                                   |
      | candidate.email\_address                  |                                                                                                   |
      | candidate.phone\_number                   |                                                                                                   |
      | candidate.location.city                   |                                                                                                   |
      | candidate.location.state                  |                                                                                                   |
      | candidate.location.street\_1              |                                                                                                   |
      | candidate.location.zip\_code              |                                                                                                   |
      | candidate.social\_links.url               |                                                                                                   |
      | application.job\_id                       |                                                                                                   |
      | application.stage\_id                     | You need to know which Stage IDs are available for each job in JazzHR in order to use this field. |
      | screening\_question\_answers.question\_id |                                                                                                   |
      | screening\_question\_answers.answer       |                                                                                                   |
      | attachments.name                          |                                                                                                   |
      | attachments.content\_type                 |                                                                                                   |
      | attachments.data\_url                     |                                                                                                   |
      | attachments.data                          |                                                                                                   |
      | attachments.type                          |                                                                                                   |
      | source.name                               |                                                                                                   |
      | source.unified\_key                       |                                                                                                   |
      | source.id                                 |                                                                                                   |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                               | Notes                                                                                             |
      | ----------------------------------------- | ------------------------------------------------------------------------------------------------- |
      | candidate.first\_name                     |                                                                                                   |
      | candidate.last\_name                      |                                                                                                   |
      | candidate.email\_address                  |                                                                                                   |
      | candidate.phone\_number                   |                                                                                                   |
      | candidate.location.city                   |                                                                                                   |
      | candidate.location.state                  |                                                                                                   |
      | candidate.location.street\_1              |                                                                                                   |
      | candidate.location.zip\_code              |                                                                                                   |
      | candidate.social\_links.url               |                                                                                                   |
      | application.job\_id                       |                                                                                                   |
      | application.stage\_id                     | You need to know which Stage IDs are available for each job in JazzHR in order to use this field. |
      | screening\_question\_answers.question\_id |                                                                                                   |
      | screening\_question\_answers.answer       |                                                                                                   |
      | attachments.name                          |                                                                                                   |
      | attachments.content\_type                 |                                                                                                   |
      | attachments.data\_url                     |                                                                                                   |
      | attachments.data                          |                                                                                                   |
      | attachments.type                          |                                                                                                   |
      | source.name                               |                                                                                                   |
      | source.unified\_key                       |                                                                                                   |
      | source.id                                 |                                                                                                   |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        All attachments added with the add application attachments actions will be written into the documents section in JazzHR. It is not possible to specify the type.
      </Note>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | application\_id      |       |
      | attachment.name      |       |
      | attachment.data\_url |       |
      | attachment.data      |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      <Note>
        All attachments added with the add application attachments actions will be written into the documents section in JazzHR. It is not possible to specify the type.
      </Note>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | candidate\_id        |       |
      | attachment.name      |       |
      | attachment.data\_url |       |
      | attachment.data      |       |
    </Accordion>

    <Accordion title="Add result link to candidate">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | candidate\_id                       |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes                                                                                                                                                                                                                                                            |
    | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | API Passthrough                |                                                                                                                                                                                                                                                                  |
    | Webhook Subscriptions          | Detailed coverage unknown, please reach out to support: job published, job unpublished, candidate created, application stage changed, tag assigned, screening questions updated, interview scheduled, interview updated CANDIDATE-EXPORT: triggered when unknown |
    | Source Writing                 |                                                                                                                                                                                                                                                                  |
    | Sync Only Created Applications |                                                                                                                                                                                                                                                                  |
    | Connection Guide               |                                                                                                                                                                                                                                                                  |
    | Prerequisites                  |                                                                                                                                                                                                                                                                  |
    | Create credentials             |                                                                                                                                                                                                                                                                  |
    | Candidate Cutoff Filtering     |                                                                                                                                                                                                                                                                  |
    | Roles                          |                                                                                                                                                                                                                                                                  |
    | System roles (e.g. Admin)      | JazzHR assigns each user one system role (**type**)                                                                                                                                                                                                              |

    * **type** Super Admin, Recruiting Admin, or Super User maps to unified type `ADMIN`
    * **type** Recruiting User or External Recruiter maps to unified type `RECRUITER`
    * **type** Interviewer maps to unified type `INTERVIEWER`
    * Any other **type** (e.g. Developer) has no unified type |
      \|   Job roles (e.g. Hiring Manager) | JazzHR exposes one hiring lead per job
    * **hiring\_lead** maps to unified type `HIRING_MANAGER` |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** JazzHR

For **JazzHR**, we also offer the following other connector variants:

<CardGroup>
  <Card title="JazzHR Assessment" icon="https://storage.googleapis.com/kombo-assets/integrations/jazzhr/icon.svg" href="/assessment/connectors/jazzhr">
    JazzHR for the Assessment category
  </Card>
</CardGroup>


# JobAdder ATS Integration
Source: https://docs.kombo.dev/ats/connectors/jobadder

JobAdder connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The JobAdder ATS integration allows you to sync ATS data between JobAdder and your application through Kombo's unified API. The tool slug for this connector is `jobadder`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/46864804620817-JobAdder-How-do-I-link-my-account">
    Step-by-step instructions to connect your JobAdder account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Interviews">
      | Field                    | Notes |
      | ------------------------ | ----- |
      | id                       |       |
      | remote\_id               |       |
      | changed\_at              |       |
      | remote\_deleted\_at      |       |
      | title                    |       |
      | starting\_at             |       |
      | ending\_at               |       |
      | location                 |       |
      | video\_conferencing\_url |       |
      | application\_id          |       |
      | remote\_created\_at      |       |
      | remote\_updated\_at      |       |
      | remote\_data             |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Interviewing team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | interview\_id       |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                                        | Notes |
      | -------------------------------------------------- | ----- |
      | candidate.first\_name                              |       |
      | candidate.last\_name                               |       |
      | candidate.email\_address                           |       |
      | candidate.company                                  |       |
      | candidate.title                                    |       |
      | candidate.phone\_number                            |       |
      | candidate.additional\_phone\_numbers.type          |       |
      | candidate.additional\_phone\_numbers.phone\_number |       |
      | candidate.location.city                            |       |
      | candidate.location.country                         |       |
      | candidate.location.state                           |       |
      | candidate.location.street\_1                       |       |
      | candidate.location.zip\_code                       |       |
      | candidate.availability\_date                       |       |
      | candidate.social\_links.url                        |       |
      | application.job\_id                                |       |
      | application.stage\_id                              |       |
      | attachments.name                                   |       |
      | attachments.content\_type                          |       |
      | attachments.data\_url                              |       |
      | attachments.data                                   |       |
      | attachments.type                                   |       |
      | source.name                                        |       |
      | source.unified\_key                                |       |
      | source.id                                          |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                                        | Notes |
      | -------------------------------------------------- | ----- |
      | candidate.first\_name                              |       |
      | candidate.last\_name                               |       |
      | candidate.email\_address                           |       |
      | candidate.company                                  |       |
      | candidate.title                                    |       |
      | candidate.phone\_number                            |       |
      | candidate.additional\_phone\_numbers.type          |       |
      | candidate.additional\_phone\_numbers.phone\_number |       |
      | candidate.location.city                            |       |
      | candidate.location.country                         |       |
      | candidate.location.state                           |       |
      | candidate.location.street\_1                       |       |
      | candidate.location.zip\_code                       |       |
      | candidate.availability\_date                       |       |
      | candidate.social\_links.url                        |       |
      | application.job\_id                                |       |
      | application.stage\_id                              |       |
      | attachments.name                                   |       |
      | attachments.content\_type                          |       |
      | attachments.data\_url                              |       |
      | attachments.data                                   |       |
      | attachments.type                                   |       |
      | source.name                                        |       |
      | source.unified\_key                                |       |
      | source.id                                          |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
    | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | OAuth                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    | API Passthrough                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    | Webhook Subscriptions          | jobapplication\_status\_changed: triggered when an application was created or its application stage changed in JobAdder candidate\_status\_changed: triggered when a candidate was created or its status changed in JobAdder candidate\_updated: triggered when a candidate was updated or deleted in JobAdder job\_status\_changed: triggered when a job was created or its status changed in JobAdder Not covered: interview scheduled Not covered: interview updated Not covered: tag assigned to a candidate Not covered: job published Not covered: job unpublished Not covered: screening questions updated |
    | Automatic Setup                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    | Scope Testing                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    | Custom Field Explorer          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    | Jobs                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    | Candidates                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    | Source Writing                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    | Sync Only Created Applications |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    | Connection Guide               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    | Candidate Cutoff Filtering     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
  </Tab>
</Tabs>


# JobDiva ATS Integration
Source: https://docs.kombo.dev/ats/connectors/jobdiva

JobDiva connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The JobDiva ATS integration allows you to sync ATS data between JobDiva and your application through Kombo's unified API. The tool slug for this connector is `jobdiva`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/26411503893905-JobDiva-How-do-I-link-my-account">
    Step-by-step instructions to connect your JobDiva account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | category             |       |
      | department           |       |
      | remote\_work\_status |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_url          |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        Jobdiva exposes multiple types of roles as flags on each **users** row

        * **CONTACTID** maps to unified type `HIRING_MANAGER`
        * **PRIMARYRECRUITER**, **RECRUITER**, **Secondary Recruiter**, and **Tertiary Recruiter** (value **1**) map to unified type `RECRUITER`
        * **PRIMARYSALES**, **SALES**, **Secondary Sales**, and **Tertiary Sales** (value **1**) have no unified type
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="User roles">
      <Note>
        JobDiva users have independent permission flags. Each flag set to **1** yields one system role row, so a user can have multiple system roles.

        * **SUPERUSERFLAG** (**1**) maps to unified type `ADMIN`
        * **RECRUITERFLAG** (**1**) maps to unified type `RECRUITER`
        * **RECRUITINGMANAGERFLAG**, **SALESFLAG**, and **TEAMLEADERFLAG** (**1**) have no unified type.
        * If no flag is **1**, no system role is synced.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | user\_id            |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        JobDiva only supports uploading CV attachments.
      </Note>

      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.company                     |       |
      | candidate.title                       |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.location.country            |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.amount |       |
      | candidate.social\_links.url           |       |
      | application.job\_id                   |       |
      | attachments.name                      |       |
      | attachments.content\_type             |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | attachments.type                      |       |
      | source.name                           |       |
      | source.unified\_key                   |       |
      | source.id                             |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        JobDiva only supports uploading CV attachments.
      </Note>

      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.company                     |       |
      | candidate.title                       |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.location.country            |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.amount |       |
      | candidate.social\_links.url           |       |
      | application.job\_id                   |       |
      | attachments.name                      |       |
      | attachments.content\_type             |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | attachments.type                      |       |
      | source.name                           |       |
      | source.unified\_key                   |       |
      | source.id                             |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        JobDiva only supports uploading CV attachments.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes                                                                                                                                         |
    | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
    | API Passthrough                |                                                                                                                                               |
    | Delta Syncs                    |                                                                                                                                               |
    | Source Writing                 |                                                                                                                                               |
    | Sync Only Created Applications |                                                                                                                                               |
    | Connection Guide               |                                                                                                                                               |
    | Create credentials             |                                                                                                                                               |
    | Roles                          |                                                                                                                                               |
    | System roles (e.g. Admin)      | JobDiva users have independent permission flags. Each flag set to **1** yields one system role row, so a user can have multiple system roles. |

    * **SUPERUSERFLAG** (**1**) maps to unified type `ADMIN`
    * **RECRUITERFLAG** (**1**) maps to unified type `RECRUITER`
    * **RECRUITINGMANAGERFLAG**, **SALESFLAG**, and **TEAMLEADERFLAG** (**1**) have no unified type.
    * If no flag is **1**, no system role is synced. |
      \|   Job roles (e.g. Hiring Manager) | Jobdiva exposes multiple types of roles as flags on each **users** row
    * **CONTACTID** maps to unified type `HIRING_MANAGER`
    * **PRIMARYRECRUITER**, **RECRUITER**, **Secondary Recruiter**, and **Tertiary Recruiter** (value **1**) map to unified type `RECRUITER`
    * **PRIMARYSALES**, **SALES**, **Secondary Sales**, and **Tertiary Sales** (value **1**) have no unified type |
  </Tab>
</Tabs>


# Jobvite ATS Integration
Source: https://docs.kombo.dev/ats/connectors/jobvite

Jobvite connector for Kombo's ATS API

The Jobvite ATS integration allows you to sync ATS data between Jobvite and your application through Kombo's unified API. The tool slug for this connector is `jobvite`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/17934402207377">
    Step-by-step instructions to connect your Jobvite account to Kombo.
  </Card>

  <Card title="How to Set up Adding Result Links" icon="book" href="https://help.kombo.dev/hc/en-us/articles/26729234564625">
    Additional documentation and guides for Jobvite.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | description         |       |
      | employment\_type    |       |
      | status              |       |
      | visibility          |       |
      | category            |       |
      | department          |       |
      | post\_url           |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | closed\_at          |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | contact\_id         |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        Jobvite exposes multiple roles for the job

        * **hiringManagers** entries (shown as "Hiring Manager" in the UI) map to unified type `HIRING_MANAGER`
        * **recruiters** entries (shown as "Recruiter" in the UI) map to unified type `RECRUITER`
        * **createdBy** has no unified type.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                  | Notes |
      | ---------------------------- | ----- |
      | candidate.first\_name        |       |
      | candidate.last\_name         |       |
      | candidate.email\_address     |       |
      | candidate.company            |       |
      | candidate.title              |       |
      | candidate.phone\_number      |       |
      | candidate.location.city      |       |
      | candidate.location.country   |       |
      | candidate.location.state     |       |
      | candidate.location.street\_1 |       |
      | candidate.location.zip\_code |       |
      | application.job\_id          |       |
      | attachments.name             |       |
      | attachments.data\_url        |       |
      | attachments.data             |       |
      | attachments.type             |       |
      | source.name                  |       |
      | source.unified\_key          |       |
      | source.id                    |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                  | Notes |
      | ---------------------------- | ----- |
      | candidate.first\_name        |       |
      | candidate.last\_name         |       |
      | candidate.email\_address     |       |
      | candidate.company            |       |
      | candidate.title              |       |
      | candidate.phone\_number      |       |
      | candidate.location.city      |       |
      | candidate.location.country   |       |
      | candidate.location.state     |       |
      | candidate.location.street\_1 |       |
      | candidate.location.zip\_code |       |
      | application.job\_id          |       |
      | attachments.name             |       |
      | attachments.data\_url        |       |
      | attachments.data             |       |
      | attachments.type             |       |
      | source.name                  |       |
      | source.unified\_key          |       |
      | source.id                    |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Reject application">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | application\_id       |       |
      | rejection\_reason\_id |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      <Note>
        The note's content will be written into the application's comment section in Jobvite.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>

    <Accordion title="Add result link to candidate">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | candidate\_id                       |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                         | Notes                                      |
    | ------------------------------- | ------------------------------------------ |
    | API Passthrough                 |                                            |
    | Scope Testing                   |                                            |
    | Delta Syncs                     |                                            |
    | Source Writing                  |                                            |
    | Sync Only Created Applications  |                                            |
    | Connection Guide                |                                            |
    | Prerequisites                   |                                            |
    | Create credentials              |                                            |
    | Candidate Cutoff Filtering      |                                            |
    | Roles                           |                                            |
    | Job roles (e.g. Hiring Manager) | Jobvite exposes multiple roles for the job |

    * **hiringManagers** entries (shown as "Hiring Manager" in the UI) map to unified type `HIRING_MANAGER`
    * **recruiters** entries (shown as "Recruiter" in the UI) map to unified type `RECRUITER`
    * **createdBy** has no unified type. |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Jobvite

For **Jobvite**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Jobvite Assessment" icon="https://storage.googleapis.com/kombo-assets/integrations/jobvite/icon.svg" href="/assessment/connectors/jobvite">
    Jobvite for the Assessment category
  </Card>
</CardGroup>


# Jobylon ATS Integration
Source: https://docs.kombo.dev/ats/connectors/jobylon

Jobylon connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Jobylon ATS integration allows you to sync ATS data between Jobylon and your application through Kombo's unified API. The tool slug for this connector is `jobylon`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/25383642309265-Jobylon-How-do-I-link-my-account">
    Step-by-step instructions to connect your Jobylon account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      <Note>
        We currently only fetch hiring team members from the Jobylon Push API.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      <Note>
        We only map the first location on the locations array.
      </Note>

      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | category             |       |
      | department           |       |
      | post\_url            |       |
      | experience\_level    |       |
      | remote\_work\_status |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      <Note>
        Only candidates routed through the customer's Partner API workflow are visible. Other candidates remain unsupported and continue to flow through the Push API webhook with reduced coverage.
      </Note>

      | Field               | Notes                                                              |
      | ------------------- | ------------------------------------------------------------------ |
      | id                  |                                                                    |
      | changed\_at         |                                                                    |
      | remote\_deleted\_at |                                                                    |
      | source              | Only available for candidates routed through the partner workflow. |
    </Accordion>

    <Accordion title="Application Stages">
      <Note>
        Application stages are not exposed via Jobylon's API, but it's included in their *"ApplicationEvent"* webhook. Therefore, your customer will need to contact Jobylon's support to set up a webhook configuration if you wish to read stages.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      <Note>
        Only applications routed through the customer's Partner API workflow are available.
      </Note>

      | Field                        | Notes                                                                                                                                                                                                                     |
      | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
      | id                           |                                                                                                                                                                                                                           |
      | changed\_at                  |                                                                                                                                                                                                                           |
      | remote\_deleted\_at          |                                                                                                                                                                                                                           |
      | screening\_question\_answers | Read from the Partner API for candidates in the partner workflow. Text answers (`text`, `text-short`, `code`) and `range` (number) answers are mapped; other answer types are returned as `UNKNOWN` with the raw payload. |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.gender                          |       |
      | candidate.availability\_date              |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.gender                          |       |
      | candidate.availability\_date              |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | API Passthrough       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
    | Webhook Subscriptions | Detailed coverage unknown, please reach out to support: job published, job unpublished, candidate created, application stage changed, tag assigned, screening questions updated, interview scheduled, interview updated application:created: triggered when an application was created application:status\_changed: triggered when an application status was changed application:rejection\_sent: triggered when a rejection was sent for an application application:tags\_changed: triggered when tags were changed on an application job: triggered when a job was created or updated job:status\_changed: triggered when a job status was changed (e.g., published or unpublished) |
    | Source Writing        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
    | Connection Guide      |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Jobylon

For **Jobylon**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Jobylon Assessment" icon="https://storage.googleapis.com/kombo-assets/integrations/jobylon/icon.svg" href="/assessment/connectors/jobylon">
    Jobylon for the Assessment category
  </Card>
</CardGroup>


# JOIN ATS Integration
Source: https://docs.kombo.dev/ats/connectors/join

JOIN connector for Kombo's ATS API

The JOIN ATS integration allows you to sync ATS data between JOIN and your application through Kombo's unified API. The tool slug for this connector is `join`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/17658999303441">
    Step-by-step instructions to connect your JOIN account to Kombo.
  </Card>

  <Card title="Sandbox Environment" icon="flask" href="https://join.com/auth/signup/recruiter">
    Access the JOIN sandbox environment for testing and development.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22543630093329-Join-How-to-view-a-candidates-source">
    How to view and manage candidate sources in JOIN.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      <Note>
        Contacts can't be connected if they don't have an email We can't really read users, but just indirectly get them through jobs
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | category             |       |
      | post\_url            |       |
      | experience\_level    |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | contact\_id          |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      <Note>
        Job stages are derived from applications. If a job does not have any applications, it will not have any associated stages. A stage on a job's pipeline will only appear if at least one synced application on that job has been in that stage. The JOIN API does not expose pipeline or per-job stage endpoints.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate.first\_name    |       |
      | candidate.last\_name     |       |
      | candidate.email\_address |       |
      | application.job\_id      |       |
      | attachments.name         |       |
      | attachments.data\_url    |       |
      | attachments.data         |       |
      | attachments.type         |       |
      | source.name              |       |
      | source.unified\_key      |       |
      | source.id                |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate.first\_name    |       |
      | candidate.last\_name     |       |
      | candidate.email\_address |       |
      | application.job\_id      |       |
      | attachments.name         |       |
      | attachments.data\_url    |       |
      | attachments.data         |       |
      | attachments.type         |       |
      | source.name              |       |
      | source.unified\_key      |       |
      | source.id                |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                                | Notes |
    | -------------------------------------- | ----- |
    | API Passthrough                        |       |
    | Source Writing                         |       |
    | Sync Only Created Applications         |       |
    | Connection Guide                       |       |
    | Prerequisites                          |       |
    | Create credentials                     |       |
    | Create Candidate Full Attachment Retry |       |
  </Tab>
</Tabs>


# Kula ATS Integration
Source: https://docs.kombo.dev/ats/connectors/kula

Kula connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Kula ATS integration allows you to sync ATS data between Kula and your application through Kombo's unified API. The tool slug for this connector is `kula`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/45705121319313-Kula-How-do-I-link-my-account">
    Step-by-step instructions to connect your Kula account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | department           |       |
      | remote\_work\_status |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Interviews">
      | Field                    | Notes                                                                                                                                                                                |
      | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
      | id                       |                                                                                                                                                                                      |
      | remote\_id               |                                                                                                                                                                                      |
      | changed\_at              |                                                                                                                                                                                      |
      | remote\_deleted\_at      |                                                                                                                                                                                      |
      | title                    |                                                                                                                                                                                      |
      | starting\_at             |                                                                                                                                                                                      |
      | ending\_at               |                                                                                                                                                                                      |
      | location                 |                                                                                                                                                                                      |
      | video\_conferencing\_url |                                                                                                                                                                                      |
      | application\_id          |                                                                                                                                                                                      |
      | stage\_id                |                                                                                                                                                                                      |
      | canceled                 | Derived from the Kula interview status: `true` when the interview is cancelled or marked as a candidate no-show, and `false` for any other status (not started, in progress, ended). |
      | remote\_created\_at      |                                                                                                                                                                                      |
      | remote\_updated\_at      |                                                                                                                                                                                      |
      | remote\_data             |                                                                                                                                                                                      |
    </Accordion>

    <Accordion title="Offers">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | status              |       |
      | application\_id     |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        Kula exposes four hiring team lists on each job:

        * **recruiters** maps to unified type `RECRUITER`
        * **hiring\_managers** maps to unified type `HIRING_MANAGER`
        * **coordinators** maps to unified type `COORDINATOR`
        * **external\_recruiters** maps to unified type `RECRUITER`
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Interviewing team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | interview\_id       |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Kula POST /v1/candidates does not accept file attachments.
      </Note>

      | Input Field                 | Notes |
      | --------------------------- | ----- |
      | candidate.first\_name       |       |
      | candidate.last\_name        |       |
      | candidate.email\_address    |       |
      | candidate.phone\_number     |       |
      | candidate.social\_links.url |       |
      | application.job\_id         |       |
      | application.stage\_id       |       |
      | source.name                 |       |
      | source.unified\_key         |       |
      | source.id                   |       |
      | sourced\_by.user\_id        |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Kula POST /v1/candidates does not accept file attachments.
      </Note>

      | Input Field                 | Notes |
      | --------------------------- | ----- |
      | candidate.first\_name       |       |
      | candidate.last\_name        |       |
      | candidate.email\_address    |       |
      | candidate.phone\_number     |       |
      | candidate.social\_links.url |       |
      | application.job\_id         |       |
      | application.stage\_id       |       |
      | source.name                 |       |
      | source.unified\_key         |       |
      | source.id                   |       |
      | sourced\_by.user\_id        |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Add result link to application">
      <Note>
        Kula does not expose a dedicated result link field. Result links are written as an application note (POST /v1/applications//notes) using the standard Kombo plain-text summary (label, details, and URL).
      </Note>

      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                         | Notes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
    | API Passthrough                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    | Webhook Subscriptions           | candidate.created: triggered when a candidate profile is created candidate.updated: triggered when a candidate profile is updated application.created: triggered when an application is submitted application.screened: triggered when an application screening completes application.updated: triggered when an application is substantially updated application.stage\_changed: triggered when an application stage changes application.rejected: triggered when an application is rejected application.hired: triggered when an application is marked hired job.created: triggered when a job is created job.updated: triggered when a job is updated job\_posting.published: triggered when a job posting is published and goes live job\_posting.updated: triggered when a published job posting is updated requisition.created: triggered when a requisition is created requisition.updated: triggered when a requisition is updated requisition.opened: triggered when a requisition is opened requisition.filled: triggered when a requisition is filled requisition.closed: triggered when a requisition is closed offer.created: triggered when an offer record is created offer.updated: triggered when an offer record is updated offer.approved: triggered when an offer is approved in workflow offer.deleted: triggered when an offer is cancelled or deleted offer.accepted: triggered when a candidate accepts an offer offer.declined: triggered when a candidate declines an offer Not covered: job unpublished when a posting is taken offline When an application stage changed we re-fetch the application from the Kula API. Not covered: tag assigned to candidates Not covered: screening questions updated on jobs Not covered: interview scheduled Not covered: interview scheduled and interview updated |
    | Automatic Setup                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    | Scope Testing                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    | Delta Syncs                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    | Source Writing                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    | Sync Only Created Applications  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    | Connection Guide                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    | Roles                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    | Job roles (e.g. Hiring Manager) | Kula exposes four hiring team lists on each job:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |

    * **recruiters** maps to unified type `RECRUITER`
    * **hiring\_managers** maps to unified type `HIRING_MANAGER`
    * **coordinators** maps to unified type `COORDINATOR`
    * **external\_recruiters** maps to unified type `RECRUITER` |
  </Tab>
</Tabs>


# Laura ATS Integration
Source: https://docs.kombo.dev/ats/connectors/laura

Laura connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Laura ATS integration allows you to sync ATS data between Laura and your application through Kombo's unified API. The tool slug for this connector is `laura`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/34292498671121-Laura-How-Do-I-Link-My-Account">
    Step-by-step instructions to connect your Laura account to Kombo.
  </Card>
</CardGroup>

## General Notes

* Support for application attachments is currently not implemented, however likely possible. We are working closely with Laura to support this as soon as possible.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | description         |       |
      | status              |       |
      | visibility          |       |
      | post\_url           |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | opened\_at          |       |
      | closed\_at          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                        | Notes |
      | ---------------------------- | ----- |
      | id                           |       |
      | remote\_id                   |       |
      | changed\_at                  |       |
      | remote\_deleted\_at          |       |
      | outcome                      |       |
      | current\_stage\_id           |       |
      | job\_id                      |       |
      | candidate\_id                |       |
      | screening\_question\_answers |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | format              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.zip\_code              |       |
      | candidate.gender                          |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.zip\_code              |       |
      | candidate.gender                          |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
  </Tab>
</Tabs>


# Lever ATS Integration
Source: https://docs.kombo.dev/ats/connectors/lever

Lever connector for Kombo's ATS API

The Lever ATS integration allows you to sync ATS data between Lever and your application through Kombo's unified API. The tool slug for this connector is `lever`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/15754845715985-How-do-I-link-my-Lever-account-">
    Step-by-step instructions to connect your Lever account to Kombo.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22577222710417-Lever-How-to-view-a-candidates-source">
    How to view and manage candidate sources in Lever.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      <Note>
        Job locations in Lever are entirely freetext strings. We return Lever job locations in the "raw" field of our locations.
      </Note>

      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | description          |       |
      | confidential         |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | department           |       |
      | post\_url            |       |
      | experience\_level    |       |
      | remote\_work\_status |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_url          |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | contact\_id          |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Job postings">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description\_html   |       |
      | status              |       |
      | visibility          |       |
      | job\_id             |       |
    </Accordion>

    <Accordion title="Candidates">
      <Note>
        We use the opportunityId for candidates because Lever treats opportunities more similar to how we treat candidates.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | confidential        |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                        | Notes |
      | ---------------------------- | ----- |
      | id                           |       |
      | remote\_id                   |       |
      | changed\_at                  |       |
      | remote\_deleted\_at          |       |
      | outcome                      |       |
      | rejection\_reason\_name      |       |
      | rejected\_at                 |       |
      | current\_stage\_id           |       |
      | job\_id                      |       |
      | candidate\_id                |       |
      | screening\_question\_answers |       |
      | custom\_fields               |       |
      | integration\_fields          |       |
      | remote\_url                  |       |
      | remote\_created\_at          |       |
      | remote\_updated\_at          |       |
      | remote\_data                 |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
      | category            |       |
    </Accordion>

    <Accordion title="Tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Interviews">
      | Field                    | Notes |
      | ------------------------ | ----- |
      | id                       |       |
      | remote\_id               |       |
      | changed\_at              |       |
      | remote\_deleted\_at      |       |
      | title                    |       |
      | starting\_at             |       |
      | ending\_at               |       |
      | location                 |       |
      | video\_conferencing\_url |       |
      | application\_id          |       |
      | stage\_id                |       |
      | canceled                 |       |
      | remote\_data             |       |
    </Accordion>

    <Accordion title="Offers">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | status              |       |
      | application\_id     |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Notes">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | candidate\_id       |       |
      | application\_id     |       |
      | author\_id          |       |
      | content\_html       |       |
      | is\_private         |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        Lever exposes hiring team data from the posting and requisition

        * **hiringManager** (shown as "Hiring Manager" in the UI) on the posting or requisition maps to unified type `HIRING_MANAGER`
        * **owner** (shown as "Posting Owner" in the UI) on the posting maps to unified type `HIRING_MANAGER`
        * Each user id in **followers** (shown as "Followers" in the UI) has no unified type.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="User roles">
      <Note>
        Lever assigns an **accessRole** to each user

        * **super\_admin** maps to unified type `ADMIN`
        * **admin** maps to unified type `ADMIN`
        * **interviewer** maps to unified type `INTERVIEWER`
        * **team\_member** and **limited\_team\_member** have no unified type
        * Any other **accessRole** value has no unified type
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | user\_id            |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Interviewing team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | interview\_id       |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                                           | Notes |
      | ----------------------------------------------------- | ----- |
      | candidate.first\_name                                 |       |
      | candidate.last\_name                                  |       |
      | candidate.email\_address                              |       |
      | candidate.additional\_email\_addresses.email\_address |       |
      | candidate.company                                     |       |
      | candidate.title                                       |       |
      | candidate.phone\_number                               |       |
      | candidate.additional\_phone\_numbers.phone\_number    |       |
      | candidate.location.city                               |       |
      | candidate.location.country                            |       |
      | candidate.social\_links.url                           |       |
      | application.job\_id                                   |       |
      | application.stage\_id                                 |       |
      | screening\_question\_answers.question\_id             |       |
      | screening\_question\_answers.answer                   |       |
      | attachments.name                                      |       |
      | attachments.content\_type                             |       |
      | attachments.data\_url                                 |       |
      | attachments.data                                      |       |
      | attachments.type                                      |       |
      | source.name                                           |       |
      | source.unified\_key                                   |       |
      | source.id                                             |       |
      | sourced\_by.user\_id                                  |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                                           | Notes |
      | ----------------------------------------------------- | ----- |
      | candidate.first\_name                                 |       |
      | candidate.last\_name                                  |       |
      | candidate.email\_address                              |       |
      | candidate.additional\_email\_addresses.email\_address |       |
      | candidate.company                                     |       |
      | candidate.title                                       |       |
      | candidate.phone\_number                               |       |
      | candidate.additional\_phone\_numbers.phone\_number    |       |
      | candidate.location.city                               |       |
      | candidate.location.country                            |       |
      | candidate.social\_links.url                           |       |
      | application.job\_id                                   |       |
      | application.stage\_id                                 |       |
      | screening\_question\_answers.question\_id             |       |
      | screening\_question\_answers.answer                   |       |
      | attachments.name                                      |       |
      | attachments.content\_type                             |       |
      | attachments.data\_url                                 |       |
      | attachments.data                                      |       |
      | attachments.type                                      |       |
      | source.name                                           |       |
      | source.unified\_key                                   |       |
      | source.id                                             |       |
      | sourced\_by.user\_id                                  |       |
    </Accordion>

    <Accordion title="Add tag to candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Remove tag from candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Reject application">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | application\_id       |       |
      | rejection\_reason\_id |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
    </Accordion>

    <Accordion title="Add result link to candidate">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | candidate\_id                       |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                                | Notes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | OAuth                                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    | API Passthrough                        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    | Webhook Subscriptions                  | While webhooks can be created automatically by Kombo, the user will still have to enable webhooks once in their Lever dashboard. Detailed coverage unknown, please reach out to support: job published, job unpublished, candidate created, application stage changed, tag assigned, screening questions updated, interview scheduled, interview updated applicationCreated: triggered when unknown candidateDeleted: triggered when a candidate was deleted candidateArchiveChange: triggered when unknown candidateHired: triggered when unknown candidateStageChange: triggered when unknown |
    | Automatic Setup                        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    | Delta Syncs                            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    | Custom Field Explorer                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    | Jobs                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    | Source Writing                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    | Sync Only Created Applications         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    | Connection Guide                       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    | Prerequisites                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    | Create Candidate Full Attachment Retry |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    | Candidate Cutoff Filtering             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    | Roles                                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    | System roles (e.g. Admin)              | Lever assigns an **accessRole** to each user                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |

    * **super\_admin** maps to unified type `ADMIN`
    * **admin** maps to unified type `ADMIN`
    * **interviewer** maps to unified type `INTERVIEWER`
    * **team\_member** and **limited\_team\_member** have no unified type
    * Any other **accessRole** value has no unified type |
      \|   Job roles (e.g. Hiring Manager) | Lever exposes hiring team data from the posting and requisition
    * **hiringManager** (shown as "Hiring Manager" in the UI) on the posting or requisition maps to unified type `HIRING_MANAGER`
    * **owner** (shown as "Posting Owner" in the UI) on the posting maps to unified type `HIRING_MANAGER`
    * Each user id in **followers** (shown as "Followers" in the UI) has no unified type. |
      \| EEO Questions | We support EEO questions However diversity surveys are not supported yet |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Lever

For **Lever**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Lever Assessment" icon="https://storage.googleapis.com/kombo-assets/integrations/lever/icon.svg" href="/assessment/connectors/lever">
    Lever for the Assessment category
  </Card>
</CardGroup>


# Logic Melon ATS Integration
Source: https://docs.kombo.dev/ats/connectors/logicmelon

Logic Melon connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Logic Melon ATS integration allows you to sync ATS data between Logic Melon and your application through Kombo's unified API. The tool slug for this connector is `logicmelon`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/46232530054161-Logic-Melon-How-do-I-link-my-account">
    Step-by-step instructions to connect your Logic Melon account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      <Note>
        Jobs are read from the Logic Melon web advert feed, so synced jobs are marked as `PUBLIC`. Logic Melon only allows fetching jobs and applications for a given time span. You can configure this in the sync settings; otherwise Kombo defaults to the last 365 days.
      </Note>

      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | confidential         |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | category             |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      <Note>
        Logic Melon does not provide a dedicated application-stage endpoint. By default, Kombo syncs the common progress IDs listed in the ApplicationProgress docs ('[https://api.logicmelon.com/SOAP/Multiposter.asmx?op=ApplicationProgress\&#x27](https://api.logicmelon.com/SOAP/Multiposter.asmx?op=ApplicationProgress\&#x27);). Those IDs can differ by tenant, so this can be disabled to infer stages only from synced applications instead.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Logic Melon accepts one document on application creation. Kombo uploads the first attachment in the request body, preferring type "CV". Applications are created with the default Logic Melon feed id. Logic Melon returns success when applying to archived adverts and when submitting the same applicant again, so Kombo does not fail closed-job or duplicate-application submissions for this integration.
      </Note>

      | Input Field                                        | Notes |
      | -------------------------------------------------- | ----- |
      | candidate.first\_name                              |       |
      | candidate.last\_name                               |       |
      | candidate.email\_address                           |       |
      | candidate.phone\_number                            |       |
      | candidate.additional\_phone\_numbers.phone\_number |       |
      | application.job\_id                                |       |
      | attachments.name                                   |       |
      | attachments.content\_type                          |       |
      | attachments.data\_url                              |       |
      | attachments.data                                   |       |
      | attachments.type                                   |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Logic Melon accepts one document on application creation. Kombo uploads the first attachment in the request body, preferring type "CV". Applications are created with the default Logic Melon feed id. Logic Melon returns success when applying to archived adverts and when submitting the same applicant again, so Kombo does not fail closed-job or duplicate-application submissions for this integration.
      </Note>

      | Input Field                                        | Notes |
      | -------------------------------------------------- | ----- |
      | candidate.first\_name                              |       |
      | candidate.last\_name                               |       |
      | candidate.email\_address                           |       |
      | candidate.phone\_number                            |       |
      | candidate.additional\_phone\_numbers.phone\_number |       |
      | application.job\_id                                |       |
      | attachments.name                                   |       |
      | attachments.content\_type                          |       |
      | attachments.data\_url                              |       |
      | attachments.data                                   |       |
      | attachments.type                                   |       |
    </Accordion>

    <Accordion title="Move application to stage">
      <Note>
        Logic Melon moves applications with the SOAP `ApplicationProgress` action. The stage IDs Kombo syncs by default come from the common docs list and can differ by tenant, so custom tenant stage IDs may need the common-stage sync setting turned off.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      <Note>
        Logic Melon exposes application attachments here through the application email payload as `EmailFirstAttachment`, documented as the probable most appropriate attachment, so Kombo returns at most one application attachment per application. Logic Melon does not expose attachment type metadata for this endpoint, so returned application attachments are typed as `OTHER`.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Delta Syncs                    |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
    | Candidate Cutoff Filtering     |       |
  </Tab>
</Tabs>


# Loxo ATS Integration
Source: https://docs.kombo.dev/ats/connectors/loxo

Loxo connector for Kombo's ATS API

The Loxo ATS integration allows you to sync ATS data between Loxo and your application through Kombo's unified API. The tool slug for this connector is `loxo`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/43013416076561-Loxo-ATS-How-do-I-link-my-account">
    Step-by-step instructions to connect your Loxo account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | description          |       |
      | confidential         |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | category             |       |
      | post\_url            |       |
      | remote\_work\_status |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Phone number is required by the Loxo API.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Phone number is required by the Loxo API.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        CV attachments are uploaded as resumes. Other attachment types are uploaded as documents. This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      <Note>
        Applications can only be moved forward in the pipeline
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      <Note>
        CV attachments are uploaded as resumes. Other attachment types are uploaded as documents.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Delta Syncs                    |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
  </Tab>
</Tabs>


# Manatal ATS Integration
Source: https://docs.kombo.dev/ats/connectors/manatal

Manatal connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Manatal ATS integration allows you to sync ATS data between Manatal and your application through Kombo's unified API. The tool slug for this connector is `manatal`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/37896101709969-Manatal-How-do-I-link-my-account">
    Step-by-step instructions to connect your Manatal account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | post\_url            |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes                                                                                                                                                     |
      | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
      | id                  |                                                                                                                                                           |
      | remote\_id          |                                                                                                                                                           |
      | changed\_at         |                                                                                                                                                           |
      | remote\_deleted\_at |                                                                                                                                                           |
      | first\_name         |                                                                                                                                                           |
      | last\_name          |                                                                                                                                                           |
      | company             |                                                                                                                                                           |
      | title               |                                                                                                                                                           |
      | source              |                                                                                                                                                           |
      | phone\_numbers      |                                                                                                                                                           |
      | email\_addresses    |                                                                                                                                                           |
      | social\_media       | Fetching social media data requires a separate API call per candidate. For large datasets (100k+ candidates), this can significantly increase sync times. |
      | location            |                                                                                                                                                           |
      | custom\_fields      |                                                                                                                                                           |
      | integration\_fields |                                                                                                                                                           |
      | remote\_created\_at |                                                                                                                                                           |
      | remote\_updated\_at |                                                                                                                                                           |
      | remote\_data        |                                                                                                                                                           |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | rejected\_at        |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.zip\_code              |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.zip\_code              |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Reject application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
    </Accordion>

    <Accordion title="Add result link to candidate">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | candidate\_id                       |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Delta Syncs                    |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
  </Tab>
</Tabs>


# Mercury ATS Integration
Source: https://docs.kombo.dev/ats/connectors/mercury

Mercury connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Mercury ATS integration allows you to sync ATS data between Mercury and your application through Kombo's unified API. The tool slug for this connector is `mercury`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/45614218309137-Mercury-ATS-How-do-I-link-my-account">
    Step-by-step instructions to connect your Mercury account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | job\_code           |       |
      | description         |       |
      | weekly\_hours       |       |
      | employment\_type    |       |
      | status              |       |
      | department          |       |
      | salary\_amount      |       |
      | salary\_currency    |       |
      | salary\_period      |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | opened\_at          |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | contact\_id         |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes                                                                                               |
      | ------------------- | --------------------------------------------------------------------------------------------------- |
      | id                  |                                                                                                     |
      | remote\_id          |                                                                                                     |
      | changed\_at         |                                                                                                     |
      | remote\_deleted\_at |                                                                                                     |
      | outcome             | Mercury shortlists expose statusReason/subStatus strings, not a HIRED/DECLINED/PENDING outcome.     |
      | current\_stage\_id  | Mercury shortlists expose statusReason/subStatus strings that are not yet mapped to unified stages. |
      | job\_id             |                                                                                                     |
      | candidate\_id       |                                                                                                     |
      | custom\_fields      |                                                                                                     |
      | integration\_fields |                                                                                                     |
      | remote\_created\_at |                                                                                                     |
      | remote\_updated\_at |                                                                                                     |
      | remote\_data        |                                                                                                     |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        Mercury exposes a single hiring manager and a single consultant (recruiter) per vacancy.

        * **hiringManager** maps to unified type `HIRING_MANAGER`
        * **consultant** maps to unified type `RECRUITER`
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Does not create a Mercury applicant. Creates a contact and a shortlist record linking the contact to the vacancy.
      </Note>

      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.company                     |       |
      | candidate.title                       |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.location.country            |       |
      | candidate.location.state              |       |
      | candidate.location.street\_1          |       |
      | candidate.location.zip\_code          |       |
      | candidate.gender                      |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.period |       |
      | candidate.salary\_expectations.amount |       |
      | candidate.social\_links.url           |       |
      | application.job\_id                   |       |
      | attachments.name                      |       |
      | attachments.content\_type             |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | attachments.type                      |       |
      | source.name                           |       |
      | sourced\_by.user\_id                  |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Does not create a Mercury applicant. Creates a contact and a shortlist record linking the contact to the vacancy.
      </Note>

      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.company                     |       |
      | candidate.title                       |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.location.country            |       |
      | candidate.location.state              |       |
      | candidate.location.street\_1          |       |
      | candidate.location.zip\_code          |       |
      | candidate.gender                      |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.period |       |
      | candidate.salary\_expectations.amount |       |
      | candidate.social\_links.url           |       |
      | application.job\_id                   |       |
      | attachments.name                      |       |
      | attachments.content\_type             |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | attachments.type                      |       |
      | source.name                           |       |
      | sourced\_by.user\_id                  |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        Mercury stores uploaded files on the candidate contact, not on a specific application. CV attachments go to the CV folder; non-CV attachments go to the general documents folder. CV attachments are stored in the CV folder of the contact. Non-CV attachments are stored in a general documents folder.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      <Note>
        Currently only supports moving Mercury applicants to stages, and not Mercury shortlists, due to a temporary Mercury API limitation.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Reject application">
      <Note>
        Mercury does not have structured rejection reasons. Rejecting sets the applicant status to "Unsuitable" (status 2). Rejection notes are not supported by the Mercury reject endpoint.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Add result link to application">
      <Note>
        Mercury does not have a native result link feature. Result links are stored as annotations on the candidate contact.
      </Note>

      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      <Note>
        Mercury stores notes on the candidate contact, not on a specific application.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      <Note>
        CV attachments are stored in the CV folder of the contact. Non-CV attachments are stored in a general documents folder.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Add result link to candidate">
      <Note>
        Mercury does not have a native result link feature. Result links are stored as annotations on the candidate contact.
      </Note>

      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | candidate\_id                       |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                                | Notes                                                                                    |
    | -------------------------------------- | ---------------------------------------------------------------------------------------- |
    | API Passthrough                        |                                                                                          |
    | Delta Syncs                            |                                                                                          |
    | Custom Field Explorer                  |                                                                                          |
    | Jobs                                   |                                                                                          |
    | Candidates                             |                                                                                          |
    | Source Writing                         |                                                                                          |
    | Sync Only Created Applications         |                                                                                          |
    | Connection Guide                       |                                                                                          |
    | Create Candidate Full Attachment Retry |                                                                                          |
    | Candidate Cutoff Filtering             |                                                                                          |
    | Roles                                  |                                                                                          |
    | Job roles (e.g. Hiring Manager)        | Mercury exposes a single hiring manager and a single consultant (recruiter) per vacancy. |

    * **hiringManager** maps to unified type `HIRING_MANAGER`
    * **consultant** maps to unified type `RECRUITER` |
  </Tab>
</Tabs>


# MHM HR ATS Integration
Source: https://docs.kombo.dev/ats/connectors/mhmhr

MHM HR connector for Kombo's ATS API

The MHM HR ATS integration allows you to sync ATS data between MHM HR and your application through Kombo's unified API. The tool slug for this connector is `mhmhr`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/42595732234385-MHM-HR-How-do-I-link-my-account">
    Step-by-step instructions to connect your MHM HR account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | confidential         |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | category             |       |
      | department           |       |
      | post\_url            |       |
      | experience\_level    |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_data         |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Created candidates can not be read back. Applicants in MHM HR need to be explicitly exported before they can be read from the API.
      </Note>

      | Input Field                  | Notes |
      | ---------------------------- | ----- |
      | candidate.first\_name        |       |
      | candidate.last\_name         |       |
      | candidate.email\_address     |       |
      | candidate.title              |       |
      | candidate.phone\_number      |       |
      | candidate.location.city      |       |
      | candidate.location.country   |       |
      | candidate.location.zip\_code |       |
      | candidate.gender             |       |
      | application.job\_id          |       |
      | attachments.name             |       |
      | attachments.content\_type    |       |
      | attachments.data\_url        |       |
      | attachments.data             |       |
      | attachments.type             |       |
      | source.name                  |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Created candidates can not be read back. Applicants in MHM HR need to be explicitly exported before they can be read from the API.
      </Note>

      | Input Field                  | Notes |
      | ---------------------------- | ----- |
      | candidate.first\_name        |       |
      | candidate.last\_name         |       |
      | candidate.email\_address     |       |
      | candidate.title              |       |
      | candidate.phone\_number      |       |
      | candidate.location.city      |       |
      | candidate.location.country   |       |
      | candidate.location.zip\_code |       |
      | candidate.gender             |       |
      | application.job\_id          |       |
      | attachments.name             |       |
      | attachments.content\_type    |       |
      | attachments.data\_url        |       |
      | attachments.data             |       |
      | attachments.type             |       |
      | source.name                  |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | Custom Field Explorer |       |
    | Jobs                  |       |
    | Source Writing        |       |
    | Connection Guide      |       |
  </Tab>
</Tabs>


# Mysolution ATS Integration
Source: https://docs.kombo.dev/ats/connectors/mysolution

Mysolution connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Mysolution ATS integration allows you to sync ATS data between Mysolution and your application through Kombo's unified API. The tool slug for this connector is `mysolution`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/17322501611153-Mysolution-How-do-I-link-my-account-">
    Step-by-step instructions to connect your Mysolution account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | description          |       |
      | weekly\_hours        |       |
      | status               |       |
      | department           |       |
      | post\_url            |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field               | Notes |
      | ------------------------- | ----- |
      | candidate.first\_name     |       |
      | candidate.last\_name      |       |
      | candidate.email\_address  |       |
      | candidate.phone\_number   |       |
      | application.job\_id       |       |
      | attachments.name          |       |
      | attachments.content\_type |       |
      | attachments.data\_url     |       |
      | attachments.data          |       |
      | attachments.type          |       |
      | source.name               |       |
      | source.unified\_key       |       |
      | source.id                 |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field               | Notes |
      | ------------------------- | ----- |
      | candidate.first\_name     |       |
      | candidate.last\_name      |       |
      | candidate.email\_address  |       |
      | candidate.phone\_number   |       |
      | application.job\_id       |       |
      | attachments.name          |       |
      | attachments.content\_type |       |
      | attachments.data\_url     |       |
      | attachments.data          |       |
      | attachments.type          |       |
      | source.name               |       |
      | source.unified\_key       |       |
      | source.id                 |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | API Passthrough  |       |
    | Source Writing   |       |
    | Connection Guide |       |
    | Prerequisites    |       |
  </Tab>
</Tabs>


# Odoo ATS Integration
Source: https://docs.kombo.dev/ats/connectors/odoo

Odoo connector for Kombo's ATS API

The Odoo ATS integration allows you to sync ATS data between Odoo and your application through Kombo's unified API. The tool slug for this connector is `odoo`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/43291373365521-Odoo-How-do-I-link-my-account">
    Step-by-step instructions to connect your Odoo account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field               | Notes                                                                                  |
      | ------------------- | -------------------------------------------------------------------------------------- |
      | id                  |                                                                                        |
      | remote\_id          |                                                                                        |
      | changed\_at         |                                                                                        |
      | remote\_deleted\_at |                                                                                        |
      | name                |                                                                                        |
      | description         |                                                                                        |
      | employment\_type    |                                                                                        |
      | status              | Odoo only exposes open jobs on their API, so all returned jobs will be marked as OPEN. |
      | visibility          | Odoo does not expose visibility on their API, so all jobs will be marked as PUBLIC.    |
      | category            |                                                                                        |
      | department          |                                                                                        |
      | location            |                                                                                        |
      | custom\_fields      |                                                                                        |
      | integration\_fields |                                                                                        |
      | remote\_url         |                                                                                        |
      | remote\_created\_at |                                                                                        |
      | remote\_updated\_at |                                                                                        |
      | remote\_data        |                                                                                        |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                        | Notes |
      | ---------------------------- | ----- |
      | id                           |       |
      | remote\_id                   |       |
      | changed\_at                  |       |
      | remote\_deleted\_at          |       |
      | outcome                      |       |
      | rejection\_reason\_name      |       |
      | rejected\_at                 |       |
      | current\_stage\_id           |       |
      | job\_id                      |       |
      | candidate\_id                |       |
      | screening\_question\_answers |       |
      | custom\_fields               |       |
      | integration\_fields          |       |
      | remote\_url                  |       |
      | remote\_created\_at          |       |
      | remote\_updated\_at          |       |
      | remote\_data                 |       |
    </Accordion>

    <Accordion title="Screening questions">
      <Note>
        Odoo "matrix" questions have no unified equivalent and are synced with format type `UNKNOWN`. Please get back to us if you need help with this.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Only social links of type "linkedin" are supported. All other social links will be ignored.
      </Note>

      | Input Field                                           | Notes |
      | ----------------------------------------------------- | ----- |
      | candidate.first\_name                                 |       |
      | candidate.last\_name                                  |       |
      | candidate.email\_address                              |       |
      | candidate.additional\_email\_addresses.email\_address |       |
      | candidate.phone\_number                               |       |
      | candidate.additional\_phone\_numbers.phone\_number    |       |
      | candidate.location.city                               |       |
      | candidate.location.country                            |       |
      | candidate.location.zip\_code                          |       |
      | candidate.availability\_date                          |       |
      | candidate.salary\_expectations.period                 |       |
      | candidate.salary\_expectations.amount                 |       |
      | candidate.social\_links.url                           |       |
      | application.job\_id                                   |       |
      | application.stage\_id                                 |       |
      | attachments.name                                      |       |
      | attachments.content\_type                             |       |
      | attachments.data\_url                                 |       |
      | attachments.data                                      |       |
      | attachments.type                                      |       |
      | source.name                                           |       |
      | source.unified\_key                                   |       |
      | source.id                                             |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Only social links of type "linkedin" are supported. All other social links will be ignored.
      </Note>

      | Input Field                                           | Notes |
      | ----------------------------------------------------- | ----- |
      | candidate.first\_name                                 |       |
      | candidate.last\_name                                  |       |
      | candidate.email\_address                              |       |
      | candidate.additional\_email\_addresses.email\_address |       |
      | candidate.phone\_number                               |       |
      | candidate.additional\_phone\_numbers.phone\_number    |       |
      | candidate.location.city                               |       |
      | candidate.location.country                            |       |
      | candidate.location.zip\_code                          |       |
      | candidate.availability\_date                          |       |
      | candidate.salary\_expectations.period                 |       |
      | candidate.salary\_expectations.amount                 |       |
      | candidate.social\_links.url                           |       |
      | application.job\_id                                   |       |
      | application.stage\_id                                 |       |
      | attachments.name                                      |       |
      | attachments.content\_type                             |       |
      | attachments.data\_url                                 |       |
      | attachments.data                                      |       |
      | attachments.type                                      |       |
      | source.name                                           |       |
      | source.unified\_key                                   |       |
      | source.id                                             |       |
    </Accordion>

    <Accordion title="Add tag to candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Remove tag from candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Reject application">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | application\_id       |       |
      | rejection\_reason\_id |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Delta Syncs                    |       |
    | Custom Field Explorer          |       |
    | Jobs                           |       |
    | Candidates                     |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
  </Tab>
</Tabs>


# Onlyfy ATS Integration
Source: https://docs.kombo.dev/ats/connectors/onlyfy

Onlyfy connector for Kombo's ATS API

The Onlyfy ATS integration allows you to sync ATS data between Onlyfy and your application through Kombo's unified API. The tool slug for this connector is `onlyfy`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/21071113161361-Onlyfy-How-do-I-link-my-account-">
    Step-by-step instructions to connect your Onlyfy account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | department           |       |
      | post\_url            |       |
      | experience\_level    |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | contact\_id          |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | confidential        |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>

    <Accordion title="Add tag to candidate">
      <Note>
        We can't create tags, but only assign existing ones. Creating new tags is not supported by the Onlyfy API.
      </Note>

      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Remove tag from candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | application\_id      |       |
      | attachment.name      |       |
      | attachment.data\_url |       |
      | attachment.data      |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Add result link to application">
      <Note>
        Onlyfy doesn't support adding details to a result link.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | url             |       |
    </Accordion>

    <Accordion title="Get application attachments">
      <Note>
        Onlyfy stores the CV on the candidate, so it is included as a CV attachment on every application of that candidate. All files attached to the application itself ("recruiter files") are returned with type OTHER.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      <Note>
        The CV is returned as a candidate-level attachment (without an application ID). All other files live on the applications of the candidate ("recruiter files") and are returned with type OTHER.
      </Note>

      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      | Input Field          | Notes |
      | -------------------- | ----- |
      | candidate\_id        |       |
      | attachment.name      |       |
      | attachment.data\_url |       |
      | attachment.data      |       |
    </Accordion>

    <Accordion title="Add result link to candidate">
      <Note>
        Onlyfy doesn't support adding details to a result link.
      </Note>

      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | url           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                                | Notes |
    | -------------------------------------- | ----- |
    | API Passthrough                        |       |
    | Scope Testing                          |       |
    | Custom Field Explorer                  |       |
    | Jobs                                   |       |
    | Source Writing                         |       |
    | Sync Only Created Applications         |       |
    | Connection Guide                       |       |
    | Create Candidate Full Attachment Retry |       |
  </Tab>
</Tabs>


# Oracle Recruiting Cloud ATS Integration
Source: https://docs.kombo.dev/ats/connectors/oraclerecruiting

Oracle Recruiting Cloud connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Oracle Recruiting Cloud ATS integration allows you to sync ATS data between Oracle Recruiting Cloud and your application through Kombo's unified API. The tool slug for this connector is `oraclerecruiting`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/29831109690897-Oracle-Recruiting-Cloud-How-do-I-link-my-account-configuration-package">
    Step-by-step instructions to connect your Oracle Recruiting Cloud account to Kombo.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22612215766289-Oracle-Recruiting-Cloud-How-to-view-a-candidates-source">
    How to view and manage candidate sources in Oracle Recruiting Cloud.
  </Card>

  <Card title="Alternative connection guide (manual setup)" icon="book" href="https://help.kombo.dev/hc/en-us/articles/18703106632721">
    Additional documentation and guides for Oracle Recruiting Cloud.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | weekly\_hours        |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | category             |       |
      | department           |       |
      | post\_url            |       |
      | experience\_level    |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Offers">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | status                  |       |
      | employment\_start\_date |       |
      | application\_id         |       |
      | custom\_fields          |       |
      | integration\_fields     |       |
      | remote\_created\_at     |       |
      | remote\_updated\_at     |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        Oracle job requisition includes **HiringManagerId**, **RecruiterId**, and **collaborators**

        * **HiringManagerId** maps to unified type `HIRING_MANAGER`
        * **RecruiterId** maps to unified type `RECRUITER`
        * **collaborators** entries with **CollaboratorType** **ORA\_HIRING\_TEAM\_COLLABORATOR** map to unified type `RECRUITER`
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="User roles">
      <Note>
        OracleRecruiting User accounts can have a list of roles

        * **ORA\_IRC\_RECRUITER\_JOB** maps to unified type `RECRUITER`
        * **ORA\_IRC\_RECRUITING\_MANAGER\_JOB** maps to unified type `RECRUITER`
        * Role codes containing **\_HIRING\_MANAGER\_ABSTRACT** map to unified type `HIRING_MANAGER`
        * Role codes defined in integration settings that appear on the user have no unified type
        * All other role codes are omitted
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | user\_id            |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Creating applications in Oracle unfortunately can take up to a 2 or 3 minutes.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.availability\_date              |       |
      | candidate.salary\_expectations.period     |       |
      | candidate.salary\_expectations.amount     |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Creating applications in Oracle unfortunately can take up to a 2 or 3 minutes.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.availability\_date              |       |
      | candidate.salary\_expectations.period     |       |
      | candidate.salary\_expectations.amount     |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        This action can take up to 8 minutes to complete.
      </Note>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | application\_id      |       |
      | attachment.name      |       |
      | attachment.data\_url |       |
      | attachment.data      |       |
      | attachment.type      |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Reject application">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | application\_id       |       |
      | rejection\_reason\_id |       |
    </Accordion>

    <Accordion title="Add result link to application">
      <Note>
        This action can take up to 8 minutes to complete.
      </Note>

      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      | Input Field          | Notes |
      | -------------------- | ----- |
      | candidate\_id        |       |
      | attachment.name      |       |
      | attachment.data\_url |       |
      | attachment.data      |       |
      | attachment.type      |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes                                                   |
    | ------------------------------ | ------------------------------------------------------- |
    | API Passthrough                |                                                         |
    | Scope Testing                  |                                                         |
    | Delta Syncs                    |                                                         |
    | Custom Field Explorer          |                                                         |
    | Candidates                     |                                                         |
    | Applications                   |                                                         |
    | Source Writing                 |                                                         |
    | Sync Only Created Applications |                                                         |
    | Connection Guide               |                                                         |
    | Prerequisites                  |                                                         |
    | Create credentials             |                                                         |
    | Roles                          |                                                         |
    | System roles (e.g. Admin)      | OracleRecruiting User accounts can have a list of roles |

    * **ORA\_IRC\_RECRUITER\_JOB** maps to unified type `RECRUITER`
    * **ORA\_IRC\_RECRUITING\_MANAGER\_JOB** maps to unified type `RECRUITER`
    * Role codes containing **\_HIRING\_MANAGER\_ABSTRACT** map to unified type `HIRING_MANAGER`
    * Role codes defined in integration settings that appear on the user have no unified type
    * All other role codes are omitted |
      \|   Job roles (e.g. Hiring Manager) | Oracle job requisition includes **HiringManagerId**, **RecruiterId**, and **collaborators**
    * **HiringManagerId** maps to unified type `HIRING_MANAGER`
    * **RecruiterId** maps to unified type `RECRUITER`
    * **collaborators** entries with **CollaboratorType** **ORA\_HIRING\_TEAM\_COLLABORATOR** map to unified type `RECRUITER` |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Oracle Recruiting Cloud

For **Oracle Recruiting Cloud**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Oracle Recruiting Cloud Assessment" icon="https://storage.googleapis.com/kombo-assets/integrations/oraclerecruiting/icon.svg" href="/assessment/connectors/oraclerecruiting">
    Oracle Recruiting Cloud for the Assessment category
  </Card>
</CardGroup>


# OTYS ATS Integration
Source: https://docs.kombo.dev/ats/connectors/otys

OTYS connector for Kombo's ATS API

The OTYS ATS integration allows you to sync ATS data between OTYS and your application through Kombo's unified API. The tool slug for this connector is `otys`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/18774239421969">
    Step-by-step instructions to connect your OTYS account to Kombo.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22564492855185-Otys-How-to-view-a-candidates-source">
    How to view and manage candidate sources in OTYS.
  </Card>

  <Card title="How to enable writing GDPR consent via API" icon="book" href="https://help.kombo.dev/hc/en-us/articles/29384162676753">
    Additional documentation and guides for OTYS.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | job\_code           |       |
      | description         |       |
      | status              |       |
      | visibility          |       |
      | category            |       |
      | post\_url           |       |
      | salary\_amount      |       |
      | salary\_currency    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | opened\_at          |       |
      | closed\_at          |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | contact\_id         |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                  | Notes |
      | ---------------------------- | ----- |
      | candidate.first\_name        |       |
      | candidate.last\_name         |       |
      | candidate.email\_address     |       |
      | candidate.company            |       |
      | candidate.phone\_number      |       |
      | candidate.location.city      |       |
      | candidate.location.country   |       |
      | candidate.gender             |       |
      | candidate.availability\_date |       |
      | application.job\_id          |       |
      | application.stage\_id        |       |
      | attachments.name             |       |
      | attachments.content\_type    |       |
      | attachments.data\_url        |       |
      | attachments.data             |       |
      | attachments.type             |       |
      | source.name                  |       |
      | source.unified\_key          |       |
      | source.id                    |       |
      | gdpr\_consent.expires\_at    |       |
      | gdpr\_consent.given          |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                  | Notes |
      | ---------------------------- | ----- |
      | candidate.first\_name        |       |
      | candidate.last\_name         |       |
      | candidate.email\_address     |       |
      | candidate.company            |       |
      | candidate.phone\_number      |       |
      | candidate.location.city      |       |
      | candidate.location.country   |       |
      | candidate.gender             |       |
      | candidate.availability\_date |       |
      | application.job\_id          |       |
      | application.stage\_id        |       |
      | attachments.name             |       |
      | attachments.content\_type    |       |
      | attachments.data\_url        |       |
      | attachments.data             |       |
      | attachments.type             |       |
      | source.name                  |       |
      | source.unified\_key          |       |
      | source.id                    |       |
      | gdpr\_consent.expires\_at    |       |
      | gdpr\_consent.given          |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Add result link to candidate">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | candidate\_id                       |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                                | Notes |
    | -------------------------------------- | ----- |
    | API Passthrough                        |       |
    | Source Writing                         |       |
    | Sync Only Created Applications         |       |
    | Connection Guide                       |       |
    | Create credentials                     |       |
    | Create Candidate Full Attachment Retry |       |
  </Tab>
</Tabs>


# PageUp People ATS Integration
Source: https://docs.kombo.dev/ats/connectors/pageup

PageUp People connector for Kombo's ATS API

<Note>This connector is in closed beta. Please contact us to get access.</Note>

The PageUp People ATS integration allows you to sync ATS data between PageUp People and your application through Kombo's unified API. The tool slug for this connector is `pageup`.

## Supported Features & Coverage

<Tabs>
  <Tab title="Features">
    | Feature         | Notes |
    | --------------- | ----- |
    | API Passthrough |       |
    | Scope Testing   |       |
    | Per Model Tests |       |
    | Delta Syncs     |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** PageUp People

For **PageUp People**, we also offer the following other connector variants:

<CardGroup>
  <Card title="PageUp People Assessment" icon="https://storage.googleapis.com/kombo-assets/integrations/pageup/icon.svg" href="/assessment/connectors/pageup">
    PageUp People for the Assessment category
  </Card>
</CardGroup>


# Paradox ATS Integration
Source: https://docs.kombo.dev/ats/connectors/paradox

Paradox connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Paradox ATS integration allows you to sync ATS data between Paradox and your application through Kombo's unified API. The tool slug for this connector is `paradox`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/40931059163921-Paradox-How-do-I-link-my-account">
    Step-by-step instructions to connect your Paradox account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      <Note>
        Due to a limitation in the Paradox XML feed, we cannot show you the details of a job that an applicant has applied to, only its id. If you change the Candidate Journey for a job in Paradox, existing applications must be moved to a stage of the new journey before they will be shown in Kombo.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | description         |       |
      | status              |       |
      | experience\_level   |       |
      | salary\_amount      |       |
      | location            |       |
      | custom\_fields      |       |
      | opened\_at          |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Job postings">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description\_html   |       |
      | status              |       |
      | visibility          |       |
      | url                 |       |
      | job\_id             |       |
      | remote\_data        |       |
      | remote\_created\_at |       |
    </Accordion>

    <Accordion title="Candidates">
      <Note>
        Candidates and applications are the same entity in the Paradox API
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      <Note>
        If a candidate journey / stage / status is renamed in Paradox, it will be treated as a new application stage.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      <Note>
        Paradox will return the stage of a candidate, but your system should know if this stage is interview / hiring / rejection
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | remote\_url         |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        This integration only supports CV attachments.
      </Note>

      | Input Field                | Notes |
      | -------------------------- | ----- |
      | candidate.first\_name      |       |
      | candidate.last\_name       |       |
      | candidate.email\_address   |       |
      | candidate.title            |       |
      | candidate.phone\_number    |       |
      | candidate.location.city    |       |
      | candidate.location.country |       |
      | application.job\_id        |       |
      | application.stage\_id      |       |
      | attachments.data\_url      |       |
      | attachments.data           |       |
      | attachments.type           |       |
      | source.name                |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        This integration only supports CV attachments.
      </Note>

      | Input Field                | Notes |
      | -------------------------- | ----- |
      | candidate.first\_name      |       |
      | candidate.last\_name       |       |
      | candidate.email\_address   |       |
      | candidate.title            |       |
      | candidate.phone\_number    |       |
      | candidate.location.city    |       |
      | candidate.location.country |       |
      | application.job\_id        |       |
      | application.stage\_id      |       |
      | attachments.data\_url      |       |
      | attachments.data           |       |
      | attachments.type           |       |
      | source.name                |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        This integration only supports CV attachments. Uploading a new CV will overwrite the existing one.
      </Note>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | application\_id      |       |
      | attachment.data\_url |       |
      | attachment.data      |       |
      | attachment.type      |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | API Passthrough       |       |
    | Delta Syncs           |       |
    | Custom Field Explorer |       |
    | Jobs                  |       |
    | Candidates            |       |
    | Source Writing        |       |
    | Connection Guide      |       |
  </Tab>
</Tabs>


# Paycor ATS Integration
Source: https://docs.kombo.dev/ats/connectors/paycor

Paycor connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Paycor ATS integration allows you to sync ATS data between Paycor and your application through Kombo's unified API. The tool slug for this connector is `paycor`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/39176831015953-Paycor-ATS-How-do-I-link-my-account">
    Step-by-step instructions to connect your Paycor account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | confidential         |       |
      | status               |       |
      | visibility           |       |
      | category             |       |
      | department           |       |
      | remote\_work\_status |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        Each Paycor job includes **hiringManagers**, **recruiters**, and **executives** lists

        * **hiringManagers** entries map to unified type `HIRING_MANAGER`
        * **recruiters** entries map to unified type `RECRUITER`
        * **executives** entries have no unified type.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                  | Notes                                                                                                                                                                      |
      | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
      | candidate.first\_name        |                                                                                                                                                                            |
      | candidate.last\_name         |                                                                                                                                                                            |
      | candidate.email\_address     |                                                                                                                                                                            |
      | candidate.phone\_number      |                                                                                                                                                                            |
      | candidate.location.city      |                                                                                                                                                                            |
      | candidate.location.country   |                                                                                                                                                                            |
      | candidate.location.state     |                                                                                                                                                                            |
      | candidate.location.zip\_code |                                                                                                                                                                            |
      | application.job\_id          |                                                                                                                                                                            |
      | source.name                  | The source is required by the Paycor API. If not provided, and automatic source writing is not enabled in the Kombo dashboard, the name of your Kombo tenant will be used. |
      | source.unified\_key          |                                                                                                                                                                            |
      | source.id                    |                                                                                                                                                                            |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                  | Notes                                                                                                                                                                      |
      | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
      | candidate.first\_name        |                                                                                                                                                                            |
      | candidate.last\_name         |                                                                                                                                                                            |
      | candidate.email\_address     |                                                                                                                                                                            |
      | candidate.phone\_number      |                                                                                                                                                                            |
      | candidate.location.city      |                                                                                                                                                                            |
      | candidate.location.country   |                                                                                                                                                                            |
      | candidate.location.state     |                                                                                                                                                                            |
      | candidate.location.zip\_code |                                                                                                                                                                            |
      | application.job\_id          |                                                                                                                                                                            |
      | source.name                  | The source is required by the Paycor API. If not provided, and automatic source writing is not enabled in the Kombo dashboard, the name of your Kombo tenant will be used. |
      | source.unified\_key          |                                                                                                                                                                            |
      | source.id                    |                                                                                                                                                                            |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                         | Notes                                                                                 |
    | ------------------------------- | ------------------------------------------------------------------------------------- |
    | OAuth                           |                                                                                       |
    | API Passthrough                 |                                                                                       |
    | Additional Scopes               |                                                                                       |
    | Scope Testing                   |                                                                                       |
    | Per Model Tests                 |                                                                                       |
    | Custom Field Explorer           |                                                                                       |
    | Jobs                            |                                                                                       |
    | Candidates                      |                                                                                       |
    | Applications                    |                                                                                       |
    | Source Writing                  |                                                                                       |
    | Sync Only Created Applications  |                                                                                       |
    | Connection Guide                |                                                                                       |
    | Roles                           |                                                                                       |
    | Job roles (e.g. Hiring Manager) | Each Paycor job includes **hiringManagers**, **recruiters**, and **executives** lists |

    * **hiringManagers** entries map to unified type `HIRING_MANAGER`
    * **recruiters** entries map to unified type `RECRUITER`
    * **executives** entries have no unified type. |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Paycor

For **Paycor**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Paycor HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/paycor/icon.svg" href="/hris/connectors/paycor">
    Paycor for the HRIS category
  </Card>
</CardGroup>


# Paylocity ATS Integration
Source: https://docs.kombo.dev/ats/connectors/paylocity

Paylocity connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Paylocity ATS integration allows you to sync ATS data between Paylocity and your application through Kombo's unified API. The tool slug for this connector is `paylocity`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/27558893117201-Paylocity-ATS-How-do-I-link-my-account">
    Step-by-step instructions to connect your Paylocity account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | confidential         |       |
      | employment\_type     |       |
      | status               |       |
      | department           |       |
      | post\_url            |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | remote\_created\_at  |       |
      | remote\_data         |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | Connection Guide |       |
    | Prerequisites    |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Paylocity

For **Paylocity**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Paylocity HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/paylocity/icon.svg" href="/hris/connectors/paylocity">
    Paylocity for the HRIS category
  </Card>
</CardGroup>


# Perbility Helix ATS Integration
Source: https://docs.kombo.dev/ats/connectors/perbilityhelix

Perbility Helix connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

<Note>This connector requires a partnership with Perbility Helix. Check out our [partnership guide](https://help.kombo.dev/hc/en-us/articles/43095758773521-Perbility-Helix-How-to-get-your-Partner-Credentials) to learn more.</Note>

The Perbility Helix ATS integration allows you to sync ATS data between Perbility Helix and your application through Kombo's unified API. The tool slug for this connector is `perbilityhelix`.

## Guides and Resources

<CardGroup>
  <Card title="Partnership Guide" icon="handshake" href="https://help.kombo.dev/hc/en-us/articles/43095758773521-Perbility-Helix-How-to-get-your-Partner-Credentials">
    Learn how to become a partner with Perbility Helix to enable this integration.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | description         |       |
      | employment\_type    |       |
      | status              |       |
      | visibility          |       |
      | category            |       |
      | post\_url           |       |
      | experience\_level   |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        WebP attachments are skipped because Concludis fails to preprocess them
      </Note>

      | Input Field                               | Notes                                                                                          |
      | ----------------------------------------- | ---------------------------------------------------------------------------------------------- |
      | candidate.first\_name                     |                                                                                                |
      | candidate.last\_name                      |                                                                                                |
      | candidate.email\_address                  |                                                                                                |
      | candidate.company                         |                                                                                                |
      | candidate.title                           |                                                                                                |
      | candidate.phone\_number                   |                                                                                                |
      | candidate.location.city                   |                                                                                                |
      | candidate.location.country                |                                                                                                |
      | candidate.location.street\_1              |                                                                                                |
      | candidate.location.zip\_code              |                                                                                                |
      | candidate.gender                          |                                                                                                |
      | application.job\_id                       |                                                                                                |
      | screening\_question\_answers.question\_id |                                                                                                |
      | screening\_question\_answers.answer       |                                                                                                |
      | attachments.name                          |                                                                                                |
      | attachments.content\_type                 |                                                                                                |
      | attachments.data\_url                     |                                                                                                |
      | attachments.data                          |                                                                                                |
      | attachments.type                          |                                                                                                |
      | source.name                               | Concludis can only be used as a partner and you can set the Source ID in the partner settings. |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        WebP attachments are skipped because Concludis fails to preprocess them
      </Note>

      | Input Field                               | Notes                                                                                          |
      | ----------------------------------------- | ---------------------------------------------------------------------------------------------- |
      | candidate.first\_name                     |                                                                                                |
      | candidate.last\_name                      |                                                                                                |
      | candidate.email\_address                  |                                                                                                |
      | candidate.company                         |                                                                                                |
      | candidate.title                           |                                                                                                |
      | candidate.phone\_number                   |                                                                                                |
      | candidate.location.city                   |                                                                                                |
      | candidate.location.country                |                                                                                                |
      | candidate.location.street\_1              |                                                                                                |
      | candidate.location.zip\_code              |                                                                                                |
      | candidate.gender                          |                                                                                                |
      | application.job\_id                       |                                                                                                |
      | screening\_question\_answers.question\_id |                                                                                                |
      | screening\_question\_answers.answer       |                                                                                                |
      | attachments.name                          |                                                                                                |
      | attachments.content\_type                 |                                                                                                |
      | attachments.data\_url                     |                                                                                                |
      | attachments.data                          |                                                                                                |
      | attachments.type                          |                                                                                                |
      | source.name                               | Concludis can only be used as a partner and you can set the Source ID in the partner settings. |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature        | Notes |
    | -------------- | ----- |
    | Source Writing |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Perbility Helix

For **Perbility Helix**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Perbility Helix HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/perbilityhelix/icon.svg" href="/hris/connectors/perbilityhelix">
    Perbility Helix for the HRIS category
  </Card>
</CardGroup>


# Personio ATS Integration
Source: https://docs.kombo.dev/ats/connectors/personio

Personio connector for Kombo's ATS API

The Personio ATS integration allows you to sync ATS data between Personio and your application through Kombo's unified API. The tool slug for this connector is `personio`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/16968677812881-How-do-I-link-my-Personio-ATS-account-">
    Step-by-step instructions to connect your Personio account to Kombo.
  </Card>

  <Card title="Sandbox Environment" icon="flask" href="https://www.personio.com/free-trial/">
    Access the Personio sandbox environment for testing and development.
  </Card>

  <Card title="Source Setup Guide" icon="settings" href="https://help.kombo.dev/hc/en-us/articles/17079249716753-Personio-How-to-add-a-candidate-source">
    Learn how to set up candidate sources in Personio.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22536111700497-Personio-How-to-view-a-candidates-source">
    How to view and manage candidate sources in Personio.
  </Card>
</CardGroup>

## General Notes

* Personio does not provide a dedicated API endpoint for reading application stages. Stages are inferred from the applications currently in the system, meaning only stages that are assigned to at least one application will be synced.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | description         |       |
      | employment\_type    |       |
      | status              |       |
      | visibility          |       |
      | category            |       |
      | department          |       |
      | post\_url           |       |
      | experience\_level   |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                               | Notes                                                                                              |
      | ----------------------------------------- | -------------------------------------------------------------------------------------------------- |
      | candidate.first\_name                     |                                                                                                    |
      | candidate.last\_name                      |                                                                                                    |
      | candidate.email\_address                  |                                                                                                    |
      | candidate.phone\_number                   |                                                                                                    |
      | candidate.location.city                   |                                                                                                    |
      | candidate.location.country                |                                                                                                    |
      | candidate.gender                          |                                                                                                    |
      | candidate.availability\_date              |                                                                                                    |
      | candidate.salary\_expectations.period     |                                                                                                    |
      | candidate.salary\_expectations.amount     |                                                                                                    |
      | application.job\_id                       |                                                                                                    |
      | application.stage\_id                     | Personio does not allow application stage reading. Only remote or predefined stages are supported. |
      | screening\_question\_answers.question\_id |                                                                                                    |
      | screening\_question\_answers.answer       |                                                                                                    |
      | attachments.name                          |                                                                                                    |
      | attachments.content\_type                 |                                                                                                    |
      | attachments.data\_url                     |                                                                                                    |
      | attachments.data                          |                                                                                                    |
      | attachments.type                          |                                                                                                    |
      | source.name                               |                                                                                                    |
      | source.unified\_key                       |                                                                                                    |
      | source.id                                 |                                                                                                    |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                               | Notes                                                                                              |
      | ----------------------------------------- | -------------------------------------------------------------------------------------------------- |
      | candidate.first\_name                     |                                                                                                    |
      | candidate.last\_name                      |                                                                                                    |
      | candidate.email\_address                  |                                                                                                    |
      | candidate.phone\_number                   |                                                                                                    |
      | candidate.location.city                   |                                                                                                    |
      | candidate.location.country                |                                                                                                    |
      | candidate.gender                          |                                                                                                    |
      | candidate.availability\_date              |                                                                                                    |
      | candidate.salary\_expectations.period     |                                                                                                    |
      | candidate.salary\_expectations.amount     |                                                                                                    |
      | application.job\_id                       |                                                                                                    |
      | application.stage\_id                     | Personio does not allow application stage reading. Only remote or predefined stages are supported. |
      | screening\_question\_answers.question\_id |                                                                                                    |
      | screening\_question\_answers.answer       |                                                                                                    |
      | attachments.name                          |                                                                                                    |
      | attachments.content\_type                 |                                                                                                    |
      | attachments.data\_url                     |                                                                                                    |
      | attachments.data                          |                                                                                                    |
      | attachments.type                          |                                                                                                    |
      | source.name                               |                                                                                                    |
      | source.unified\_key                       |                                                                                                    |
      | source.id                                 |                                                                                                    |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Scope Testing                  |       |
    | Custom Field Explorer          |       |
    | Jobs                           |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
    | Prerequisites                  |       |
    | Create credentials             |       |
    | Candidate source tracking      |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Personio

For **Personio**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Personio HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/personio/icon.svg" href="/hris/connectors/personio">
    Personio for the HRIS category
  </Card>
</CardGroup>


# Perview ATS Integration
Source: https://docs.kombo.dev/ats/connectors/perview

Perview connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Perview ATS integration allows you to sync ATS data between Perview and your application through Kombo's unified API. The tool slug for this connector is `perview`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/33061016986513-Perview-ATS-How-do-I-link-my-account">
    Step-by-step instructions to connect your Perview account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | description          |       |
      | weekly\_hours        |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | category             |       |
      | department           |       |
      | post\_url            |       |
      | remote\_work\_status |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | remote\_created\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.availability\_date              |       |
      | candidate.salary\_expectations.period     |       |
      | candidate.salary\_expectations.amount     |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.availability\_date              |       |
      | candidate.salary\_expectations.period     |       |
      | candidate.salary\_expectations.amount     |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | Custom Field Explorer |       |
    | Jobs                  |       |
    | Source Writing        |       |
    | Connection Guide      |       |
  </Tab>
</Tabs>


# Phenom ATS Integration
Source: https://docs.kombo.dev/ats/connectors/phenom

Phenom connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Phenom ATS integration allows you to sync ATS data between Phenom and your application through Kombo's unified API. The tool slug for this connector is `phenom`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/34410950532625">
    Step-by-step instructions to connect your Phenom account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | description         |       |
      | employment\_type    |       |
      | status              |       |
      | visibility          |       |
      | category            |       |
      | department          |       |
      | post\_url           |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | opened\_at          |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Applications">
      <Note>
        The Phenom API returns applications whose `jobId` references jobs that are not visible under `siteType=external` (internal, closed, or deleted jobs) or the placeholder value `JOBID`. Such applications are still ingested, but their `job_id` relation will be left dangling (the job will not exist in Kombo).
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        Each job may include **hiringManagerEmail**, **hiringManagerName**, and **multiRecruiter**. User remote ids are the email addresses; Kombo adds the hiring manager first when **hiringManagerEmail** is set, then each recruiter with a non-empty **recruiterEmail** in list order.

        * **hiringManagerEmail** maps to unified type `HIRING_MANAGER`
        * Each **multiRecruiter** entry with a non-empty **recruiterEmail** maps to unified type `RECRUITER`
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                | Notes |
      | -------------------------- | ----- |
      | candidate.first\_name      |       |
      | candidate.last\_name       |       |
      | candidate.email\_address   |       |
      | candidate.phone\_number    |       |
      | candidate.location.city    |       |
      | candidate.location.country |       |
      | application.job\_id        |       |
      | attachments.name           |       |
      | attachments.data\_url      |       |
      | attachments.data           |       |
      | attachments.type           |       |
      | source.name                |       |
      | source.unified\_key        |       |
      | source.id                  |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                | Notes |
      | -------------------------- | ----- |
      | candidate.first\_name      |       |
      | candidate.last\_name       |       |
      | candidate.email\_address   |       |
      | candidate.phone\_number    |       |
      | candidate.location.city    |       |
      | candidate.location.country |       |
      | application.job\_id        |       |
      | attachments.name           |       |
      | attachments.data\_url      |       |
      | attachments.data           |       |
      | attachments.type           |       |
      | source.name                |       |
      | source.unified\_key        |       |
      | source.id                  |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                         | Notes                                                                                                                                                                                                                                                                               |
    | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | API Passthrough                 |                                                                                                                                                                                                                                                                                     |
    | Scope Testing                   |                                                                                                                                                                                                                                                                                     |
    | Per Model Tests                 |                                                                                                                                                                                                                                                                                     |
    | Source Writing                  |                                                                                                                                                                                                                                                                                     |
    | Sync Only Created Applications  |                                                                                                                                                                                                                                                                                     |
    | Connection Guide                |                                                                                                                                                                                                                                                                                     |
    | Roles                           |                                                                                                                                                                                                                                                                                     |
    | Job roles (e.g. Hiring Manager) | Each job may include **hiringManagerEmail**, **hiringManagerName**, and **multiRecruiter**. User remote ids are the email addresses; Kombo adds the hiring manager first when **hiringManagerEmail** is set, then each recruiter with a non-empty **recruiterEmail** in list order. |

    * **hiringManagerEmail** maps to unified type `HIRING_MANAGER`
    * Each **multiRecruiter** entry with a non-empty **recruiterEmail** maps to unified type `RECRUITER` |
  </Tab>
</Tabs>


# P&I Loga ATS Integration
Source: https://docs.kombo.dev/ats/connectors/piloga

P&I Loga connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The P\&I Loga ATS integration allows you to sync ATS data between P\&I Loga and your application through Kombo's unified API. The tool slug for this connector is `piloga`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/27559457965841-P-I-Loga-ATS-How-do-I-link-my-account">
    Step-by-step instructions to connect your P\&I Loga account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | job\_code           |       |
      | description         |       |
      | status              |       |
      | post\_url           |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | opened\_at          |       |
      | closed\_at          |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.street\_1              |       |
      | candidate.location.zip\_code              |       |
      | candidate.gender                          |       |
      | candidate.availability\_date              |       |
      | candidate.salary\_expectations.period     |       |
      | candidate.salary\_expectations.amount     |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.street\_1              |       |
      | candidate.location.zip\_code              |       |
      | candidate.gender                          |       |
      | candidate.availability\_date              |       |
      | candidate.salary\_expectations.period     |       |
      | candidate.salary\_expectations.amount     |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                                | Notes |
    | -------------------------------------- | ----- |
    | Custom Field Explorer                  |       |
    | Jobs                                   |       |
    | Source Writing                         |       |
    | Connection Guide                       |       |
    | Prerequisites                          |       |
    | Create Candidate Full Attachment Retry |       |
  </Tab>
</Tabs>


# Pinpoint ATS Integration
Source: https://docs.kombo.dev/ats/connectors/pinpoint

Pinpoint connector for Kombo's ATS API

The Pinpoint ATS integration allows you to sync ATS data between Pinpoint and your application through Kombo's unified API. The tool slug for this connector is `pinpoint`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/18355330508305">
    Step-by-step instructions to connect your Pinpoint account to Kombo.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22541523124625-PinpointHQ-How-to-view-a-candidates-source">
    How to view and manage candidate sources in Pinpoint.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | description          |       |
      | confidential         |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | department           |       |
      | post\_url            |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_url          |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | contact\_id          |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Job postings">
      <Note>
        Pinpoint's JSON:API `job_postings` resource does not expose a posting-level visibility or status. We therefore sync job postings from the public `postings.json` career-site feed, which only lists publicly visible postings. Internal postings never appear in that feed and are consequently not synced.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description\_html   |       |
      | status              |       |
      | visibility          |       |
      | url                 |       |
      | job\_id             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      <Note>
        Pinpoint exposes application stages as part of the job API response. Kombo will only be able to reference application stages if reading jobs is enabled in the scope config.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                        | Notes |
      | ---------------------------- | ----- |
      | id                           |       |
      | remote\_id                   |       |
      | changed\_at                  |       |
      | remote\_deleted\_at          |       |
      | outcome                      |       |
      | current\_stage\_id           |       |
      | job\_id                      |       |
      | candidate\_id                |       |
      | screening\_question\_answers |       |
      | remote\_url                  |       |
      | remote\_created\_at          |       |
      | remote\_updated\_at          |       |
      | remote\_data                 |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
      | category            |       |
    </Accordion>

    <Accordion title="Tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Interviews">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | starting\_at        |       |
      | ending\_at          |       |
      | application\_id     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        Pinpoint exposes 2 relations for the job

        * **hiring\_manager\_user** (shown as "Public Hiring Manager Profile" in the UI) maps to unified type `HIRING_MANAGER`
        * **recruitment\_manager\_user** (shown as "Recruitment Manager" in the UI) maps to unified type `RECRUITER`
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        The Pinpoint API only allows adding a single CV attachment and no other attachments. If you supply more attachments than one CV, all attachments but one CV will be discarded. Equality monitoring (DEMOGRAPHIC) screening question answers are written to Pinpoint via `equality_monitoring_option_ids`, one option per category.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.state                  |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        The Pinpoint API only allows adding a single CV attachment and no other attachments. If you supply more attachments than one CV, all attachments but one CV will be discarded. Equality monitoring (DEMOGRAPHIC) screening question answers are written to Pinpoint via `equality_monitoring_option_ids`, one option per category.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.state                  |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                         | Notes                                    |
    | ------------------------------- | ---------------------------------------- |
    | API Passthrough                 |                                          |
    | Scope Testing                   |                                          |
    | Per Model Tests                 |                                          |
    | Per Field Tests                 |                                          |
    | Delta Syncs                     |                                          |
    | Source Writing                  |                                          |
    | Sync Only Created Applications  |                                          |
    | Connection Guide                |                                          |
    | Prerequisites                   |                                          |
    | Create credentials              |                                          |
    | Roles                           |                                          |
    | Job roles (e.g. Hiring Manager) | Pinpoint exposes 2 relations for the job |

    * **hiring\_manager\_user** (shown as "Public Hiring Manager Profile" in the UI) maps to unified type `HIRING_MANAGER`
    * **recruitment\_manager\_user** (shown as "Recruitment Manager" in the UI) maps to unified type `RECRUITER` |
  </Tab>
</Tabs>


# ReachMee ATS Integration
Source: https://docs.kombo.dev/ats/connectors/reachmee

ReachMee connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The ReachMee ATS integration allows you to sync ATS data between ReachMee and your application through Kombo's unified API. The tool slug for this connector is `reachmee`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/25096257608209-ReachMee-How-do-I-link-my-account">
    Step-by-step instructions to connect your ReachMee account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | description         |       |
      | confidential        |       |
      | employment\_type    |       |
      | status              |       |
      | visibility          |       |
      | category            |       |
      | location            |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Only one CV and one cover letter are supported for attachments in ReachMee
      </Note>

      | Input Field                 | Notes |
      | --------------------------- | ----- |
      | candidate.first\_name       |       |
      | candidate.last\_name        |       |
      | candidate.email\_address    |       |
      | candidate.phone\_number     |       |
      | candidate.location.city     |       |
      | candidate.gender            |       |
      | candidate.social\_links.url |       |
      | application.job\_id         |       |
      | attachments.name            |       |
      | attachments.content\_type   |       |
      | attachments.data\_url       |       |
      | attachments.data            |       |
      | attachments.type            |       |
      | source.name                 |       |
      | source.unified\_key         |       |
      | source.id                   |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Only one CV and one cover letter are supported for attachments in ReachMee
      </Note>

      | Input Field                 | Notes |
      | --------------------------- | ----- |
      | candidate.first\_name       |       |
      | candidate.last\_name        |       |
      | candidate.email\_address    |       |
      | candidate.phone\_number     |       |
      | candidate.location.city     |       |
      | candidate.gender            |       |
      | candidate.social\_links.url |       |
      | application.job\_id         |       |
      | attachments.name            |       |
      | attachments.content\_type   |       |
      | attachments.data\_url       |       |
      | attachments.data            |       |
      | attachments.type            |       |
      | source.name                 |       |
      | source.unified\_key         |       |
      | source.id                   |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | Scope Testing                  |       |
    | Per Model Tests                |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
    | Prerequisites                  |       |
  </Tab>
</Tabs>


# RECRU ATS Integration
Source: https://docs.kombo.dev/ats/connectors/recruhr

RECRU connector for Kombo's ATS API

The RECRU ATS integration allows you to sync ATS data between RECRU and your application through Kombo's unified API. The tool slug for this connector is `recruhr`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/18775657233169">
    Step-by-step instructions to connect your RECRU account to Kombo.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22565444965649-Recru-How-to-view-a-candidates-source">
    How to view and manage candidate sources in RECRU.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | description         |       |
      | employment\_type    |       |
      | status              |       |
      | visibility          |       |
      | department          |       |
      | experience\_level   |       |
      | salary\_amount      |       |
      | opened\_at          |       |
      | closed\_at          |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
    </Accordion>

    <Accordion title="Tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field               | Notes |
      | ------------------------- | ----- |
      | candidate.first\_name     |       |
      | candidate.last\_name      |       |
      | candidate.email\_address  |       |
      | candidate.phone\_number   |       |
      | candidate.location.city   |       |
      | application.job\_id       |       |
      | attachments.name          |       |
      | attachments.data\_url     |       |
      | attachments.data          |       |
      | attachments.type          |       |
      | source.name               |       |
      | source.unified\_key       |       |
      | source.id                 |       |
      | gdpr\_consent.expires\_at |       |
      | gdpr\_consent.given       |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field               | Notes |
      | ------------------------- | ----- |
      | candidate.first\_name     |       |
      | candidate.last\_name      |       |
      | candidate.email\_address  |       |
      | candidate.phone\_number   |       |
      | candidate.location.city   |       |
      | application.job\_id       |       |
      | attachments.name          |       |
      | attachments.data\_url     |       |
      | attachments.data          |       |
      | attachments.type          |       |
      | source.name               |       |
      | source.unified\_key       |       |
      | source.id                 |       |
      | gdpr\_consent.expires\_at |       |
      | gdpr\_consent.given       |       |
    </Accordion>

    <Accordion title="Add tag to candidate">
      <Note>
        We can't create tags, but only assign existing ones. Creating new tags is not supported by the RECRU API.
      </Note>

      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
    | Prerequisites                  |       |
    | Create credentials             |       |
  </Tab>
</Tabs>


# Recruit CRM ATS Integration
Source: https://docs.kombo.dev/ats/connectors/recruitcrm

Recruit CRM connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Recruit CRM ATS integration allows you to sync ATS data between Recruit CRM and your application through Kombo's unified API. The tool slug for this connector is `recruitcrm`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/44885541745809-Recruit-CRM-How-do-I-link-my-account">
    Step-by-step instructions to connect your Recruit CRM account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | category             |       |
      | department           |       |
      | post\_url            |       |
      | experience\_level    |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_url          |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | contact\_id          |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                        | Notes |
      | ---------------------------- | ----- |
      | id                           |       |
      | remote\_id                   |       |
      | changed\_at                  |       |
      | remote\_deleted\_at          |       |
      | current\_stage\_id           |       |
      | job\_id                      |       |
      | candidate\_id                |       |
      | screening\_question\_answers |       |
      | custom\_fields               |       |
      | integration\_fields          |       |
      | remote\_updated\_at          |       |
      | remote\_data                 |       |
    </Accordion>

    <Accordion title="Screening questions">
      <Note>
        Recruit CRM screening questions are always free-text inputs.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="User roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | user\_id            |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        If an exact-email candidate already exists in Recruit CRM, this action reuses the most recently updated profile instead of creating a duplicate candidate. CV and OTHER attachments written by this action live on the candidate profile, not on a specific application record.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.state                  |       |
      | candidate.location.street\_1              |       |
      | candidate.location.zip\_code              |       |
      | candidate.availability\_date              |       |
      | candidate.salary\_expectations.amount     |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        If an exact-email candidate already exists in Recruit CRM, this action reuses the most recently updated profile instead of creating a duplicate candidate. CV and OTHER attachments written by this action live on the candidate profile, not on a specific application record.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.state                  |       |
      | candidate.location.street\_1              |       |
      | candidate.location.zip\_code              |       |
      | candidate.availability\_date              |       |
      | candidate.salary\_expectations.amount     |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        CV and OTHER attachments live on the candidate, not on a specific application record. This action writes those files to the candidate.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Add note to application">
      <Note>
        Recruit CRM notes are attached to the candidate profile, not to a specific application. You need to configure a target note type ID in the integration settings.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      <Note>
        CV and OTHER attachments live on the candidate, so they can appear on every application for that candidate.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | API Passthrough                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    | Webhook Subscriptions          | candidate.assigned: triggered when a candidate was assigned to a job in Recruit CRM candidate.external.applied.jobs: triggered when a candidate applied to a job through Recruit CRM’s external form candidate.hiringstage.updated: triggered when an application stage changed on a job candidate.unassigned: triggered when a candidate was unassigned from a job candidate.created: triggered when a candidate was created candidate.created.talentpool: triggered when a candidate was created from a talent pool candidate.updated: triggered when a candidate was updated candidate.external.profile.updated: triggered when a candidate updated their profile through Recruit CRM’s external profile form candidate.deleted: triggered when a candidate was deleted job.created: triggered when a job was created job.updated: triggered when a job was updated job.status.updated: triggered when a job status changed job.deleted: triggered when a job was deleted contact.created: triggered when a contact was created contact.updated: triggered when a contact was updated contact.deleted: triggered when a contact was deleted Not covered: interview scheduled Not covered: interview updated Not covered: tag assigned Not covered: job published Not covered: job unpublished Not covered: screening questions updated |
    | Automatic Setup                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    | Custom Field Explorer          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    | Jobs                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    | Candidates                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    | Source Writing                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    | Sync Only Created Applications |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    | Connection Guide               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    | Candidate Cutoff Filtering     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    | Roles                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    | System roles (e.g. Admin)      |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
  </Tab>
</Tabs>


# Tellent Recruitee ATS Integration
Source: https://docs.kombo.dev/ats/connectors/recruitee

Tellent Recruitee connector for Kombo's ATS API

The Tellent Recruitee ATS integration allows you to sync ATS data between Tellent Recruitee and your application through Kombo's unified API. The tool slug for this connector is `recruitee`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/14886945428241-How-do-I-link-my-Recruitee-account-">
    Step-by-step instructions to connect your Tellent Recruitee account to Kombo.
  </Card>

  <Card title="Sandbox Environment" icon="flask" href="https://auth.recruitee.com/sign-up">
    Access the Tellent Recruitee sandbox environment for testing and development.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22527746904337-Recruitee-How-to-view-a-candidates-source">
    How to view and manage candidate sources in Tellent Recruitee.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes                                                                                 |
      | ------------------- | ------------------------------------------------------------------------------------- |
      | id                  |                                                                                       |
      | remote\_id          |                                                                                       |
      | changed\_at         |                                                                                       |
      | remote\_deleted\_at |                                                                                       |
      | first\_name         |                                                                                       |
      | last\_name          |                                                                                       |
      | email               |                                                                                       |
      | status              | Recruitee only gives us the active users. Inactive users are not returned by the API. |
      | remote\_data        |                                                                                       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | weekly\_hours        |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | category             |       |
      | department           |       |
      | post\_url            |       |
      | experience\_level    |       |
      | remote\_work\_status |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_url          |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                        | Notes |
      | ---------------------------- | ----- |
      | id                           |       |
      | remote\_id                   |       |
      | changed\_at                  |       |
      | remote\_deleted\_at          |       |
      | outcome                      |       |
      | rejection\_reason\_name      |       |
      | rejected\_at                 |       |
      | current\_stage\_id           |       |
      | job\_id                      |       |
      | candidate\_id                |       |
      | screening\_question\_answers |       |
      | custom\_fields               |       |
      | integration\_fields          |       |
      | remote\_url                  |       |
      | remote\_created\_at          |       |
      | remote\_updated\_at          |       |
      | remote\_data                 |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Interviews">
      | Field                    | Notes |
      | ------------------------ | ----- |
      | id                       |       |
      | remote\_id               |       |
      | changed\_at              |       |
      | remote\_deleted\_at      |       |
      | starting\_at             |       |
      | ending\_at               |       |
      | location                 |       |
      | video\_conferencing\_url |       |
      | application\_id          |       |
      | remote\_data             |       |
    </Accordion>

    <Accordion title="Offers">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | status                  |       |
      | employment\_start\_date |       |
      | application\_id         |       |
      | custom\_fields          |       |
      | integration\_fields     |       |
      | remote\_created\_at     |       |
      | remote\_updated\_at     |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.expires\_at                 |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.expires\_at                 |       |
    </Accordion>

    <Accordion title="Add tag to candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Remove tag from candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Reject application">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | application\_id       |       |
      | rejection\_reason\_id |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Add result link to candidate">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | candidate\_id                       |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | API Passthrough                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    | Webhook Subscriptions          | Detailed coverage unknown, please reach out to support: job published, job unpublished, candidate created, application stage changed, tag assigned, screening questions updated, interview scheduled, interview updated candidate\_assigned: triggered when unknown candidate\_moved: triggered when unknown new\_candidate: triggered when unknown candidate\_deleted: triggered when a candidate was deleted offer\_published: triggered when unknown offer\_unpublished: triggered when unknown offer\_updated: triggered when unknown |
    | Automatic Setup                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    | Scope Testing                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    | Per Model Tests                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    | Delta Syncs                    |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    | Custom Field Explorer          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    | Jobs                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    | Offers                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    | Source Writing                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    | Sync Only Created Applications |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    | Connection Guide               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    | Prerequisites                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    | Create credentials             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    | Candidate Cutoff Filtering     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    | EEO Questions                  | Recruitee automatically sends candidates an email after application to collect EEO data                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Tellent Recruitee

For **Tellent Recruitee**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Tellent Recruitee Assessment" icon="https://storage.googleapis.com/kombo-assets/integrations/recruitee/icon.svg" href="/assessment/connectors/recruitee">
    Tellent Recruitee for the Assessment category
  </Card>
</CardGroup>


# RecruiterFlow ATS Integration
Source: https://docs.kombo.dev/ats/connectors/recruiterflow

RecruiterFlow connector for Kombo's ATS API

The RecruiterFlow ATS integration allows you to sync ATS data between RecruiterFlow and your application through Kombo's unified API. The tool slug for this connector is `recruiterflow`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/39754939730449-RecruiterFlow-How-do-I-link-my-account">
    Step-by-step instructions to connect your RecruiterFlow account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      <Note>
        We only map the first location on the locations array.
      </Note>

      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | department           |       |
      | post\_url            |       |
      | experience\_level    |       |
      | remote\_work\_status |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_created\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | outcome                 |       |
      | rejection\_reason\_name |       |
      | current\_stage\_id      |       |
      | job\_id                 |       |
      | candidate\_id           |       |
      | custom\_fields          |       |
      | integration\_fields     |       |
      | remote\_created\_at     |       |
      | remote\_updated\_at     |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        Recruiterflow exposes a list of hiring team members on the job

        * All job roles in Recruiterflow (shown as "Recruiter" or "Account Manager") map to RECRUITER
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="User roles">
      <Note>
        Recruiterflow provides a list of system roles for each user (**name** on each role)

        * **name** equal to Admin (case-insensitive) maps to unified type `ADMIN`
        * **name** equal to Recruiter (case-insensitive) maps to unified type `RECRUITER`
        * Any other **name** has no unified type.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | user\_id            |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        After adding a candidate to a job, RecruiterFlow may take a few minutes to reflect the application. We poll for up to 5 minutes. RecruiterFlow can't set the stage when adding a candidate to a job, so we move them into the requested stage with a follow-up call. This requires an "on behalf of" user on the integration; if it's missing or the move fails, the candidate is still created and we surface a warning.
      </Note>

      | Input Field                                           | Notes |
      | ----------------------------------------------------- | ----- |
      | candidate.first\_name                                 |       |
      | candidate.last\_name                                  |       |
      | candidate.email\_address                              |       |
      | candidate.additional\_email\_addresses.email\_address |       |
      | candidate.company                                     |       |
      | candidate.title                                       |       |
      | candidate.phone\_number                               |       |
      | candidate.additional\_phone\_numbers.phone\_number    |       |
      | candidate.location.city                               |       |
      | candidate.location.country                            |       |
      | candidate.location.state                              |       |
      | candidate.location.zip\_code                          |       |
      | candidate.social\_links.url                           |       |
      | application.job\_id                                   |       |
      | application.stage\_id                                 |       |
      | attachments.name                                      |       |
      | attachments.data\_url                                 |       |
      | attachments.data                                      |       |
      | attachments.type                                      |       |
      | source.name                                           |       |
      | source.unified\_key                                   |       |
      | source.id                                             |       |
      | sourced\_by.user\_id                                  |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        After adding a candidate to a job, RecruiterFlow may take a few minutes to reflect the application. We poll for up to 5 minutes. RecruiterFlow can't set the stage when adding a candidate to a job, so we move them into the requested stage with a follow-up call. This requires an "on behalf of" user on the integration; if it's missing or the move fails, the candidate is still created and we surface a warning.
      </Note>

      | Input Field                                           | Notes |
      | ----------------------------------------------------- | ----- |
      | candidate.first\_name                                 |       |
      | candidate.last\_name                                  |       |
      | candidate.email\_address                              |       |
      | candidate.additional\_email\_addresses.email\_address |       |
      | candidate.company                                     |       |
      | candidate.title                                       |       |
      | candidate.phone\_number                               |       |
      | candidate.additional\_phone\_numbers.phone\_number    |       |
      | candidate.location.city                               |       |
      | candidate.location.country                            |       |
      | candidate.location.state                              |       |
      | candidate.location.zip\_code                          |       |
      | candidate.social\_links.url                           |       |
      | application.job\_id                                   |       |
      | application.stage\_id                                 |       |
      | attachments.name                                      |       |
      | attachments.data\_url                                 |       |
      | attachments.data                                      |       |
      | attachments.type                                      |       |
      | source.name                                           |       |
      | source.unified\_key                                   |       |
      | source.id                                             |       |
      | sourced\_by.user\_id                                  |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | application\_id      |       |
      | attachment.name      |       |
      | attachment.data\_url |       |
      | attachment.data      |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Reject application">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | application\_id       |       |
      | rejection\_reason\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      | Input Field          | Notes |
      | -------------------- | ----- |
      | candidate\_id        |       |
      | attachment.name      |       |
      | attachment.data\_url |       |
      | attachment.data      |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes                                                                               |
    | ------------------------------ | ----------------------------------------------------------------------------------- |
    | API Passthrough                |                                                                                     |
    | Custom Field Explorer          |                                                                                     |
    | Jobs                           |                                                                                     |
    | Source Writing                 |                                                                                     |
    | Sync Only Created Applications |                                                                                     |
    | Connection Guide               |                                                                                     |
    | Roles                          |                                                                                     |
    | System roles (e.g. Admin)      | Recruiterflow provides a list of system roles for each user (**name** on each role) |

    * **name** equal to Admin (case-insensitive) maps to unified type `ADMIN`
    * **name** equal to Recruiter (case-insensitive) maps to unified type `RECRUITER`
    * Any other **name** has no unified type. |
      \|   Job roles (e.g. Hiring Manager) | Recruiterflow exposes a list of hiring team members on the job
    * All job roles in Recruiterflow (shown as "Recruiter" or "Account Manager") map to RECRUITER |
  </Tab>
</Tabs>


# rexx systems ATS Integration
Source: https://docs.kombo.dev/ats/connectors/rexx

rexx systems connector for Kombo's ATS API

The rexx systems ATS integration allows you to sync ATS data between rexx systems and your application through Kombo's unified API. The tool slug for this connector is `rexx`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/20045641445521">
    Step-by-step instructions to connect your rexx systems account to Kombo.
  </Card>

  <Card title="Source Setup Guide" icon="settings" href="https://help.kombo.dev/hc/en-us/articles/20465866548113">
    Learn how to set up candidate sources in rexx systems.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22576610472337-Rexx-How-to-view-a-candidates-source">
    How to view and manage candidate sources in rexx systems.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | department           |       |
      | post\_url            |       |
      | remote\_work\_status |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                               | Notes                                                                                                                              |
      | ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
      | candidate.first\_name                     |                                                                                                                                    |
      | candidate.last\_name                      |                                                                                                                                    |
      | candidate.email\_address                  |                                                                                                                                    |
      | candidate.title                           |                                                                                                                                    |
      | candidate.phone\_number                   |                                                                                                                                    |
      | candidate.location.city                   |                                                                                                                                    |
      | candidate.location.country                |                                                                                                                                    |
      | candidate.location.street\_1              |                                                                                                                                    |
      | candidate.location.zip\_code              |                                                                                                                                    |
      | candidate.gender                          |                                                                                                                                    |
      | candidate.availability\_date              |                                                                                                                                    |
      | candidate.salary\_expectations.period     |                                                                                                                                    |
      | candidate.salary\_expectations.amount     |                                                                                                                                    |
      | application.job\_id                       |                                                                                                                                    |
      | screening\_question\_answers.question\_id |                                                                                                                                    |
      | screening\_question\_answers.answer       |                                                                                                                                    |
      | attachments.name                          |                                                                                                                                    |
      | attachments.content\_type                 |                                                                                                                                    |
      | attachments.data\_url                     |                                                                                                                                    |
      | attachments.data                          |                                                                                                                                    |
      | attachments.type                          |                                                                                                                                    |
      | source.name                               | The source will only be written if a source with the exact name has been configured in rexx already. Otherwise it will be ignored. |
      | source.unified\_key                       |                                                                                                                                    |
      | source.id                                 |                                                                                                                                    |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                               | Notes                                                                                                                              |
      | ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
      | candidate.first\_name                     |                                                                                                                                    |
      | candidate.last\_name                      |                                                                                                                                    |
      | candidate.email\_address                  |                                                                                                                                    |
      | candidate.title                           |                                                                                                                                    |
      | candidate.phone\_number                   |                                                                                                                                    |
      | candidate.location.city                   |                                                                                                                                    |
      | candidate.location.country                |                                                                                                                                    |
      | candidate.location.street\_1              |                                                                                                                                    |
      | candidate.location.zip\_code              |                                                                                                                                    |
      | candidate.gender                          |                                                                                                                                    |
      | candidate.availability\_date              |                                                                                                                                    |
      | candidate.salary\_expectations.period     |                                                                                                                                    |
      | candidate.salary\_expectations.amount     |                                                                                                                                    |
      | application.job\_id                       |                                                                                                                                    |
      | screening\_question\_answers.question\_id |                                                                                                                                    |
      | screening\_question\_answers.answer       |                                                                                                                                    |
      | attachments.name                          |                                                                                                                                    |
      | attachments.content\_type                 |                                                                                                                                    |
      | attachments.data\_url                     |                                                                                                                                    |
      | attachments.data                          |                                                                                                                                    |
      | attachments.type                          |                                                                                                                                    |
      | source.name                               | The source will only be written if a source with the exact name has been configured in rexx already. Otherwise it will be ignored. |
      | source.unified\_key                       |                                                                                                                                    |
      | source.id                                 |                                                                                                                                    |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | Custom Field Explorer          |       |
    | Jobs                           |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
    | Candidate source tracking      |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** rexx systems

For **rexx systems**, we also offer the following other connector variants:

<CardGroup>
  <Card title="rexx systems HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/rexx/icon.svg" href="/hris/connectors/rexx">
    rexx systems for the HRIS category
  </Card>
</CardGroup>


# Sage HR ATS Integration
Source: https://docs.kombo.dev/ats/connectors/sagehr

Sage HR connector for Kombo's ATS API

The Sage HR ATS integration allows you to sync ATS data between Sage HR and your application through Kombo's unified API. The tool slug for this connector is `sagehr`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/18200475423761">
    Step-by-step instructions to connect your Sage HR account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | description         |       |
      | employment\_type    |       |
      | status              |       |
      | visibility          |       |
      | department          |       |
      | post\_url           |       |
      | location            |       |
      | opened\_at          |       |
      | closed\_at          |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                | Notes |
      | -------------------------- | ----- |
      | candidate.first\_name      |       |
      | candidate.last\_name       |       |
      | candidate.email\_address   |       |
      | candidate.title            |       |
      | candidate.phone\_number    |       |
      | candidate.location.city    |       |
      | candidate.location.country |       |
      | application.job\_id        |       |
      | attachments.name           |       |
      | attachments.content\_type  |       |
      | attachments.data\_url      |       |
      | attachments.data           |       |
      | attachments.type           |       |
      | source.name                |       |
      | source.unified\_key        |       |
      | source.id                  |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                | Notes |
      | -------------------------- | ----- |
      | candidate.first\_name      |       |
      | candidate.last\_name       |       |
      | candidate.email\_address   |       |
      | candidate.title            |       |
      | candidate.phone\_number    |       |
      | candidate.location.city    |       |
      | candidate.location.country |       |
      | application.job\_id        |       |
      | attachments.name           |       |
      | attachments.content\_type  |       |
      | attachments.data\_url      |       |
      | attachments.data           |       |
      | attachments.type           |       |
      | source.name                |       |
      | source.unified\_key        |       |
      | source.id                  |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
    | Prerequisites                  |       |
    | Create credentials             |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Sage HR

For **Sage HR**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Sage HR HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/sagehr/icon.svg" href="/hris/connectors/sagehr">
    Sage HR for the HRIS category
  </Card>
</CardGroup>


# Kombo Sandbox ATS Integration
Source: https://docs.kombo.dev/ats/connectors/sandbox

Kombo Sandbox connector for Kombo's ATS API

The Kombo Sandbox ATS integration allows you to sync ATS data between Kombo Sandbox and your application through Kombo's unified API. The tool slug for this connector is `sandbox`.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | description          |       |
      | confidential         |       |
      | weekly\_hours        |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | category             |       |
      | department           |       |
      | post\_url            |       |
      | experience\_level    |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | contact\_id          |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Job postings">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description\_html   |       |
      | status              |       |
      | visibility          |       |
      | job\_id             |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | confidential        |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                        | Notes |
      | ---------------------------- | ----- |
      | id                           |       |
      | remote\_id                   |       |
      | changed\_at                  |       |
      | remote\_deleted\_at          |       |
      | outcome                      |       |
      | rejected\_at                 |       |
      | current\_stage\_id           |       |
      | job\_id                      |       |
      | candidate\_id                |       |
      | screening\_question\_answers |       |
      | custom\_fields               |       |
      | integration\_fields          |       |
      | remote\_data                 |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Interviews">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | starting\_at        |       |
      | ending\_at          |       |
      | location            |       |
      | application\_id     |       |
      | stage\_id           |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Offers">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | status                  |       |
      | employment\_start\_date |       |
      | application\_id         |       |
      | custom\_fields          |       |
      | integration\_fields     |       |
      | remote\_created\_at     |       |
      | remote\_updated\_at     |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Notes">
      <Note>
        The sandbox exposes free-form candidate and application notes only, with no activity-feed entries to filter out.

        * Notes always link to a candidate; `application_id` is `null` for candidate-level notes.
        * `author_id` is `null` for notes the sandbox generates without a user behind them.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | candidate\_id       |       |
      | application\_id     |       |
      | author\_id          |       |
      | title               |       |
      | content\_html       |       |
      | is\_private         |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="User roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | user\_id            |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Interviewing team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | interview\_id       |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                                           | Notes |
      | ----------------------------------------------------- | ----- |
      | candidate.first\_name                                 |       |
      | candidate.last\_name                                  |       |
      | candidate.email\_address                              |       |
      | candidate.additional\_email\_addresses.email\_address |       |
      | candidate.company                                     |       |
      | candidate.title                                       |       |
      | candidate.phone\_number                               |       |
      | candidate.additional\_phone\_numbers.phone\_number    |       |
      | candidate.location.city                               |       |
      | candidate.location.country                            |       |
      | candidate.location.zip\_code                          |       |
      | candidate.gender                                      |       |
      | candidate.availability\_date                          |       |
      | candidate.salary\_expectations.period                 |       |
      | candidate.salary\_expectations.amount                 |       |
      | candidate.social\_links.url                           |       |
      | application.job\_id                                   |       |
      | application.stage\_id                                 |       |
      | screening\_question\_answers.question\_id             |       |
      | screening\_question\_answers.answer                   |       |
      | attachments.name                                      |       |
      | attachments.content\_type                             |       |
      | attachments.data\_url                                 |       |
      | attachments.data                                      |       |
      | attachments.type                                      |       |
      | source.name                                           |       |
      | source.unified\_key                                   |       |
      | source.id                                             |       |
      | gdpr\_consent.expires\_at                             |       |
      | gdpr\_consent.given                                   |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                                           | Notes |
      | ----------------------------------------------------- | ----- |
      | candidate.first\_name                                 |       |
      | candidate.last\_name                                  |       |
      | candidate.email\_address                              |       |
      | candidate.additional\_email\_addresses.email\_address |       |
      | candidate.company                                     |       |
      | candidate.title                                       |       |
      | candidate.phone\_number                               |       |
      | candidate.additional\_phone\_numbers.phone\_number    |       |
      | candidate.location.city                               |       |
      | candidate.location.country                            |       |
      | candidate.location.zip\_code                          |       |
      | candidate.gender                                      |       |
      | candidate.availability\_date                          |       |
      | candidate.salary\_expectations.period                 |       |
      | candidate.salary\_expectations.amount                 |       |
      | candidate.social\_links.url                           |       |
      | application.job\_id                                   |       |
      | application.stage\_id                                 |       |
      | screening\_question\_answers.question\_id             |       |
      | screening\_question\_answers.answer                   |       |
      | attachments.name                                      |       |
      | attachments.content\_type                             |       |
      | attachments.data\_url                                 |       |
      | attachments.data                                      |       |
      | attachments.type                                      |       |
      | source.name                                           |       |
      | source.unified\_key                                   |       |
      | source.id                                             |       |
      | gdpr\_consent.expires\_at                             |       |
      | gdpr\_consent.given                                   |       |
    </Accordion>

    <Accordion title="Add tag to candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Remove tag from candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        We do not persist the attachment uploaded to the Sandbox integration. This means you won't be able to retrieve any attachments from the [Add attachment to application](`docs.kombo.dev/ats/v1/post-applications-application-id-attachments`) endpoint This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application" />

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      <Note>
        We do not persist the attachment uploaded to the Sandbox integration. This means you won't be able to retrieve any attachments from the [Add attachment to application](`docs.kombo.dev/ats/v1/post-applications-application-id-attachments`) endpoint
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Add result link to candidate">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | candidate\_id                       |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                         | Notes |
    | ------------------------------- | ----- |
    | API Passthrough                 |       |
    | Custom Field Explorer           |       |
    | Jobs                            |       |
    | Source Writing                  |       |
    | Sync Only Created Applications  |       |
    | Roles                           |       |
    | System roles (e.g. Admin)       |       |
    | Job roles (e.g. Hiring Manager) |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Kombo Sandbox

For **Kombo Sandbox**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Kombo Sandbox Assessment" icon="https://storage.googleapis.com/kombo-assets/integrations/sandbox/icon.svg" href="/assessment/connectors/sandbox">
    Kombo Sandbox for the Assessment category
  </Card>

  <Card title="Kombo Sandbox HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/sandbox/icon.svg" href="/hris/connectors/sandbox">
    Kombo Sandbox for the HRIS category
  </Card>

  <Card title="Kombo Sandbox LMS" icon="https://storage.googleapis.com/kombo-assets/integrations/sandbox/icon.svg" href="/lms/connectors/sandbox">
    Kombo Sandbox for the LMS category
  </Card>
</CardGroup>


# SmartRecruiters ATS Integration
Source: https://docs.kombo.dev/ats/connectors/smartrecruiters

SmartRecruiters connector for Kombo's ATS API

The SmartRecruiters ATS integration allows you to sync ATS data between SmartRecruiters and your application through Kombo's unified API. The tool slug for this connector is `smartrecruiters`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/16086133813521-How-do-I-link-my-SmartRecruiters-account-">
    Step-by-step instructions to connect your SmartRecruiters account to Kombo.
  </Card>

  <Card title="Source Setup Guide" icon="settings" href="https://help.kombo.dev/hc/en-us/articles/17103364030481">
    Learn how to set up candidate sources in SmartRecruiters.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22527032627729-SmartRecuiters-How-to-view-a-candidates-source">
    How to view and manage candidate sources in SmartRecruiters.
  </Card>

  <Card title="How to create an integration user in SmartRecruiters" icon="book" href="https://help.kombo.dev/hc/en-us/articles/31805589713425-SmartRecruiters-Creating-an-integration-user">
    Additional documentation and guides for SmartRecruiters.
  </Card>

  <Card title="SmartRecruiters: GDPR consent and screening questions" icon="book" href="https://help.kombo.dev/hc/en-us/articles/45942627581841-SmartRecruiters-how-Kombo-writes-GDPR-consent-decisions">
    Additional documentation and guides for SmartRecruiters.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      <Note>
        SmartRecruiters does not validate email addresses. Kombo will sync all users, but only return emails that have been validated.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | category             |       |
      | department           |       |
      | post\_url            |       |
      | experience\_level    |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_url          |       |
      | opened\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Job postings">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description\_html   |       |
      | status              |       |
      | visibility          |       |
      | url                 |       |
      | job\_id             |       |
      | remote\_data        |       |
      | remote\_created\_at |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      <Note>
        SmartRecruiters will continue to reference inactive or deleted application stages
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                        | Notes                                                                                                                                                                                                                                      |
      | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
      | id                           |                                                                                                                                                                                                                                            |
      | remote\_id                   |                                                                                                                                                                                                                                            |
      | changed\_at                  |                                                                                                                                                                                                                                            |
      | remote\_deleted\_at          |                                                                                                                                                                                                                                            |
      | outcome                      |                                                                                                                                                                                                                                            |
      | rejection\_reason\_name      |                                                                                                                                                                                                                                            |
      | rejected\_at                 |                                                                                                                                                                                                                                            |
      | current\_stage\_id           |                                                                                                                                                                                                                                            |
      | job\_id                      |                                                                                                                                                                                                                                            |
      | candidate\_id                |                                                                                                                                                                                                                                            |
      | screening\_question\_answers |                                                                                                                                                                                                                                            |
      | custom\_fields               |                                                                                                                                                                                                                                            |
      | integration\_fields          |                                                                                                                                                                                                                                            |
      | remote\_url                  |                                                                                                                                                                                                                                            |
      | remote\_created\_at          | The remote\_created\_at field will only be filled when we are syncing the application status history which we are doing to sync rejected\_at.                                                                                              |
      | remote\_updated\_at          | The remote\_updated\_at field will only be filled when we are syncing the application status history which we are doing to sync rejected\_at. Furthermore, it only reflects changes to the application status, not the application itself. |
      | remote\_data                 |                                                                                                                                                                                                                                            |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
      | category            |       |
    </Accordion>

    <Accordion title="Tags">
      <Note>
        SmartRecruiters API only provides access to tags that are currently assigned to candidates. This means Kombo can only retrieve tags that are attached to specific candidates, rather than providing a complete list of all available tags in the SmartRecruiters system.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Interviews">
      | Field                    | Notes |
      | ------------------------ | ----- |
      | id                       |       |
      | remote\_id               |       |
      | changed\_at              |       |
      | remote\_deleted\_at      |       |
      | title                    |       |
      | starting\_at             |       |
      | ending\_at               |       |
      | location                 |       |
      | video\_conferencing\_url |       |
      | application\_id          |       |
      | canceled                 |       |
      | remote\_data             |       |
    </Accordion>

    <Accordion title="Offers">
      | Field               | Notes                                                                                                                                                                                                                                                                 |
      | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
      | id                  |                                                                                                                                                                                                                                                                       |
      | remote\_id          |                                                                                                                                                                                                                                                                       |
      | changed\_at         |                                                                                                                                                                                                                                                                       |
      | remote\_deleted\_at |                                                                                                                                                                                                                                                                       |
      | status              |                                                                                                                                                                                                                                                                       |
      | application\_id     | The SmartRecruiters offer model only contains references to the candidate and job. If `application_id` is enabled in your Kombo scope config, we therefore additionally request the application read scope to retrieve the application ID from the candidate and job. |
      | custom\_fields      |                                                                                                                                                                                                                                                                       |
      | integration\_fields |                                                                                                                                                                                                                                                                       |
      | remote\_created\_at |                                                                                                                                                                                                                                                                       |
      | remote\_updated\_at |                                                                                                                                                                                                                                                                       |
      | remote\_data        |                                                                                                                                                                                                                                                                       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        Smartrecruiters exposes a list of hiring team members with a specific role

        * **HIRING\_MANAGER** (shown as "Hiring Manager" in the UI) maps to unified type `HIRING_MANAGER`
        * **RECRUITER** (shown as "Recruiter" in the UI) maps to unified type `RECRUITER`
        * **INTERVIEW\_TEAM** (shown as "Interviewer" in the UI) maps to unified type `INTERVIEWER`
        * **COORDINATOR** (shown as "Coordinator" in the UI) maps to unified type `COORDINATOR`
        * **EXECUTIVE** (shown as "Executive" in the UI) has no unified type
        * Other role values (often a custom id) have no unified type
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="User roles">
      <Note>
        Each user has **systemRole.id**; Kombo stores that value on the role. Custom ids use the name from the synced system-roles resource when available, otherwise the raw id.

        * **ADMINISTRATOR** maps to unified type `ADMIN`
        * **EMPLOYEE**, **STANDARD**, and **EXTENDED** have no unified type
        * **RESTRICTED** corresponds to the Basic role in the SmartRecruiters UI and has no unified type
        * Any other **systemRole.id** follows the custom-role lookup above and has no unified type.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | user\_id            |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Interviewing team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | interview\_id       |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        The `read_jobs` permission is required because we need to look up job posting details when creating candidates. SmartRecruiters does not allow setting a stage directly when creating a candidate. Passing the `stage_id` parameter to Kombo when creating a candidate will therefore move the candidate to the stage post-creation, and requires the `candidate_manage` SmartRecruiters permission. Past candidate experience must be defined with a start date and title within the SmartRecruiters API. Kombo will set the title to '-' if only the company field is passed without a title. The start date is set to 2100-01-01 as a dummy value; if you require a different start date, please set it via remote\_fields.
      </Note>

      | Input Field                               | Notes                                                                                                                                                                                                                                                                                                                                                                                             |
      | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
      | candidate.first\_name                     |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | candidate.last\_name                      |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | candidate.email\_address                  |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | candidate.company                         |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | candidate.title                           |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | candidate.phone\_number                   |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | candidate.location.city                   |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | candidate.location.country                |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | candidate.social\_links.url               |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | application.job\_id                       |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | application.stage\_id                     |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | screening\_question\_answers.question\_id |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | screening\_question\_answers.answer       |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | attachments.name                          |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | attachments.content\_type                 |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | attachments.data\_url                     |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | attachments.data                          |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | attachments.type                          |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | source.name                               | Please note that we can only write sources that your customer has already set up with the exact name (under `www.smartrecruiters.com/settings/configuration/custom-sources`). If you specify a source within the `source.name` field, we will only use it if it's already set up within SmartRecruiters and is of the type 'OTHER'. Otherwise, the source defined in the connection flow is used. |
      | source.unified\_key                       |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | source.id                                 |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | gdpr\_consent.given                       |                                                                                                                                                                                                                                                                                                                                                                                                   |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        The `read_jobs` permission is required because we need to look up job posting details when creating candidates. SmartRecruiters does not allow setting a stage directly when creating a candidate. Passing the `stage_id` parameter to Kombo when creating a candidate will therefore move the candidate to the stage post-creation, and requires the `candidate_manage` SmartRecruiters permission. Past candidate experience must be defined with a start date and title within the SmartRecruiters API. Kombo will set the title to '-' if only the company field is passed without a title. The start date is set to 2100-01-01 as a dummy value; if you require a different start date, please set it via remote\_fields.
      </Note>

      | Input Field                               | Notes                                                                                                                                                                                                                                                                                                                                                                                             |
      | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
      | candidate.first\_name                     |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | candidate.last\_name                      |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | candidate.email\_address                  |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | candidate.company                         |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | candidate.title                           |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | candidate.phone\_number                   |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | candidate.location.city                   |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | candidate.location.country                |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | candidate.social\_links.url               |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | application.job\_id                       |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | application.stage\_id                     |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | screening\_question\_answers.question\_id |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | screening\_question\_answers.answer       |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | attachments.name                          |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | attachments.content\_type                 |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | attachments.data\_url                     |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | attachments.data                          |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | attachments.type                          |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | source.name                               | Please note that we can only write sources that your customer has already set up with the exact name (under `www.smartrecruiters.com/settings/configuration/custom-sources`). If you specify a source within the `source.name` field, we will only use it if it's already set up within SmartRecruiters and is of the type 'OTHER'. Otherwise, the source defined in the connection flow is used. |
      | source.unified\_key                       |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | source.id                                 |                                                                                                                                                                                                                                                                                                                                                                                                   |
      | gdpr\_consent.given                       |                                                                                                                                                                                                                                                                                                                                                                                                   |
    </Accordion>

    <Accordion title="Add tag to candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Remove tag from candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        The SmartRecruiters 'add attachment to candidate' endpoint is deprecated. Please prefer to use Kombo's 'add attachment to application' endpoint.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Reject application">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | application\_id       |       |
      | rejection\_reason\_id |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | label                    |       |
      | url                      |       |
      | details.attributes.key   |       |
      | details.attributes.value |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      <Note>
        The SmartRecruiters 'add attachment to candidate' endpoint is deprecated. Please prefer to use Kombo's 'add attachment to application' endpoint.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Add result link to candidate">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | label                    |       |
      | url                      |       |
      | details.attributes.key   |       |
      | details.attributes.value |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
    | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | OAuth                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    | API Passthrough                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    | Webhook Subscriptions          | application.created: triggered when an application was created application.fields.updated: triggered when application fields were updated application.onboarding-status.updated: triggered when application onboarding status was updated application.screening-answers.created: triggered when screening question answers were added to an application application.screening-answers.updated: triggered when screening question answers were updated on an application application.source.updated: triggered when the source of the application was updated application.status.updated: triggered when the status (stage) of an application was changed candidate.created: triggered when a candidate was created candidate.updated: triggered when a candidate was updated including tag assigned/unassigned interview\.created: triggered when an interview was scheduled interview\.updated: triggered when an interview was updated candidate.deleted: triggered when a candidate was deleted interview\.canceled: triggered when an interview was canceled job.ad.created: triggered when a job ad was created job.ad.updated: triggered when a job ad was updated job.ad.postings.updated: triggered when the postings of a job ad were updated, including job ad being published or unpublished job.created: triggered when a job was created job.hiring-team.updated: triggered when the hiring team was updated on a job job.status.updated: triggered when the status of a job was updated job.updated: triggered when a job was updated offer.created: triggered when an offer was created offer.updated: triggered when an offer was updated Not covered: screening questions were updated for a job |
    | Automatic Setup                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    | Scope Testing                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    | Delta Syncs                    |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    | Custom Field Explorer          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    | Candidates                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    | Source Writing                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    | Sync Only Created Applications |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    | Connection Guide               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    | Prerequisites                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    | Candidate source tracking      |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    | Candidate Cutoff Filtering     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    | Roles                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    | System roles (e.g. Admin)      | Each user has **systemRole.id**; Kombo stores that value on the role. Custom ids use the name from the synced system-roles resource when available, otherwise the raw id.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |

    * **ADMINISTRATOR** maps to unified type `ADMIN`
    * **EMPLOYEE**, **STANDARD**, and **EXTENDED** have no unified type
    * **RESTRICTED** corresponds to the Basic role in the SmartRecruiters UI and has no unified type
    * Any other **systemRole.id** follows the custom-role lookup above and has no unified type. |
      \|   Job roles (e.g. Hiring Manager) | Smartrecruiters exposes a list of hiring team members with a specific role
    * **HIRING\_MANAGER** (shown as "Hiring Manager" in the UI) maps to unified type `HIRING_MANAGER`
    * **RECRUITER** (shown as "Recruiter" in the UI) maps to unified type `RECRUITER`
    * **INTERVIEW\_TEAM** (shown as "Interviewer" in the UI) maps to unified type `INTERVIEWER`
    * **COORDINATOR** (shown as "Coordinator" in the UI) maps to unified type `COORDINATOR`
    * **EXECUTIVE** (shown as "Executive" in the UI) has no unified type
    * Other role values (often a custom id) have no unified type |
      \| EEO Questions |  |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** SmartRecruiters

For **SmartRecruiters**, we also offer the following other connector variants:

<CardGroup>
  <Card title="SmartRecruiters Assessment" icon="https://storage.googleapis.com/kombo-assets/integrations/smartrecruiters/icon.svg" href="/assessment/connectors/smartrecruiters">
    SmartRecruiters for the Assessment category
  </Card>
</CardGroup>


# Softgarden ATS Integration
Source: https://docs.kombo.dev/ats/connectors/softgarden

Softgarden connector for Kombo's ATS API

The Softgarden ATS integration allows you to sync ATS data between Softgarden and your application through Kombo's unified API. The tool slug for this connector is `softgarden`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/30574515999249-Softgarden-How-do-I-link-my-account-New-Design">
    Step-by-step instructions to connect your Softgarden account to Kombo.
  </Card>

  <Card title="Source Setup Guide" icon="settings" href="https://help.kombo.dev/hc/en-us/articles/30574515999249-Softgarden-How-do-I-link-my-account-New-Design#:~:text=Set%20up%20source%20writing%20(conditional)">
    Learn how to set up candidate sources in Softgarden.
  </Card>

  <Card title="Connection guide (old design)" icon="book" href="https://help.kombo.dev/hc/en-us/articles/17889584793745">
    Additional documentation and guides for Softgarden.
  </Card>

  <Card title="Source setup guide (old design)" icon="book" href="https://help.kombo.dev/hc/en-us/articles/27756023403025">
    Additional documentation and guides for Softgarden.
  </Card>
</CardGroup>

## General Notes

* Softgarden does not support reading or interacting with candidates.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | job\_code           |       |
      | description         |       |
      | employment\_type    |       |
      | status              |       |
      | visibility          |       |
      | category            |       |
      | post\_url           |       |
      | experience\_level   |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | opened\_at          |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | contact\_id         |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      <Note>
        We can only retrieve application stages from applications. That means, unless an application that we fetch is in a given stage, we won't return that stage on the API. This is a limitation of the Softgarden API.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Applications">
      <Note>
        Softgarden only allows reading applications that were created through the Kombo API.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | remote\_url         |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.gender                          |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.gender                          |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Custom Field Explorer          |       |
    | Jobs                           |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
    | Prerequisites                  |       |
    | Create credentials             |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Choose this variant if you want to use the regular Softgarden API

For **Softgarden**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Softgarden Partner" icon="https://storage.googleapis.com/kombo-assets/integrations/softgardenpartner/icon.svg" href="/ats/connectors/softgardenpartner">
    Choose this variant if you are a Softgarden partner and want to use the XML feed API
  </Card>
</CardGroup>

<Note>Multiple variants can be used within your Kombo environment at the same time.</Note>


# Softgarden Partner ATS Integration
Source: https://docs.kombo.dev/ats/connectors/softgardenpartner

Softgarden Partner connector for Kombo's ATS API

The Softgarden Partner ATS integration allows you to sync ATS data between Softgarden Partner and your application through Kombo's unified API. The tool slug for this connector is `softgardenpartner`.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | experience\_level    |       |
      | remote\_work\_status |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.gender                          |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.gender                          |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature        | Notes |
    | -------------- | ----- |
    | Source Writing |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Choose this variant if you are a Softgarden partner and want to use the XML feed API

For **Softgarden Partner**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Softgarden" icon="https://storage.googleapis.com/kombo-assets/integrations/softgarden/icon.svg" href="/ats/connectors/softgarden">
    Choose this variant if you want to use the regular Softgarden API
  </Card>
</CardGroup>

<Note>Multiple variants can be used within your Kombo environment at the same time.</Note>


# Spott ATS Integration
Source: https://docs.kombo.dev/ats/connectors/spott

Spott connector for Kombo's ATS API

The Spott ATS integration allows you to sync ATS data between Spott and your application through Kombo's unified API. The tool slug for this connector is `spott`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/43473593479185-Spott-How-do-I-link-my-account">
    Step-by-step instructions to connect your Spott account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | email               |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | remote\_work\_status |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                                           | Notes |
      | ----------------------------------------------------- | ----- |
      | candidate.first\_name                                 |       |
      | candidate.last\_name                                  |       |
      | candidate.email\_address                              |       |
      | candidate.additional\_email\_addresses.type           |       |
      | candidate.additional\_email\_addresses.email\_address |       |
      | candidate.phone\_number                               |       |
      | candidate.additional\_phone\_numbers.type             |       |
      | candidate.additional\_phone\_numbers.phone\_number    |       |
      | candidate.location.city                               |       |
      | candidate.location.country                            |       |
      | candidate.location.state                              |       |
      | candidate.location.street\_1                          |       |
      | candidate.location.zip\_code                          |       |
      | candidate.gender                                      |       |
      | candidate.social\_links.url                           |       |
      | application.job\_id                                   |       |
      | application.stage\_id                                 |       |
      | attachments.name                                      |       |
      | attachments.content\_type                             |       |
      | attachments.data\_url                                 |       |
      | attachments.data                                      |       |
      | attachments.type                                      |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                                           | Notes |
      | ----------------------------------------------------- | ----- |
      | candidate.first\_name                                 |       |
      | candidate.last\_name                                  |       |
      | candidate.email\_address                              |       |
      | candidate.additional\_email\_addresses.type           |       |
      | candidate.additional\_email\_addresses.email\_address |       |
      | candidate.phone\_number                               |       |
      | candidate.additional\_phone\_numbers.type             |       |
      | candidate.additional\_phone\_numbers.phone\_number    |       |
      | candidate.location.city                               |       |
      | candidate.location.country                            |       |
      | candidate.location.state                              |       |
      | candidate.location.street\_1                          |       |
      | candidate.location.zip\_code                          |       |
      | candidate.gender                                      |       |
      | candidate.social\_links.url                           |       |
      | application.job\_id                                   |       |
      | application.stage\_id                                 |       |
      | attachments.name                                      |       |
      | attachments.content\_type                             |       |
      | attachments.data\_url                                 |       |
      | attachments.data                                      |       |
      | attachments.type                                      |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
  </Tab>
</Tabs>


# SAP SuccessFactors ATS Integration
Source: https://docs.kombo.dev/ats/connectors/successfactors

SAP SuccessFactors connector for Kombo's ATS API

The SAP SuccessFactors ATS integration allows you to sync ATS data between SAP SuccessFactors and your application through Kombo's unified API. The tool slug for this connector is `successfactors`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/16225034050961-How-do-I-link-my-SAP-SuccessFactors-account-">
    Step-by-step instructions to connect your SAP SuccessFactors account to Kombo.
  </Card>

  <Card title="Source Setup Guide" icon="settings" href="https://help.kombo.dev/hc/en-us/articles/19963566832145">
    Learn how to set up candidate sources in SAP SuccessFactors.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22582061339409-Successfactors-How-to-view-a-candidates-source">
    How to view and manage candidate sources in SAP SuccessFactors.
  </Card>
</CardGroup>

## General Notes

* For detailed **job location** data, you need the *"Employee Central API: Employee Central Foundation OData API"* permission, which provides access to general data such as locations and legal entities.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      <Note>
        Access to specific job locations requires the additional permission, "Employee Central API: Employee Central Foundation OData API" to be granted. The post\_url is generated by Kombo and will redirect the candidate to the relevant job posting application page. In some cases, the candidate will instead be redirected by SuccessFactors to a log in page, as some career sites require account creation first.
      </Note>

      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | weekly\_hours        |       |
      | status               |       |
      | visibility           |       |
      | post\_url            |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Job postings">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description\_html   |       |
      | status              |       |
      | visibility          |       |
      | job\_id             |       |
      | remote\_data        |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | title               |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                        | Notes |
      | ---------------------------- | ----- |
      | id                           |       |
      | remote\_id                   |       |
      | changed\_at                  |       |
      | remote\_deleted\_at          |       |
      | outcome                      |       |
      | current\_stage\_id           |       |
      | job\_id                      |       |
      | candidate\_id                |       |
      | screening\_question\_answers |       |
      | custom\_fields               |       |
      | integration\_fields          |       |
      | remote\_updated\_at          |       |
      | remote\_data                 |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Interviews">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | starting\_at        |       |
      | ending\_at          |       |
      | application\_id     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        SuccessFactors requisition exposes 5 types of roles for a job

        * **hiringManager** (shown as "Hiring Manager" in the UI) maps to `HIRING_MANAGER`
        * **hiringManagerTeam** (shown as "Hiring Manager Team" in the UI) maps to `HIRING_MANAGER`
        * **recruiter** (shown as "Recruiter" in the UI) maps to `RECRUITER`
        * **recruiterTeam** (shown as "Recruiting Team" in the UI) maps to `RECRUITER`
        * Users from **Recruiting Team** are only included when the include\_recruiting\_team\_in\_hiring\_team setting is enabled.
        * **currentOwner** has no unified type
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Interviewing team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | interview\_id       |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.street\_1              |       |
      | candidate.location.zip\_code              |       |
      | candidate.gender                          |       |
      | candidate.availability\_date              |       |
      | candidate.salary\_expectations.period     |       |
      | candidate.salary\_expectations.amount     |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.street\_1              |       |
      | candidate.location.zip\_code              |       |
      | candidate.gender                          |       |
      | candidate.availability\_date              |       |
      | candidate.salary\_expectations.period     |       |
      | candidate.salary\_expectations.amount     |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>

    <Accordion title="Add tag to candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Remove tag from candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      <Note>
        It is only possible to move applications to stages where there is at least 1 application already. This means you have to manually move at least 1 application into the stage first and then move an application into that stage via the Kombo API.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Reject application">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | application\_id       |       |
      | rejection\_reason\_id |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      <Note>
        Comment limit for SuccessFactors is 4000 characters.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Add result link to candidate">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | candidate\_id                       |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                                | Notes                                                         |
    | -------------------------------------- | ------------------------------------------------------------- |
    | API Passthrough                        |                                                               |
    | Additional Scopes                      |                                                               |
    | Scope Testing                          |                                                               |
    | Delta Syncs                            |                                                               |
    | Custom Field Explorer                  |                                                               |
    | Jobs                                   |                                                               |
    | Candidates                             |                                                               |
    | Source Writing                         |                                                               |
    | Sync Only Created Applications         |                                                               |
    | Connection Guide                       |                                                               |
    | Prerequisites                          |                                                               |
    | Create credentials                     |                                                               |
    | Candidate source tracking              |                                                               |
    | Create Candidate Full Attachment Retry |                                                               |
    | Roles                                  |                                                               |
    | Job roles (e.g. Hiring Manager)        | SuccessFactors requisition exposes 5 types of roles for a job |

    * **hiringManager** (shown as "Hiring Manager" in the UI) maps to `HIRING_MANAGER`
    * **hiringManagerTeam** (shown as "Hiring Manager Team" in the UI) maps to `HIRING_MANAGER`
    * **recruiter** (shown as "Recruiter" in the UI) maps to `RECRUITER`
    * **recruiterTeam** (shown as "Recruiting Team" in the UI) maps to `RECRUITER`
    * Users from **Recruiting Team** are only included when the include\_recruiting\_team\_in\_hiring\_team setting is enabled.
    * **currentOwner** has no unified type |
      \| EEO Questions | EEO data is typically collected through Job Application Templates. Contact our support team for guidance on setting this up. We are unable to automatically detect which questions are EEO-related. As a result, EEO questions will have a category of `null`. |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** SAP SuccessFactors

For **SAP SuccessFactors**, we also offer the following other connector variants:

<CardGroup>
  <Card title="SAP SuccessFactors Assessment" icon="https://storage.googleapis.com/kombo-assets/integrations/successfactors/icon.svg" href="/assessment/connectors/successfactors">
    SAP SuccessFactors for the Assessment category
  </Card>

  <Card title="SAP SuccessFactors HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/successfactors/icon.svg" href="/hris/connectors/successfactors">
    SAP SuccessFactors for the HRIS category
  </Card>

  <Card title="SAP SuccessFactors LMS" icon="https://storage.googleapis.com/kombo-assets/integrations/successfactors/icon.svg" href="/lms/connectors/successfactors">
    SAP SuccessFactors for the LMS category
  </Card>
</CardGroup>


# Taleez ATS Integration
Source: https://docs.kombo.dev/ats/connectors/taleez

Taleez connector for Kombo's ATS API

The Taleez ATS integration allows you to sync ATS data between Taleez and your application through Kombo's unified API. The tool slug for this connector is `taleez`.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | description         |       |
      | weekly\_hours       |       |
      | employment\_type    |       |
      | status              |       |
      | visibility          |       |
      | post\_url           |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | opened\_at          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      <Note>
        Applications can reference jobs that were deleted from GET /jobs and stages that were only synced with those jobs. Such applications are still ingested, but their job\_id and current\_stage\_id relations may be left dangling.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
  </Tab>
</Tabs>


# Talent360 ATS Integration
Source: https://docs.kombo.dev/ats/connectors/talent360

Talent360 connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Talent360 ATS integration allows you to sync ATS data between Talent360 and your application through Kombo's unified API. The tool slug for this connector is `talent360`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/49306083738001-Talent360-How-do-I-link-my-account">
    Step-by-step instructions to connect your Talent360 account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | description          |       |
      | weekly\_hours        |       |
      | employment\_type     |       |
      | status               |       |
      | post\_url            |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      <Note>
        Talent360 stores source per application; we use the first source we find as the candidate `source`.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | status              |       |
    </Accordion>

    <Accordion title="Applications">
      <Note>
        Talent360 tracks a single status per candidate rather than per application, so all applications of the same candidate share the same `current_stage_id` and `outcome`. When a candidate is Hired or Rejected, every one of their applications is marked `HIRED` or `DECLINED`.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        Talent360 job ads expose a single "responsible recruiter" per ad.

        * The **responsible recruiter** maps to `RECRUITER`.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Add attachment to application">
      <Note>
        Talent360 has no application-level file store, so attachments are stored on the underlying candidate as "application" (Bewerbung) documents, regardless of the attachment type.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      <Note>
        Talent360 only supports moving applications to the "Qualified", "Hired" or "Rejected" stages. The early-funnel stages ("New", "Contacted" and "Interview") are read-only and cannot be set via the API. Talent360 tracks a single status per candidate rather than per application, so moving one application also moves the candidate's other applications to the same stage.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Add result link to application">
      <Note>
        Talent360 has no dedicated result-link field, so the link is added as an internal note (communication) on the candidate: the label becomes the note subject and the URL is the note body. Requires `remote_fields.talent360.user_id` because every Talent360 communication must be attributed to a user.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | label           |       |
      | url             |       |
    </Accordion>

    <Accordion title="Add note to application">
      <Note>
        Talent360 stores notes on the candidate as an internal communication, not on a specific application. Requires `remote_fields.talent360.user_id` because every Talent360 communication must be attributed to a user.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      <Note>
        Talent360 has no application-level file store, so all documents live on the candidate. Reading an application's attachments therefore returns every document attached to the underlying candidate.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      <Note>
        Talent360 stores documents on the candidate (not per application), so every returned attachment has a null `application_id`.
      </Note>

      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>

    <Accordion title="Add result link to candidate">
      <Note>
        Talent360 has no dedicated result-link field, so the link is added as an internal note (communication) on the candidate: the label becomes the note subject and the URL is the note body. Requires `remote_fields.talent360.user_id` because every Talent360 communication must be attributed to a user.
      </Note>

      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | label         |       |
      | url           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                         | Notes                                                             |
    | ------------------------------- | ----------------------------------------------------------------- |
    | Sync Only Created Applications  |                                                                   |
    | Connection Guide                |                                                                   |
    | Roles                           |                                                                   |
    | Job roles (e.g. Hiring Manager) | Talent360 job ads expose a single "responsible recruiter" per ad. |

    * The **responsible recruiter** maps to `RECRUITER`. |
  </Tab>
</Tabs>


# TalentAdore ATS Integration
Source: https://docs.kombo.dev/ats/connectors/talentadore

TalentAdore connector for Kombo's ATS API

The TalentAdore ATS integration allows you to sync ATS data between TalentAdore and your application through Kombo's unified API. The tool slug for this connector is `talentadore`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/25405971093009-TalentAdore-How-do-I-link-my-account">
    Step-by-step instructions to connect your TalentAdore account to Kombo.
  </Card>
</CardGroup>

## General Notes

* TalentAdore does not expose reading candidates or applications via API. We therefore only show information created using this integration.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | description         |       |
      | status              |       |
      | department          |       |
      | post\_url           |       |
      | location            |       |
      | remote\_updated\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | Connection Guide   |       |
    | Create credentials |       |
  </Tab>
</Tabs>


# Talent Clue ATS Integration
Source: https://docs.kombo.dev/ats/connectors/talentclue

Talent Clue connector for Kombo's ATS API

The Talent Clue ATS integration allows you to sync ATS data between Talent Clue and your application through Kombo's unified API. The tool slug for this connector is `talentclue`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/25732431896209-TalentClue-How-do-I-link-my-account">
    Step-by-step instructions to connect your Talent Clue account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | description          |       |
      | weekly\_hours        |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | category             |       |
      | department           |       |
      | post\_url            |       |
      | experience\_level    |       |
      | remote\_work\_status |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_data         |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                 | Notes |
      | --------------------------- | ----- |
      | candidate.first\_name       |       |
      | candidate.last\_name        |       |
      | candidate.email\_address    |       |
      | candidate.title             |       |
      | candidate.phone\_number     |       |
      | candidate.location.city     |       |
      | candidate.location.country  |       |
      | candidate.social\_links.url |       |
      | application.job\_id         |       |
      | attachments.name            |       |
      | attachments.content\_type   |       |
      | attachments.data\_url       |       |
      | attachments.data            |       |
      | attachments.type            |       |
      | source.name                 |       |
      | source.unified\_key         |       |
      | source.id                   |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                 | Notes |
      | --------------------------- | ----- |
      | candidate.first\_name       |       |
      | candidate.last\_name        |       |
      | candidate.email\_address    |       |
      | candidate.title             |       |
      | candidate.phone\_number     |       |
      | candidate.location.city     |       |
      | candidate.location.country  |       |
      | candidate.social\_links.url |       |
      | application.job\_id         |       |
      | attachments.name            |       |
      | attachments.content\_type   |       |
      | attachments.data\_url       |       |
      | attachments.data            |       |
      | attachments.type            |       |
      | source.name                 |       |
      | source.unified\_key         |       |
      | source.id                   |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
    | Create credentials             |       |
  </Tab>
</Tabs>


# Talention ATS Integration
Source: https://docs.kombo.dev/ats/connectors/talention

Talention connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Talention ATS integration allows you to sync ATS data between Talention and your application through Kombo's unified API. The tool slug for this connector is `talention`.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | description         |       |
      | status              |       |
      | visibility          |       |
      | post\_url           |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | opened\_at          |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email\_addresses    |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field               | Notes |
      | ------------------------- | ----- |
      | candidate.first\_name     |       |
      | candidate.last\_name      |       |
      | candidate.email\_address  |       |
      | candidate.gender          |       |
      | application.job\_id       |       |
      | attachments.name          |       |
      | attachments.content\_type |       |
      | attachments.data\_url     |       |
      | attachments.data          |       |
      | attachments.type          |       |
      | gdpr\_consent.given       |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field               | Notes |
      | ------------------------- | ----- |
      | candidate.first\_name     |       |
      | candidate.last\_name      |       |
      | candidate.email\_address  |       |
      | candidate.gender          |       |
      | application.job\_id       |       |
      | attachments.name          |       |
      | attachments.content\_type |       |
      | attachments.data\_url     |       |
      | attachments.data          |       |
      | attachments.type          |       |
      | gdpr\_consent.given       |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Scope Testing                  |       |
    | Per Model Tests                |       |
    | Delta Syncs                    |       |
    | Custom Field Explorer          |       |
    | Jobs                           |       |
    | Sync Only Created Applications |       |
  </Tab>
</Tabs>


# CEGID TalentSoft FrontOffice ATS Integration
Source: https://docs.kombo.dev/ats/connectors/talentsoft

CEGID TalentSoft FrontOffice connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The CEGID TalentSoft FrontOffice ATS integration allows you to sync ATS data between CEGID TalentSoft FrontOffice and your application through Kombo's unified API. The tool slug for this connector is `talentsoft`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/19934224391313">
    Step-by-step instructions to connect your CEGID TalentSoft FrontOffice account to Kombo.
  </Card>

  <Card title="Source Setup Guide" icon="settings" href="https://help.kombo.dev/hc/en-us/articles/20463780412561">
    Learn how to set up candidate sources in CEGID TalentSoft FrontOffice.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | description         |       |
      | employment\_type    |       |
      | status              |       |
      | visibility          |       |
      | department          |       |
      | post\_url           |       |
      | experience\_level   |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | opened\_at          |       |
      | closed\_at          |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      <Note>
        With TalentSoft's FrontOffice API, Kombo is only able to read applications that were created by Kombo. We are therefore only able to read application stages that we've previously encountered.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Applications">
      <Note>
        With TalentSoft's FrontOffice API, Kombo is only able to read applications that were created by Kombo. As reading applications is enabled by using the candidate's email, it is required for candidate emails to be in scope for Kombo to be able to read applications.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | remote\_created\_at |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | required            |       |
      | job\_id             |       |
      | question\_id        |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Company names longer than 50 characters will be truncated
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.gender                          |       |
      | candidate.availability\_date              |       |
      | candidate.salary\_expectations.amount     |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Company names longer than 50 characters will be truncated
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.gender                          |       |
      | candidate.availability\_date              |       |
      | candidate.salary\_expectations.amount     |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                   | Notes |
    | ------------------------- | ----- |
    | API Passthrough           |       |
    | Custom Field Explorer     |       |
    | Jobs                      |       |
    | Connection Guide          |       |
    | Prerequisites             |       |
    | Candidate source tracking |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** This variant is generally the right choice for you, if you are a job board or looking to primarily read jobs, read screening questions, and create applications (e.g. with an application source and screening question answers). It is the right choice for the vast majority of cases.

For **CEGID TalentSoft FrontOffice**, we also offer the following other connector variants:

<CardGroup>
  <Card title="CEGID TalentSoft Customer" icon="https://storage.googleapis.com/kombo-assets/integrations/talentsoftcustomer/icon.svg" href="/ats/connectors/talentsoftcustomer">
    This variant should only be used if the FrontOffice variant does not offer sufficient functionality, or if you have use cases that fall outside of what's covered by the FrontOffice variant (e.g. specific use cases less common to job boards)
  </Card>
</CardGroup>

<Note>You can only use one variant at a time.</Note>


# CEGID TalentSoft Customer ATS Integration
Source: https://docs.kombo.dev/ats/connectors/talentsoftcustomer

CEGID TalentSoft Customer connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The CEGID TalentSoft Customer ATS integration allows you to sync ATS data between CEGID TalentSoft Customer and your application through Kombo's unified API. The tool slug for this connector is `talentsoftcustomer`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/23625547686033">
    Step-by-step instructions to connect your CEGID TalentSoft Customer account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | description         |       |
      | employment\_type    |       |
      | status              |       |
      | visibility          |       |
      | department          |       |
      | experience\_level   |       |
      | location            |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | title               |       |
      | confidential        |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Add result link to application">
      <Note>
        As a workaround, we store the result link in the `middleName` field. Please contact support if you wish to use this feature.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | url             |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Delta Syncs                    |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
    | Prerequisites                  |       |
    | Candidate Cutoff Filtering     |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** This variant should only be used if the FrontOffice variant does not offer sufficient functionality, or if you have use cases that fall outside of what's covered by the FrontOffice variant (e.g. specific use cases less common to job boards)

For **CEGID TalentSoft Customer**, we also offer the following other connector variants:

<CardGroup>
  <Card title="CEGID TalentSoft FrontOffice" icon="https://storage.googleapis.com/kombo-assets/integrations/talentsoft/icon.svg" href="/ats/connectors/talentsoft">
    This variant is generally the right choice for you, if you are a job board or looking to primarily read jobs, read screening questions, and create applications (e.g. with an application source and screening question answers). It is the right choice for the vast majority of cases.
  </Card>
</CardGroup>

<Note>You can only use one variant at a time.</Note>


# Oracle Taleo ATS Integration
Source: https://docs.kombo.dev/ats/connectors/taleo

Oracle Taleo connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Oracle Taleo ATS integration allows you to sync ATS data between Oracle Taleo and your application through Kombo's unified API. The tool slug for this connector is `taleo`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/35647853928593-Oracle-Taleo-How-do-I-link-my-account">
    Step-by-step instructions to connect your Oracle Taleo account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | status              |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | job\_code           |       |
      | description         |       |
      | status              |       |
      | category            |       |
      | department          |       |
      | post\_url           |       |
      | salary\_currency    |       |
      | salary\_period      |       |
      | location            |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                        | Notes |
      | ---------------------------- | ----- |
      | id                           |       |
      | remote\_id                   |       |
      | changed\_at                  |       |
      | remote\_deleted\_at          |       |
      | outcome                      |       |
      | current\_stage\_id           |       |
      | job\_id                      |       |
      | candidate\_id                |       |
      | screening\_question\_answers |       |
      | remote\_updated\_at          |       |
    </Accordion>

    <Accordion title="Screening questions">
      <Note>
        Screening questions are always marked as not required, since on the API, there is no indication of whether they are required or not. In our testing, submissions were successful while submitting no questions.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
      | category            |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        Taleo requisition exposes the following roles

        * **HiringManager** (shown as "Hiring Manager" in the UI) maps to unified type `HIRING_MANAGER`
        * **HiringManagerAssistant** (shown as "Hiring Manager Assistant" in the UI) has no unified type
        * **RecruiterAssistant** (shown as "Recruiter Assistant" in the UI) has no unified type
        * **Collaborators** entries (shown as "Collaborator" in the UI) have no unified type
        * Recruiter is currently unavailable
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.zip\_code              |       |
      | candidate.availability\_date              |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.zip\_code              |       |
      | candidate.availability\_date              |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      <Note>
        The endpoint we are using returns the attachments of all applications of a candidate. It however does not return the ID/Number of the applications.
      </Note>

      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                         | Notes                                         |
    | ------------------------------- | --------------------------------------------- |
    | API Passthrough                 |                                               |
    | Scope Testing                   |                                               |
    | Source Writing                  |                                               |
    | Sync Only Created Applications  |                                               |
    | Connection Guide                |                                               |
    | Roles                           |                                               |
    | Job roles (e.g. Hiring Manager) | Taleo requisition exposes the following roles |

    * **HiringManager** (shown as "Hiring Manager" in the UI) maps to unified type `HIRING_MANAGER`
    * **HiringManagerAssistant** (shown as "Hiring Manager Assistant" in the UI) has no unified type
    * **RecruiterAssistant** (shown as "Recruiter Assistant" in the UI) has no unified type
    * **Collaborators** entries (shown as "Collaborator" in the UI) have no unified type
    * Recruiter is currently unavailable |
      \| EEO Questions | We support EEO questions |
  </Tab>
</Tabs>


# Teamtailor ATS Integration
Source: https://docs.kombo.dev/ats/connectors/teamtailor

Teamtailor connector for Kombo's ATS API

The Teamtailor ATS integration allows you to sync ATS data between Teamtailor and your application through Kombo's unified API. The tool slug for this connector is `teamtailor`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/17658089783185">
    Step-by-step instructions to connect your Teamtailor account to Kombo.
  </Card>

  <Card title="Sandbox Environment" icon="flask" href="https://tt.teamtailor.com/users/new?locale=en">
    Access the Teamtailor sandbox environment for testing and development.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22529285720337-Teamtailor-How-to-view-a-candidates-source">
    How to view and manage candidate sources in Teamtailor.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | department           |       |
      | post\_url            |       |
      | experience\_level    |       |
      | remote\_work\_status |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_url          |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Job postings">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description\_html   |       |
      | status              |       |
      | visibility          |       |
      | job\_id             |       |
      | remote\_data        |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
    </Accordion>

    <Accordion title="Candidates">
      <Note>
        We only expose one location per candidate.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | confidential        |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                        | Notes |
      | ---------------------------- | ----- |
      | id                           |       |
      | remote\_id                   |       |
      | changed\_at                  |       |
      | remote\_deleted\_at          |       |
      | outcome                      |       |
      | rejection\_reason\_name      |       |
      | rejected\_at                 |       |
      | current\_stage\_id           |       |
      | job\_id                      |       |
      | candidate\_id                |       |
      | screening\_question\_answers |       |
      | custom\_fields               |       |
      | integration\_fields          |       |
      | remote\_url                  |       |
      | remote\_created\_at          |       |
      | remote\_data                 |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Offers">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | status                  |       |
      | employment\_start\_date |       |
      | custom\_fields          |       |
      | integration\_fields     |       |
      | remote\_created\_at     |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        Teamtailor exposes hiring team members via two relations on the job:

        * **user** (shown as "Recruiter" in the UI) maps to unified type `RECRUITER`
        * **team-memberships** exposes 2 types of roles
        * **team-memberships** shown as "External Recruiter" in the UI maps to unified type `RECRUITER`
        * **team-memberships** shown as "Additional Users" in the UI have no unified type
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="User roles">
      <Note>
        Teamtailor exposes each user's **role** attribute

        * **admin** maps to unified type `ADMIN`
        * **recruiter** maps to unified type `RECRUITER`
        * **external\_recruiter** maps to unified type `RECRUITER`
        * Any other **role** value has no unified type.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | user\_id            |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        It is not possible to answer screening questions of type 'file' via the Teamtailor API. The submitted answers will be uploaded as other attachments instead. Teamtailor only supports LinkedIn as a social link. Other links will be ignored.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        It is not possible to answer screening questions of type 'file' via the Teamtailor API. The submitted answers will be uploaded as other attachments instead. Teamtailor only supports LinkedIn as a social link. Other links will be ignored.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>

    <Accordion title="Add tag to candidate">
      <Note>
        Parallel use of this action is not recommended for Teamtailor.
      </Note>

      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Remove tag from candidate">
      <Note>
        Parallel use of this action is not recommended for Teamtailor.
      </Note>

      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        It's not possible to add new "CV"s. Every CV attachment that is added will have type "other" inside TeamTailor. This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Reject application">
      <Note>
        When rejecting an application, Teamtailor shows it as rejected by "Deleted User" in the API. You can however specify a user id under remote\_fields.teamtailor.user\_id to provide an author for the note behind the rejection.
      </Note>

      | Input Field           | Notes |
      | --------------------- | ----- |
      | application\_id       |       |
      | rejection\_reason\_id |       |
      | note                  |       |
    </Accordion>

    <Accordion title="Add result link to application">
      <Note>
        In Teamtailor, we can not write additional details to the result link. We can only write the URL and label.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | label           |       |
      | url             |       |
    </Accordion>

    <Accordion title="Add note to application">
      <Note>
        To write a note, we need to select a valid admin user. We automatically select the first admin user in the system. You can overwrite this by submitting a valid user ID at `remote_fields?.teamtailor?.user_id` to this endpoint.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      <Note>
        It's not possible to add new "CV"s. Every CV attachment that is added will have type "other" inside TeamTailor.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
    </Accordion>

    <Accordion title="Add result link to candidate">
      <Note>
        In Teamtailor, we can not write additional details to the result link. We can only write the URL and label.
      </Note>

      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | label         |       |
      | url           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | API Passthrough                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    | Webhook Subscriptions          | candidate.create: triggered when a candidate was created candidate.update: triggered when a candidate was updated candidate.destroy: triggered when a candidate was deleted job\_application.create: triggered when a job application was created job\_application.update: triggered when a job application was updated including stage changed job\_application.destroy: triggered when a job application was deleted job.create: triggered when a job was created job.destroy: triggered when a job was deleted job.update: triggered when a job was updated including being published or unpublished user.create: triggered when a user with access to the Teamtailor dashboard was created user.destroy: triggered when a user with access to the Teamtailor dashboard was deleted user.update: triggered when a user with access to the Teamtailor dashboard was updated Not covered: a tag was assigned or removed from a candidate Not covered: an interview was scheduled or updated Not covered: screening questions were updated for a job |
    | Scope Testing                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    | Delta Syncs                    |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    | Custom Field Explorer          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    | Jobs                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    | Source Writing                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    | Sync Only Created Applications |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    | Connection Guide               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    | Prerequisites                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    | Create credentials             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    | Candidate Cutoff Filtering     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    | Roles                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    | System roles (e.g. Admin)      | Teamtailor exposes each user's **role** attribute                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |

    * **admin** maps to unified type `ADMIN`
    * **recruiter** maps to unified type `RECRUITER`
    * **external\_recruiter** maps to unified type `RECRUITER`
    * Any other **role** value has no unified type. |
      \|   Job roles (e.g. Hiring Manager) | Teamtailor exposes hiring team members via two relations on the job:
    * **user** (shown as "Recruiter" in the UI) maps to unified type `RECRUITER`
    * **team-memberships** exposes 2 types of roles
    * **team-memberships** shown as "External Recruiter" in the UI maps to unified type `RECRUITER`
    * **team-memberships** shown as "Additional Users" in the UI have no unified type |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Choose this variant if you want to use the full Teamtailor ATS integration with comprehensive read/write capabilities for jobs, candidates, applications, and more

For **Teamtailor**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Teamtailor Job Boards" icon="https://storage.googleapis.com/kombo-assets/integrations/teamtailorjobboards/icon.svg" href="/ats/connectors/teamtailorjobboards">
    Choose this variant if you are a job board partner who wants to receive job postings and send applications to Teamtailor's Job Board API. This variant has limited functionality compared to the full ATS integration but integrations are automatically created when your customer posts a job within Teamtailor.
  </Card>

  <Card title="Teamtailor Assessment" icon="https://storage.googleapis.com/kombo-assets/integrations/teamtailor/icon.svg" href="/assessment/connectors/teamtailor">
    Teamtailor for the Assessment category
  </Card>
</CardGroup>

<Note>Multiple variants can be used within your Kombo environment at the same time.</Note>


# Teamtailor Job Boards ATS Integration
Source: https://docs.kombo.dev/ats/connectors/teamtailorjobboards

Teamtailor Job Boards connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Teamtailor Job Boards ATS integration allows you to sync ATS data between Teamtailor Job Boards and your application through Kombo's unified API. The tool slug for this connector is `teamtailorjobboards`.

## Guides and Resources

<CardGroup>
  <Card title="Partnership Guide" icon="handshake" href="https://support.teamtailor.com/en/articles/7883983-integrate-your-job-board-with-teamtailor">
    Learn how to become a partner with Teamtailor Job Boards to enable this integration.
  </Card>

  <Card title="Sandbox Environment" icon="flask" href="https://teamtailor.notion.site/Integrate-with-Teamtailor-3919690568754aaaa7ffd681afe955f2">
    Access the Teamtailor Job Boards sandbox environment for testing and development.
  </Card>
</CardGroup>

## General Notes

* New integrations are automatically created when Teamtailor sends job webhook data for a company that does not yet have an integration in the environment. Integrations are activated with status "ACTIVE". We recommend listening to the "Integration Created" Webhook event to learn about new integrations.
* This connector has very limited sync capabilities. Only screening questions are synced during regular sync operations. Job data is never synced during regular syncs - only received via webhooks.
* This integration is fundamentally webhook-driven and cannot function without proper webhook setup. All job data comes exclusively from the Teamtailor partner webhooks (POST, PUT, DELETE operations).
* Partner credentials must already exist in the environment for automatic integration creation to work. Each Teamtailor customer can only have one integration per environment as their instance is identified by the company UUID.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      <Note>
        Teamtailor sends us webhooks about updates to the job. Job data is not synced through regular syncs.
      </Note>

      | Field                | Notes                                                                                                                                |
      | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
      | id                   |                                                                                                                                      |
      | changed\_at          |                                                                                                                                      |
      | remote\_deleted\_at  |                                                                                                                                      |
      | name                 |                                                                                                                                      |
      | description          |                                                                                                                                      |
      | employment\_type     |                                                                                                                                      |
      | status               |                                                                                                                                      |
      | visibility           |                                                                                                                                      |
      | department           |                                                                                                                                      |
      | post\_url            |                                                                                                                                      |
      | experience\_level    |                                                                                                                                      |
      | remote\_work\_status |                                                                                                                                      |
      | location             |                                                                                                                                      |
      | custom\_fields       | Recruiters' answers to the configured job-promotion form arrive per job in `webhook-data` and are exposed as mappable custom fields. |
      | opened\_at           |                                                                                                                                      |
      | closed\_at           |                                                                                                                                      |
      | remote\_created\_at  |                                                                                                                                      |
      | remote\_updated\_at  |                                                                                                                                      |
      | remote\_data         |                                                                                                                                      |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
      | category            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.zip\_code              |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.zip\_code              |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes                                                                                                   |
    | --------------------- | ------------------------------------------------------------------------------------------------------- |
    | API Passthrough       |                                                                                                         |
    | Webhook Subscriptions |                                                                                                         |
    | Source Writing        | All candidates created through this integration are automatically associated with your partner channel. |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Choose this variant if you are a job board partner who wants to receive job postings and send applications to Teamtailor's Job Board API. This variant has limited functionality compared to the full ATS integration but integrations are automatically created when your customer posts a job within Teamtailor.

For **Teamtailor Job Boards**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Teamtailor" icon="https://storage.googleapis.com/kombo-assets/integrations/teamtailor/icon.svg" href="/ats/connectors/teamtailor">
    Choose this variant if you want to use the full Teamtailor ATS integration with comprehensive read/write capabilities for jobs, candidates, applications, and more
  </Card>
</CardGroup>

<Note>Multiple variants can be used within your Kombo environment at the same time.</Note>


# TrackerRMS ATS Integration
Source: https://docs.kombo.dev/ats/connectors/trackerrms

TrackerRMS connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The TrackerRMS ATS integration allows you to sync ATS data between TrackerRMS and your application through Kombo's unified API. The tool slug for this connector is `trackerrms`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/48274202710673-TrackerRMS-Guide">
    Step-by-step instructions to connect your TrackerRMS account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | confidential         |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | category             |       |
      | department           |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Job postings">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description\_html   |       |
      | status              |       |
      | visibility          |       |
      | job\_id             |       |
      | remote\_data        |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | outcome                 |       |
      | rejection\_reason\_name |       |
      | current\_stage\_id      |       |
      | job\_id                 |       |
      | candidate\_id           |       |
      | custom\_fields          |       |
      | integration\_fields     |       |
      | remote\_created\_at     |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        TrackerRMS jobs have up to five owner slots (primary through fifth).

        * Each owner has a role (e.g. Account Manager, Recruiter), but the job list API only returns a role id, not its name, so every owner currently maps to remote\_label `Owner` with no unified type.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        TrackerRMS does not sync screening questions, so screening question answers cannot be submitted and are ignored. TrackerRMS has no dedicated cover-letter document type, so cover letters (and other non-CV attachments) are stored as generic "general" documents. Retrying a failed submission with the same candidate email and job resumes the previous attempt instead of creating a duplicate candidate or application.
      </Note>

      | Input Field                                           | Notes |
      | ----------------------------------------------------- | ----- |
      | candidate.first\_name                                 |       |
      | candidate.last\_name                                  |       |
      | candidate.email\_address                              |       |
      | candidate.additional\_email\_addresses.email\_address |       |
      | candidate.title                                       |       |
      | candidate.phone\_number                               |       |
      | candidate.location.city                               |       |
      | candidate.location.country                            |       |
      | candidate.location.state                              |       |
      | candidate.location.street\_1                          |       |
      | candidate.location.zip\_code                          |       |
      | candidate.salary\_expectations.period                 |       |
      | candidate.salary\_expectations.amount                 |       |
      | candidate.social\_links.url                           |       |
      | application.job\_id                                   |       |
      | application.stage\_id                                 |       |
      | attachments.name                                      |       |
      | attachments.data\_url                                 |       |
      | attachments.data                                      |       |
      | attachments.type                                      |       |
      | source.name                                           |       |
      | sourced\_by.user\_id                                  |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        TrackerRMS does not sync screening questions, so screening question answers cannot be submitted and are ignored. TrackerRMS has no dedicated cover-letter document type, so cover letters (and other non-CV attachments) are stored as generic "general" documents. Retrying a failed submission with the same candidate email and job resumes the previous attempt instead of creating a duplicate candidate or application.
      </Note>

      | Input Field                                           | Notes |
      | ----------------------------------------------------- | ----- |
      | candidate.first\_name                                 |       |
      | candidate.last\_name                                  |       |
      | candidate.email\_address                              |       |
      | candidate.additional\_email\_addresses.email\_address |       |
      | candidate.title                                       |       |
      | candidate.phone\_number                               |       |
      | candidate.location.city                               |       |
      | candidate.location.country                            |       |
      | candidate.location.state                              |       |
      | candidate.location.street\_1                          |       |
      | candidate.location.zip\_code                          |       |
      | candidate.salary\_expectations.period                 |       |
      | candidate.salary\_expectations.amount                 |       |
      | candidate.social\_links.url                           |       |
      | application.job\_id                                   |       |
      | application.stage\_id                                 |       |
      | attachments.name                                      |       |
      | attachments.data\_url                                 |       |
      | attachments.data                                      |       |
      | attachments.type                                      |       |
      | source.name                                           |       |
      | sourced\_by.user\_id                                  |       |
    </Accordion>

    <Accordion title="Add tag to candidate">
      <Note>
        TrackerRMS stores a single tag per candidate in one free-text field, so a candidate can only have one tag at a time; adding a tag overwrites any existing tag.
      </Note>

      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Remove tag from candidate">
      <Note>
        TrackerRMS stores a single tag per candidate in one free-text field; the tag is removed by name (case-insensitive).
      </Note>

      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        TrackerRMS stores documents on the candidate rather than the application, so the attachment is added to the application’s candidate and is visible across all of that candidate’s applications. TrackerRMS has no dedicated cover-letter document type, so cover letters (and other non-CV attachments) are stored as generic "general" documents.
      </Note>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | application\_id      |       |
      | attachment.name      |       |
      | attachment.data\_url |       |
      | attachment.data      |       |
      | attachment.type      |       |
    </Accordion>

    <Accordion title="Move application to stage">
      <Note>
        Moving to a stage does not save a rejection note. Use Reject application when you need to attach one.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Reject application">
      <Note>
        If you provide a note, it becomes the rejection reason shown on the application. Otherwise the selected rejection reason name is used.
      </Note>

      | Input Field           | Notes |
      | --------------------- | ----- |
      | application\_id       |       |
      | rejection\_reason\_id |       |
      | note                  |       |
    </Accordion>

    <Accordion title="Add result link to application">
      <Note>
        TrackerRMS has no dedicated result-link field, so the rendered link and its details are appended to the application’s free-text note (alongside any existing note).
      </Note>

      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      <Note>
        TrackerRMS has a single free-text note field per application, so the note is appended to any existing note (including the one set when the candidate was shortlisted) rather than stored as a separate, attributed note.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      <Note>
        TrackerRMS stores documents on the candidate, not the application, so this returns every document of the application’s candidate (they are not application-specific).
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                         | Notes                                                                |
    | ------------------------------- | -------------------------------------------------------------------- |
    | API Passthrough                 |                                                                      |
    | Scope Testing                   |                                                                      |
    | Per Model Tests                 |                                                                      |
    | Delta Syncs                     |                                                                      |
    | Source Writing                  |                                                                      |
    | Connection Guide                |                                                                      |
    | Candidate Cutoff Filtering      |                                                                      |
    | Roles                           |                                                                      |
    | Job roles (e.g. Hiring Manager) | TrackerRMS jobs have up to five owner slots (primary through fifth). |

    * Each owner has a role (e.g. Account Manager, Recruiter), but the job list API only returns a role id, not its name, so every owner currently maps to remote\_label `Owner` with no unified type. |
  </Tab>
</Tabs>


# TRAFFIT ATS Integration
Source: https://docs.kombo.dev/ats/connectors/traffit

TRAFFIT connector for Kombo's ATS API

The TRAFFIT ATS integration allows you to sync ATS data between TRAFFIT and your application through Kombo's unified API. The tool slug for this connector is `traffit`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/18294477201425">
    Step-by-step instructions to connect your TRAFFIT account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field               | Notes                                                                                                                                                                                                           |
      | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
      | id                  |                                                                                                                                                                                                                 |
      | remote\_id          |                                                                                                                                                                                                                 |
      | changed\_at         |                                                                                                                                                                                                                 |
      | remote\_deleted\_at |                                                                                                                                                                                                                 |
      | name                |                                                                                                                                                                                                                 |
      | description         | Only available for recruitments with a currently published advert on the career page. Traffit exposes this content via the public `/public/job_posts/published` endpoint, not on the recruitment record itself. |
      | confidential        |                                                                                                                                                                                                                 |
      | status              |                                                                                                                                                                                                                 |
      | location            | Only available for recruitments with a currently published advert on the career page. Traffit exposes this content via the public `/public/job_posts/published` endpoint, not on the recruitment record itself. |
      | custom\_fields      |                                                                                                                                                                                                                 |
      | integration\_fields |                                                                                                                                                                                                                 |
      | closed\_at          |                                                                                                                                                                                                                 |
      | remote\_created\_at |                                                                                                                                                                                                                 |
      | remote\_data        |                                                                                                                                                                                                                 |
    </Accordion>

    <Accordion title="Job postings">
      <Note>
        Only currently published, public adverts are synced. Traffit exposes these via the `/public/job_posts/published` endpoint. Unpublished or expired adverts will be deleted rather than marked as inactive.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description\_html   |       |
      | status              |       |
      | visibility          |       |
      | url                 |       |
      | job\_id             |       |
      | remote\_data        |       |
      | remote\_created\_at |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                                        | Notes |
      | -------------------------------------------------- | ----- |
      | candidate.first\_name                              |       |
      | candidate.last\_name                               |       |
      | candidate.email\_address                           |       |
      | candidate.phone\_number                            |       |
      | candidate.additional\_phone\_numbers.phone\_number |       |
      | application.job\_id                                |       |
      | application.stage\_id                              |       |
      | attachments.name                                   |       |
      | attachments.content\_type                          |       |
      | attachments.data\_url                              |       |
      | attachments.data                                   |       |
      | attachments.type                                   |       |
      | source.name                                        |       |
      | source.unified\_key                                |       |
      | source.id                                          |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                                        | Notes |
      | -------------------------------------------------- | ----- |
      | candidate.first\_name                              |       |
      | candidate.last\_name                               |       |
      | candidate.email\_address                           |       |
      | candidate.phone\_number                            |       |
      | candidate.additional\_phone\_numbers.phone\_number |       |
      | application.job\_id                                |       |
      | application.stage\_id                              |       |
      | attachments.name                                   |       |
      | attachments.content\_type                          |       |
      | attachments.data\_url                              |       |
      | attachments.data                                   |       |
      | attachments.type                                   |       |
      | source.name                                        |       |
      | source.unified\_key                                |       |
      | source.id                                          |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
    | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | API Passthrough                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    | Webhook Subscriptions          | candidate\_created: triggered when a candidate was created candidate\_deleted: triggered when a candidate was hard-deleted candidate\_soft\_deleted: triggered when a candidate was anonymized (GDPR soft delete) candidate\_merged: triggered when two candidates were merged into one candidate\_applied: triggered when a candidate applied to a job via an application form candidate\_added\_to\_job: triggered when a candidate was manually added to a job by a recruiter candidate\_moved\_in\_job: triggered when an application's workflow stage changed candidate\_hired: triggered when a candidate was moved to the hired stage candidate\_removed\_from\_job: triggered when an application was manually deleted from a job job\_created: triggered when a job was created (published) in Traffit job\_updated: triggered when a job was updated job\_deleted: triggered when a job was deleted (unpublished) in Traffit Not covered: tag assigned to a candidate Not covered: interview scheduled for an application Not covered: interview updated for an application Not covered: screening questions updated on a job Traffit does not sign webhook payloads; Kombo authenticates incoming webhooks via a per-subscription random secret embedded as a `?secret=` query parameter in the registered URL (Traffit-recommended workaround). Not covered: talent pool changes, candidate consents, candidate activity deletions, CRM person/activity events, user deactivation. |
    | Automatic Setup                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    | Scope Testing                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    | Source Writing                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    | Sync Only Created Applications |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    | Connection Guide               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    | Prerequisites                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    | Create credentials             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
  </Tab>
</Tabs>


# Ubeeo ATS Integration
Source: https://docs.kombo.dev/ats/connectors/ubeeo

Ubeeo connector for Kombo's ATS API

The Ubeeo ATS integration allows you to sync ATS data between Ubeeo and your application through Kombo's unified API. The tool slug for this connector is `ubeeo`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/26542631592209-Ubeeo">
    Step-by-step instructions to connect your Ubeeo account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | job\_code           |       |
      | description         |       |
      | weekly\_hours       |       |
      | employment\_type    |       |
      | status              |       |
      | visibility          |       |
      | department          |       |
      | post\_url           |       |
      | experience\_level   |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | opened\_at          |       |
      | contact\_id         |       |
      | remote\_data        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                | Notes |
      | -------------------------- | ----- |
      | candidate.first\_name      |       |
      | candidate.last\_name       |       |
      | candidate.email\_address   |       |
      | candidate.phone\_number    |       |
      | candidate.location.city    |       |
      | candidate.location.country |       |
      | application.job\_id        |       |
      | attachments.name           |       |
      | attachments.content\_type  |       |
      | attachments.data\_url      |       |
      | attachments.data           |       |
      | attachments.type           |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                | Notes |
      | -------------------------- | ----- |
      | candidate.first\_name      |       |
      | candidate.last\_name       |       |
      | candidate.email\_address   |       |
      | candidate.phone\_number    |       |
      | candidate.location.city    |       |
      | candidate.location.country |       |
      | application.job\_id        |       |
      | attachments.name           |       |
      | attachments.content\_type  |       |
      | attachments.data\_url      |       |
      | attachments.data           |       |
      | attachments.type           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                                | Notes |
    | -------------------------------------- | ----- |
    | API Passthrough                        |       |
    | Sync Only Created Applications         |       |
    | Connection Guide                       |       |
    | Create Candidate Full Attachment Retry |       |
  </Tab>
</Tabs>


# UKG Pro ATS Integration
Source: https://docs.kombo.dev/ats/connectors/ukgpro

UKG Pro connector for Kombo's ATS API

The UKG Pro ATS integration allows you to sync ATS data between UKG Pro and your application through Kombo's unified API. The tool slug for this connector is `ukgpro`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/23306033341585-UKG-Pro-Recruiting-ATS-How-do-I-link-my-account">
    Step-by-step instructions to connect your UKG Pro account to Kombo.
  </Card>

  <Card title="Source Setup Guide" icon="settings" href="https://help.kombo.dev/hc/en-us/articles/23313908042769-UKG-Pro-Recruiting-How-to-add-a-candidate-source">
    Learn how to set up candidate sources in UKG Pro.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22578681217425-UKG-Pro-Recruiting-How-to-view-a-candidates-source">
    How to view and manage candidate sources in UKG Pro.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | status              |       |
    </Accordion>

    <Accordion title="Jobs">
      <Note>
        To learn how to manage multilocation jobs, please check [this](https://help.kombo.dev/hc/en-us/articles/32455585787921) guide.
      </Note>

      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | weekly\_hours        |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | category             |       |
      | post\_url            |       |
      | experience\_level    |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_url          |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Job postings">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | status              |       |
      | visibility          |       |
      | url                 |       |
      | job\_id             |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | remote\_url         |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | remote\_url         |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Offers">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | status                  |       |
      | employment\_start\_date |       |
      | application\_id         |       |
      | custom\_fields          |       |
      | integration\_fields     |       |
      | remote\_created\_at     |       |
      | remote\_updated\_at     |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        UKG Pro exposes 2 types of roles for a job

        * **hiring\_manager** (shown as "Hiring Manager" in the UI) maps to unified type `HIRING_MANAGER`
        * **recruiter** (shown as "Recruiter" in the UI) maps to unified type `RECRUITER`
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="User roles">
      <Note>
        UKG Pro exposes a list of system roles for each user

        * **admin** maps to unified type `ADMIN`
        * **recruiter** maps to unified type `RECRUITER`
        * All other values have no unified type.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | user\_id            |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Creating applications requires the screening questions to be answered. Answers to screening questions are rounded to the nearest integer.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.availability\_date              |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Creating applications requires the screening questions to be answered. Answers to screening questions are rounded to the nearest integer.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.availability\_date              |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      <Note>
        An application cannot be moved to a rejected step. You need to use the reject application action, because a rejection reason is required. An application cannot be moved back to the initial step.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Reject application">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | application\_id       |       |
      | rejection\_reason\_id |       |
      | note                  |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>

    <Accordion title="Add result link to candidate">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | candidate\_id                       |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes                                                |
    | ------------------------------ | ---------------------------------------------------- |
    | API Passthrough                |                                                      |
    | Scope Testing                  |                                                      |
    | Per Model Tests                |                                                      |
    | Delta Syncs                    |                                                      |
    | Custom Field Explorer          |                                                      |
    | Jobs                           |                                                      |
    | Source Writing                 |                                                      |
    | Sync Only Created Applications |                                                      |
    | Connection Guide               |                                                      |
    | Candidate source tracking      |                                                      |
    | Candidate Cutoff Filtering     |                                                      |
    | Roles                          |                                                      |
    | System roles (e.g. Admin)      | UKG Pro exposes a list of system roles for each user |

    * **admin** maps to unified type `ADMIN`
    * **recruiter** maps to unified type `RECRUITER`
    * All other values have no unified type. |
      \|   Job roles (e.g. Hiring Manager) | UKG Pro exposes 2 types of roles for a job
    * **hiring\_manager** (shown as "Hiring Manager" in the UI) maps to unified type `HIRING_MANAGER`
    * **recruiter** (shown as "Recruiter" in the UI) maps to unified type `RECRUITER` |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** UKG Pro

For **UKG Pro**, we also offer the following other connector variants:

<CardGroup>
  <Card title="UKG Pro Assessment" icon="https://storage.googleapis.com/kombo-assets/integrations/ukgpro/icon.svg" href="/assessment/connectors/ukgpro">
    UKG Pro for the Assessment category
  </Card>

  <Card title="UKG Pro HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/ukgpro/icon.svg" href="/hris/connectors/ukgpro">
    UKG Pro for the HRIS category
  </Card>
</CardGroup>


# UKG Ready ATS Integration
Source: https://docs.kombo.dev/ats/connectors/ukgready

UKG Ready connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The UKG Ready ATS integration allows you to sync ATS data between UKG Ready and your application through Kombo's unified API. The tool slug for this connector is `ukgready`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/40474524063249">
    Step-by-step instructions to connect your UKG Ready account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      <Note>
        UKG Ready only syncs users that are linked to 1 or more jobs
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      <Note>
        The UKG Ready API only returns publicly visible jobs. Closed jobs are not visible.
      </Note>

      | Field                | Notes                                                                                                                                                                           |
      | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
      | id                   |                                                                                                                                                                                 |
      | remote\_id           |                                                                                                                                                                                 |
      | changed\_at          |                                                                                                                                                                                 |
      | remote\_deleted\_at  |                                                                                                                                                                                 |
      | name                 |                                                                                                                                                                                 |
      | description          |                                                                                                                                                                                 |
      | employment\_type     |                                                                                                                                                                                 |
      | status               | Both filled and open jobs are returned by the UKG Ready API. It does not provide data to distinguish between these statuses. Filled jobs only get removed once they are closed. |
      | visibility           |                                                                                                                                                                                 |
      | category             |                                                                                                                                                                                 |
      | experience\_level    |                                                                                                                                                                                 |
      | remote\_work\_status |                                                                                                                                                                                 |
      | salary\_amount\_from |                                                                                                                                                                                 |
      | salary\_amount\_to   |                                                                                                                                                                                 |
      | salary\_period       |                                                                                                                                                                                 |
      | location             |                                                                                                                                                                                 |
      | custom\_fields       |                                                                                                                                                                                 |
      | integration\_fields  |                                                                                                                                                                                 |
      | remote\_data         |                                                                                                                                                                                 |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | outcome                 |       |
      | rejection\_reason\_name |       |
      | current\_stage\_id      |       |
      | job\_id                 |       |
      | candidate\_id           |       |
      | custom\_fields          |       |
      | integration\_fields     |       |
      | remote\_created\_at     |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        UKG Ready can have up to 3 types of hiring manager per job.

        * Each hiring manager shows in the UI as Hiring Manager 1 | 2 | 3 or a customer-defined **label** and maps to unified type `HIRING_MANAGER`
        * If the **label** contains recruiter (case-insensitive), it maps to unified type `RECRUITER`
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="User roles">
      <Note>
        UKG Ready exposes **security\_profile** (security profile name) for each user

        * **security\_profile** equal to Company Administrator maps to unified type `ADMIN`
        * Any other **security\_profile** has no unified type (including renamed or custom profiles).
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | user\_id            |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.company                     |       |
      | candidate.title                       |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.location.country            |       |
      | candidate.location.state              |       |
      | candidate.location.zip\_code          |       |
      | candidate.gender                      |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.period |       |
      | candidate.salary\_expectations.amount |       |
      | application.job\_id                   |       |
      | application.stage\_id                 |       |
      | attachments.name                      |       |
      | attachments.content\_type             |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | attachments.type                      |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                           | Notes |
      | ------------------------------------- | ----- |
      | candidate.first\_name                 |       |
      | candidate.last\_name                  |       |
      | candidate.email\_address              |       |
      | candidate.company                     |       |
      | candidate.title                       |       |
      | candidate.phone\_number               |       |
      | candidate.location.city               |       |
      | candidate.location.country            |       |
      | candidate.location.state              |       |
      | candidate.location.zip\_code          |       |
      | candidate.gender                      |       |
      | candidate.availability\_date          |       |
      | candidate.salary\_expectations.period |       |
      | candidate.salary\_expectations.amount |       |
      | application.job\_id                   |       |
      | application.stage\_id                 |       |
      | attachments.name                      |       |
      | attachments.content\_type             |       |
      | attachments.data\_url                 |       |
      | attachments.data                      |       |
      | attachments.type                      |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Reject application">
      <Note>
        UKG Ready models rejection reasons as terminated job application statuses.
      </Note>

      | Input Field           | Notes |
      | --------------------- | ----- |
      | application\_id       |       |
      | rejection\_reason\_id |       |
      | note                  |       |
    </Accordion>

    <Accordion title="Add note to application">
      <Note>
        Notes are appended to the internal company comment on the job application, not written to the applicant comment section.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      <Note>
        We only fetch attachments from the CVs endpoint.
      </Note>

      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes                                                                         |
    | ------------------------------ | ----------------------------------------------------------------------------- |
    | API Passthrough                |                                                                               |
    | Scope Testing                  |                                                                               |
    | Per Model Tests                |                                                                               |
    | Delta Syncs                    |                                                                               |
    | Custom Field Explorer          |                                                                               |
    | Jobs                           |                                                                               |
    | Candidates                     |                                                                               |
    | Sync Only Created Applications |                                                                               |
    | Connection Guide               |                                                                               |
    | Roles                          |                                                                               |
    | System roles (e.g. Admin)      | UKG Ready exposes **security\_profile** (security profile name) for each user |

    * **security\_profile** equal to Company Administrator maps to unified type `ADMIN`
    * Any other **security\_profile** has no unified type (including renamed or custom profiles). |
      \|   Job roles (e.g. Hiring Manager) | UKG Ready can have up to 3 types of hiring manager per job.
    * Each hiring manager shows in the UI as Hiring Manager 1 | 2 | 3 or a customer-defined **label** and maps to unified type `HIRING_MANAGER`
    * If the **label** contains recruiter (case-insensitive), it maps to unified type `RECRUITER` |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** UKG Ready

For **UKG Ready**, we also offer the following other connector variants:

<CardGroup>
  <Card title="UKG Ready HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/ukgready/icon.svg" href="/hris/connectors/ukgready">
    UKG Ready for the HRIS category
  </Card>
</CardGroup>


# Haufe Umantis ATS Integration
Source: https://docs.kombo.dev/ats/connectors/umantis

Haufe Umantis connector for Kombo's ATS API

The Haufe Umantis ATS integration allows you to sync ATS data between Haufe Umantis and your application through Kombo's unified API. The tool slug for this connector is `umantis`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/14885789915025">
    Step-by-step instructions to connect your Haufe Umantis account to Kombo.
  </Card>

  <Card title="Source Setup Guide" icon="settings" href="https://help.kombo.dev/hc/en-us/articles/18314081650065">
    Learn how to set up candidate sources in Haufe Umantis.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22562648411537">
    How to view and manage candidate sources in Haufe Umantis.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | description         |       |
      | employment\_type    |       |
      | status              |       |
      | visibility          |       |
      | department          |       |
      | post\_url           |       |
      | experience\_level   |       |
      | salary\_amount      |       |
      | salary\_currency    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | closed\_at          |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Umantis supports uploading at most 14 attachments, not including the CV and cover letter. All additional attachments will be ignored.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.zip\_code              |       |
      | candidate.gender                          |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.expires\_at                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Umantis supports uploading at most 14 attachments, not including the CV and cover letter. All additional attachments will be ignored.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.location.zip\_code              |       |
      | candidate.gender                          |       |
      | application.job\_id                       |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | gdpr\_consent.expires\_at                 |       |
      | gdpr\_consent.given                       |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        Umantis usually only supports uploading PDF attachments by default. Please see this guide to enable other file types: `help.kombo.dev/hc/en-us/articles/23450281362065`
      </Note>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | application\_id      |       |
      | attachment.name      |       |
      | attachment.data\_url |       |
      | attachment.data      |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Reject application">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | application\_id       |       |
      | rejection\_reason\_id |       |
      | note                  |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | label                    |       |
      | url                      |       |
      | details.attributes.key   |       |
      | details.attributes.value |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | API Passthrough                |       |
    | Delta Syncs                    |       |
    | Custom Field Explorer          |       |
    | Jobs                           |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
    | Prerequisites                  |       |
    | Create credentials             |       |
    | Candidate source tracking      |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Legacy Haufe Umantis integration. This variant is deprecated

For **Haufe Umantis**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Abacus Umantis" icon="https://storage.googleapis.com/kombo-assets/integrations/abacusumantis/icon.svg" href="/ats/connectors/abacusumantis">
    Current Umantis integration after Abacus acquisition (recommended)
  </Card>
</CardGroup>

<Note>You can only use one variant at a time.</Note>


# Welcome to the Jungle ATS Integration
Source: https://docs.kombo.dev/ats/connectors/welcometothejungle

Welcome to the Jungle connector for Kombo's ATS API

The Welcome to the Jungle ATS integration allows you to sync ATS data between Welcome to the Jungle and your application through Kombo's unified API. The tool slug for this connector is `welcometothejungle`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/18402550319121">
    Step-by-step instructions to connect your Welcome to the Jungle account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | department           |       |
      | post\_url            |       |
      | experience\_level    |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field               | Notes |
      | ------------------------- | ----- |
      | candidate.first\_name     |       |
      | candidate.last\_name      |       |
      | candidate.email\_address  |       |
      | candidate.title           |       |
      | candidate.phone\_number   |       |
      | application.job\_id       |       |
      | application.stage\_id     |       |
      | attachments.name          |       |
      | attachments.content\_type |       |
      | attachments.data\_url     |       |
      | attachments.data          |       |
      | attachments.type          |       |
      | source.name               |       |
      | source.unified\_key       |       |
      | source.id                 |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field               | Notes |
      | ------------------------- | ----- |
      | candidate.first\_name     |       |
      | candidate.last\_name      |       |
      | candidate.email\_address  |       |
      | candidate.title           |       |
      | candidate.phone\_number   |       |
      | application.job\_id       |       |
      | application.stage\_id     |       |
      | attachments.name          |       |
      | attachments.content\_type |       |
      | attachments.data\_url     |       |
      | attachments.data          |       |
      | attachments.type          |       |
      | source.name               |       |
      | source.unified\_key       |       |
      | source.id                 |       |
    </Accordion>

    <Accordion title="Add tag to candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Remove tag from candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Get application attachments">
      <Note>
        Due to limitations of the API only the candidate's CV/resume can be fetched, the rest of the attachments will be omitted.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      <Note>
        Only the candidate's CV/resume is returned (read from the candidate object). Cover letters and other uploaded documents are not currently included.
      </Note>

      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Add result link to candidate">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | candidate\_id                       |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes |
    | ------------------------------ | ----- |
    | Scope Testing                  |       |
    | Per Model Tests                |       |
    | Source Writing                 |       |
    | Sync Only Created Applications |       |
    | Connection Guide               |       |
    | Prerequisites                  |       |
  </Tab>
</Tabs>


# Workable ATS Integration
Source: https://docs.kombo.dev/ats/connectors/workable

Workable connector for Kombo's ATS API

The Workable ATS integration allows you to sync ATS data between Workable and your application through Kombo's unified API. The tool slug for this connector is `workable`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/17857283748625">
    Step-by-step instructions to connect your Workable account to Kombo.
  </Card>

  <Card title="Sandbox Environment" icon="flask" href="https://www.workable.com/free-trial">
    Access the Workable sandbox environment for testing and development.
  </Card>

  <Card title="Source Setup Guide" icon="settings" href="https://help.kombo.dev/hc/en-us/articles/17077471178769">
    Learn how to set up candidate sources in Workable.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | confidential         |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | category             |       |
      | department           |       |
      | post\_url            |       |
      | experience\_level    |       |
      | remote\_work\_status |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_url          |       |
      | remote\_created\_at  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Job postings">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description\_html   |       |
      | status              |       |
      | visibility          |       |
      | url                 |       |
      | job\_id             |       |
      | remote\_data        |       |
      | remote\_created\_at |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                        | Notes |
      | ---------------------------- | ----- |
      | id                           |       |
      | remote\_id                   |       |
      | changed\_at                  |       |
      | remote\_deleted\_at          |       |
      | outcome                      |       |
      | rejection\_reason\_name      |       |
      | rejected\_at                 |       |
      | current\_stage\_id           |       |
      | job\_id                      |       |
      | candidate\_id                |       |
      | screening\_question\_answers |       |
      | custom\_fields               |       |
      | integration\_fields          |       |
      | remote\_url                  |       |
      | remote\_created\_at          |       |
      | remote\_updated\_at          |       |
      | remote\_data                 |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
    </Accordion>

    <Accordion title="Tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Interviews">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | starting\_at        |       |
      | ending\_at          |       |
      | application\_id     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific application stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | index               |       |
      | job\_id             |       |
      | stage\_id           |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        Workable hiring team uses **jobMembers** (**collaboration\_role**) and **jobRecruiters**

        * **hiring\_manager** (shown as "Hiring Manager" in the UI) maps to unified type `HIRING_MANAGER`
        * **recruiting\_admin** and **recruiter** (shown as "Recruiter" in the UI) map to unified type `RECRUITER`
        * **admin**, **simple**, and **reviewer** have no unified type
        * Unknown **collaboration\_role** values have no unified type
        * Each **jobRecruiters** (shown in the UI as "External Recruiter") entry maps to unified type `RECRUITER`
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="User roles">
      <Note>
        Workable assigns each member a **roles** list of string ids; Kombo ignores entries starting with **hris.**

        * **workable.superadmin** and **ats.admin** map to unified type `ADMIN`
        * **ats.simple**, **ats.reviewer**, and any other **roles** entry have no unified type.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | user\_id            |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Interviewing team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | interview\_id       |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        When `sourced_by` is provided, the `source` is not used.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | sourced\_by.user\_id                      |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        When `sourced_by` is provided, the `source` is not used.
      </Note>

      | Input Field                               | Notes |
      | ----------------------------------------- | ----- |
      | candidate.first\_name                     |       |
      | candidate.last\_name                      |       |
      | candidate.email\_address                  |       |
      | candidate.company                         |       |
      | candidate.title                           |       |
      | candidate.phone\_number                   |       |
      | candidate.location.city                   |       |
      | candidate.location.country                |       |
      | candidate.social\_links.url               |       |
      | application.job\_id                       |       |
      | application.stage\_id                     |       |
      | screening\_question\_answers.question\_id |       |
      | screening\_question\_answers.answer       |       |
      | attachments.name                          |       |
      | attachments.content\_type                 |       |
      | attachments.data\_url                     |       |
      | attachments.data                          |       |
      | attachments.type                          |       |
      | source.name                               |       |
      | source.unified\_key                       |       |
      | source.id                                 |       |
      | sourced\_by.user\_id                      |       |
    </Accordion>

    <Accordion title="Add tag to candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Remove tag from candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      <Note>
        Workable only allows us to upload attachments of non-`CV` by submitting a comment. For non-`CV`s, we will create a comment with the first job admin we find. For the attachment of the type `CV`, we will override the original one, please submit it as `OTHER` if you wish to preserve the original. This action will fall back to the "Add attachment to candidate" action. Therefore, there could be cases where the attachment may not be added to the application but rather to the candidate.
      </Note>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | application\_id      |       |
      | attachment.name      |       |
      | attachment.data\_url |       |
      | attachment.data      |       |
      | attachment.type      |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Reject application">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | application\_id       |       |
      | rejection\_reason\_id |       |
      | note                  |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      <Note>
        Workable only allows us to upload attachments of non-`CV` by submitting a comment. For non-`CV`s, we will create a comment with the first job admin we find. For the attachment of the type `CV`, we will override the original one, please submit it as `OTHER` if you wish to preserve the original.
      </Note>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | candidate\_id        |       |
      | attachment.name      |       |
      | attachment.data\_url |       |
      | attachment.data      |       |
      | attachment.type      |       |
    </Accordion>

    <Accordion title="Add result link to candidate">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | candidate\_id                       |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
    | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | API Passthrough                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    | Webhook Subscriptions          | candidate\_created: triggered when a new candidate was created candidate\_moved: triggered when a candidate was moved to a different stage Not covered: a job was published Not covered: a job was unpublished Not covered: an application stage changed Not covered: a tag was assigned to a candidate Not covered: screening questions were updated for a job Not covered: an interview was scheduled Not covered: an interview was updated Webhooks from Workable do not arrive immediately but are delayed by a few minutes. |
    | Automatic Setup                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    | Scope Testing                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    | Delta Syncs                    |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    | Source Writing                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    | Sync Only Created Applications |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    | Connection Guide               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    | Prerequisites                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    | Create credentials             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    | Candidate source tracking      |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    | Candidate Cutoff Filtering     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    | Roles                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    | System roles (e.g. Admin)      | Workable assigns each member a **roles** list of string ids; Kombo ignores entries starting with **hris.**                                                                                                                                                                                                                                                                                                                                                                                                                       |

    * **workable.superadmin** and **ats.admin** map to unified type `ADMIN`
    * **ats.simple**, **ats.reviewer**, and any other **roles** entry have no unified type. |
      \|   Job roles (e.g. Hiring Manager) | Workable hiring team uses **jobMembers** (**collaboration\_role**) and **jobRecruiters**
    * **hiring\_manager** (shown as "Hiring Manager" in the UI) maps to unified type `HIRING_MANAGER`
    * **recruiting\_admin** and **recruiter** (shown as "Recruiter" in the UI) map to unified type `RECRUITER`
    * **admin**, **simple**, and **reviewer** have no unified type
    * Unknown **collaboration\_role** values have no unified type
    * Each **jobRecruiters** (shown in the UI as "External Recruiter") entry maps to unified type `RECRUITER` |
      \| EEO Questions | Workable automatically sends candidates an email after application to collect EEO data |
  </Tab>
</Tabs>


# Workday ATS Integration
Source: https://docs.kombo.dev/ats/connectors/workday

Workday connector for Kombo's ATS API

The Workday ATS integration allows you to sync ATS data between Workday and your application through Kombo's unified API. The tool slug for this connector is `workday`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/14350938170897">
    Step-by-step instructions to connect your Workday account to Kombo.
  </Card>

  <Card title="Source Setup Guide" icon="settings" href="https://help.kombo.dev/hc/en-us/articles/17073262375185-Workday-How-to-add-a-candidate-source">
    Learn how to set up candidate sources in Workday.
  </Card>

  <Card title="View Candidate Sources" icon="eye" href="https://help.kombo.dev/hc/en-us/articles/22579999612689-Workday-How-to-view-a-candidates-source">
    How to view and manage candidate sources in Workday.
  </Card>

  <Card title="How to set up Job Requisition Custom Fields" icon="book" href="https://help.kombo.dev/hc/en-us/articles/24079912530961-Workday-How-do-I-set-up-custom-fields">
    Additional documentation and guides for Workday.
  </Card>

  <Card title="How to read screening question descriptions via custom report" icon="book" href="https://help.kombo.dev/hc/en-us/articles/24318362976145">
    Additional documentation and guides for Workday.
  </Card>

  <Card title="How to read offers via custom report" icon="book" href="https://help.kombo.dev/hc/en-us/articles/29200835045649">
    Additional documentation and guides for Workday.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | confidential         |       |
      | weekly\_hours        |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | department           |       |
      | post\_url            |       |
      | remote\_work\_status |       |
      | salary\_amount       |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_url          |       |
      | opened\_at           |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Job postings">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description\_html   |       |
      | status              |       |
      | visibility          |       |
      | url                 |       |
      | job\_id             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | confidential        |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Applications">
      | Field                        | Notes |
      | ---------------------------- | ----- |
      | id                           |       |
      | remote\_id                   |       |
      | changed\_at                  |       |
      | remote\_deleted\_at          |       |
      | outcome                      |       |
      | rejection\_reason\_name      |       |
      | rejected\_at                 |       |
      | current\_stage\_id           |       |
      | job\_id                      |       |
      | candidate\_id                |       |
      | screening\_question\_answers |       |
      | custom\_fields               |       |
      | integration\_fields          |       |
      | remote\_url                  |       |
      | remote\_created\_at          |       |
      | remote\_data                 |       |
    </Accordion>

    <Accordion title="Screening questions">
      <Note>
        Workday's API only allows for retrieving screening question's titles, which are often too vague for a candidate to answer. To sync question's descriptions, your customer must [set up a custom report exposing them](https://help.kombo.dev/hc/en-us/articles/24318362976145).
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | description         |       |
      | format              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Interviews">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | starting\_at        |       |
      | ending\_at          |       |
      | application\_id     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Offers">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | status                  |       |
      | employment\_start\_date |       |
      | application\_id         |       |
      | custom\_fields          |       |
      | integration\_fields     |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job-specific screening questions">
      | Field                      | Notes |
      | -------------------------- | ----- |
      | index                      |       |
      | required                   |       |
      | precondition\_question\_id |       |
      | precondition\_options      |       |
      | job\_id                    |       |
      | question\_id               |       |
      | id                         |       |
      | changed\_at                |       |
      | remote\_deleted\_at        |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Interviewing team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | interview\_id       |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                               | Notes                                                                                                                                                              |
      | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
      | candidate.first\_name                     |                                                                                                                                                                    |
      | candidate.last\_name                      |                                                                                                                                                                    |
      | candidate.email\_address                  | Existing worker applications will be rejected unless an employee ID is provided in the remote fields. Please see the remote fields documentation for more details. |
      | candidate.phone\_number                   |                                                                                                                                                                    |
      | candidate.location.city                   |                                                                                                                                                                    |
      | candidate.location.country                |                                                                                                                                                                    |
      | candidate.location.street\_1              |                                                                                                                                                                    |
      | candidate.location.zip\_code              |                                                                                                                                                                    |
      | candidate.social\_links.url               |                                                                                                                                                                    |
      | application.job\_id                       |                                                                                                                                                                    |
      | application.stage\_id                     |                                                                                                                                                                    |
      | screening\_question\_answers.question\_id |                                                                                                                                                                    |
      | screening\_question\_answers.answer       |                                                                                                                                                                    |
      | attachments.name                          |                                                                                                                                                                    |
      | attachments.content\_type                 |                                                                                                                                                                    |
      | attachments.data\_url                     |                                                                                                                                                                    |
      | attachments.data                          |                                                                                                                                                                    |
      | attachments.type                          |                                                                                                                                                                    |
      | source.name                               |                                                                                                                                                                    |
      | source.unified\_key                       |                                                                                                                                                                    |
      | source.id                                 |                                                                                                                                                                    |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                               | Notes                                                                                                                                                              |
      | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
      | candidate.first\_name                     |                                                                                                                                                                    |
      | candidate.last\_name                      |                                                                                                                                                                    |
      | candidate.email\_address                  | Existing worker applications will be rejected unless an employee ID is provided in the remote fields. Please see the remote fields documentation for more details. |
      | candidate.phone\_number                   |                                                                                                                                                                    |
      | candidate.location.city                   |                                                                                                                                                                    |
      | candidate.location.country                |                                                                                                                                                                    |
      | candidate.location.street\_1              |                                                                                                                                                                    |
      | candidate.location.zip\_code              |                                                                                                                                                                    |
      | candidate.social\_links.url               |                                                                                                                                                                    |
      | application.job\_id                       |                                                                                                                                                                    |
      | application.stage\_id                     |                                                                                                                                                                    |
      | screening\_question\_answers.question\_id |                                                                                                                                                                    |
      | screening\_question\_answers.answer       |                                                                                                                                                                    |
      | attachments.name                          |                                                                                                                                                                    |
      | attachments.content\_type                 |                                                                                                                                                                    |
      | attachments.data\_url                     |                                                                                                                                                                    |
      | attachments.data                          |                                                                                                                                                                    |
      | attachments.type                          |                                                                                                                                                                    |
      | source.name                               |                                                                                                                                                                    |
      | source.unified\_key                       |                                                                                                                                                                    |
      | source.id                                 |                                                                                                                                                                    |
    </Accordion>

    <Accordion title="Add tag to candidate">
      <Note>
        We can't create tags, but only assign existing ones. Creating new tags is not supported by the Workday API.
      </Note>

      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Remove tag from candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Reject application">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | application\_id       |       |
      | rejection\_reason\_id |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>

    <Accordion title="Add attachment to candidate">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | candidate\_id            |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Add result link to candidate">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | candidate\_id                       |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                                | Notes                                                           |
    | -------------------------------------- | --------------------------------------------------------------- |
    | API Passthrough                        |                                                                 |
    | Additional Scopes                      |                                                                 |
    | Scope Testing                          |                                                                 |
    | Delta Syncs                            |                                                                 |
    | Custom Field Explorer                  |                                                                 |
    | Jobs                                   |                                                                 |
    | Source Writing                         |                                                                 |
    | Sync Only Created Applications         |                                                                 |
    | Connection Guide                       |                                                                 |
    | Prerequisites                          |                                                                 |
    | Create credentials                     |                                                                 |
    | Candidate source tracking              |                                                                 |
    | Create Candidate Full Attachment Retry |                                                                 |
    | Candidate Cutoff Filtering             |                                                                 |
    | EEO Questions                          | Contact support to enable EEO (and optionally OFCCP) questions. |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Workday

For **Workday**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Workday Assessment" icon="https://storage.googleapis.com/kombo-assets/integrations/workday/icon.svg" href="/assessment/connectors/workday">
    Workday for the Assessment category
  </Card>

  <Card title="Workday HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/workday/icon.svg" href="/hris/connectors/workday">
    Workday for the HRIS category
  </Card>

  <Card title="Workday LMS" icon="https://storage.googleapis.com/kombo-assets/integrations/workday/icon.svg" href="/lms/connectors/workday">
    Workday for the LMS category
  </Card>
</CardGroup>


# Zoho Recruit ATS Integration
Source: https://docs.kombo.dev/ats/connectors/zohorecruit

Zoho Recruit connector for Kombo's ATS API

The Zoho Recruit ATS integration allows you to sync ATS data between Zoho Recruit and your application through Kombo's unified API. The tool slug for this connector is `zohorecruit`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/25672947301777-Zoho-Recruit-How-do-I-link-my-account">
    Step-by-step instructions to connect your Zoho Recruit account to Kombo.
  </Card>
</CardGroup>

## General Notes

* On paid plans, Zoho Recruit allows customizing application stages and statuses. These custom mappings are not available through the public API. We set reasonable standards but adjustments might be required for some connections.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | email               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Jobs">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | category             |       |
      | department           |       |
      | experience\_level    |       |
      | remote\_work\_status |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | contact\_id          |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | company             |       |
      | title               |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | social\_media       |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_url         |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | global\_index       |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Screening questions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Interviews">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | title               |       |
      | starting\_at        |       |
      | ending\_at          |       |
      | location            |       |
      | application\_id     |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Rejection reasons">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Roles">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_label       |       |
      | scope               |       |
      | unified\_type       |       |
    </Accordion>

    <Accordion title="Candidate tags">
      | Field               | Notes |
      | ------------------- | ----- |
      | candidate\_id       |       |
      | tag\_id             |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job user role assignments">
      <Note>
        ZohoRecruit job openings expose 2 role types

        * **Assigned\_Recruiters** / **Assigned\_Recruiter** maps to `RECRUITER`
        * **Account\_Manager** has no unified type
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | job\_user\_id       |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Job hiring team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | roles               |       |
      | job\_id             |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="User roles">
      <Note>
        Zoho Recruit assigns each user one system role (**name** on the role) when present in the API response

        * **name** equal to Administrator maps to unified type `ADMIN`
        * **name** equal to Recruiter maps to unified type `RECRUITER`
        * Any other **name** has no unified type
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | user\_id            |       |
      | role\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Interviewing team members">
      | Field               | Notes |
      | ------------------- | ----- |
      | interview\_id       |       |
      | user\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      | Input Field                                           | Notes |
      | ----------------------------------------------------- | ----- |
      | candidate.first\_name                                 |       |
      | candidate.last\_name                                  |       |
      | candidate.email\_address                              |       |
      | candidate.additional\_email\_addresses.email\_address |       |
      | candidate.company                                     |       |
      | candidate.title                                       |       |
      | candidate.phone\_number                               |       |
      | candidate.location.city                               |       |
      | candidate.location.country                            |       |
      | candidate.location.state                              |       |
      | candidate.location.zip\_code                          |       |
      | candidate.salary\_expectations.amount                 |       |
      | candidate.social\_links.url                           |       |
      | application.job\_id                                   |       |
      | application.stage\_id                                 |       |
      | screening\_question\_answers.question\_id             |       |
      | screening\_question\_answers.answer                   |       |
      | attachments.name                                      |       |
      | attachments.content\_type                             |       |
      | attachments.data\_url                                 |       |
      | attachments.data                                      |       |
      | attachments.type                                      |       |
      | source.name                                           |       |
      | source.unified\_key                                   |       |
      | source.id                                             |       |
    </Accordion>

    <Accordion title="Create application">
      | Input Field                                           | Notes |
      | ----------------------------------------------------- | ----- |
      | candidate.first\_name                                 |       |
      | candidate.last\_name                                  |       |
      | candidate.email\_address                              |       |
      | candidate.additional\_email\_addresses.email\_address |       |
      | candidate.company                                     |       |
      | candidate.title                                       |       |
      | candidate.phone\_number                               |       |
      | candidate.location.city                               |       |
      | candidate.location.country                            |       |
      | candidate.location.state                              |       |
      | candidate.location.zip\_code                          |       |
      | candidate.salary\_expectations.amount                 |       |
      | candidate.social\_links.url                           |       |
      | application.job\_id                                   |       |
      | application.stage\_id                                 |       |
      | screening\_question\_answers.question\_id             |       |
      | screening\_question\_answers.answer                   |       |
      | attachments.name                                      |       |
      | attachments.content\_type                             |       |
      | attachments.data\_url                                 |       |
      | attachments.data                                      |       |
      | attachments.type                                      |       |
      | source.name                                           |       |
      | source.unified\_key                                   |       |
      | source.id                                             |       |
    </Accordion>

    <Accordion title="Add tag to candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Remove tag from candidate">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
      | tag.name      |       |
    </Accordion>

    <Accordion title="Add attachment to application">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | application\_id          |       |
      | attachment.name          |       |
      | attachment.content\_type |       |
      | attachment.data\_url     |       |
      | attachment.data          |       |
      | attachment.type          |       |
    </Accordion>

    <Accordion title="Move application to stage">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | stage\_id       |       |
    </Accordion>

    <Accordion title="Reject application">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | application\_id       |       |
      | rejection\_reason\_id |       |
      | note                  |       |
    </Accordion>

    <Accordion title="Add result link to application">
      | Input Field                         | Notes |
      | ----------------------------------- | ----- |
      | application\_id                     |       |
      | label                               |       |
      | url                                 |       |
      | details.custom\_field\_name\_prefix |       |
      | details.attributes.key              |       |
      | details.attributes.value            |       |
    </Accordion>

    <Accordion title="Add note to application">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
      | content         |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>

    <Accordion title="Get candidate attachments">
      | Input Field   | Notes |
      | ------------- | ----- |
      | candidate\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature                        | Notes                                                                                                                                                                                                                           |
    | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | OAuth                          |                                                                                                                                                                                                                                 |
    | API Passthrough                |                                                                                                                                                                                                                                 |
    | Scope Testing                  | Zoho Recruit is an OAuth integration but scope testing is still carried out through the role of the current user. Screening questions\*: We only surface required Candidate fields as screening questions (shared across jobs). |
    | Delta Syncs                    |                                                                                                                                                                                                                                 |
    | Source Writing                 |                                                                                                                                                                                                                                 |
    | Sync Only Created Applications |                                                                                                                                                                                                                                 |
    | Connection Guide               |                                                                                                                                                                                                                                 |
    | Prerequisites                  |                                                                                                                                                                                                                                 |
    | Roles                          |                                                                                                                                                                                                                                 |
    | System roles (e.g. Admin)      | Zoho Recruit assigns each user one system role (**name** on the role) when present in the API response                                                                                                                          |

    * **name** equal to Administrator maps to unified type `ADMIN`
    * **name** equal to Recruiter maps to unified type `RECRUITER`
    * Any other **name** has no unified type |
      \|   Job roles (e.g. Hiring Manager) | ZohoRecruit job openings expose 2 role types
    * **Assigned\_Recruiters** / **Assigned\_Recruiter** maps to `RECRUITER`
    * **Account\_Manager** has no unified type |
  </Tab>
</Tabs>


# Zvoove Recruit ATS Integration
Source: https://docs.kombo.dev/ats/connectors/zvooverecruit

Zvoove Recruit connector for Kombo's ATS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Zvoove Recruit ATS integration allows you to sync ATS data between Zvoove Recruit and your application through Kombo's unified API. The tool slug for this connector is `zvooverecruit`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/29126113468049-zvoove-ATS-How-do-I-link-my-account">
    Step-by-step instructions to connect your Zvoove Recruit account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Jobs">
      <Note>
        When multiple employment types are supported by a job in zvoove we only expose the first one.
      </Note>

      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | job\_code            |       |
      | description          |       |
      | weekly\_hours        |       |
      | employment\_type     |       |
      | status               |       |
      | visibility           |       |
      | department           |       |
      | post\_url            |       |
      | experience\_level    |       |
      | remote\_work\_status |       |
      | salary\_amount       |       |
      | salary\_amount\_from |       |
      | salary\_amount\_to   |       |
      | salary\_currency     |       |
      | salary\_period       |       |
      | location             |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | opened\_at           |       |
      | closed\_at           |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Candidates">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | source              |       |
      | phone\_numbers      |       |
      | email\_addresses    |       |
      | location            |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Application Stages">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Applications">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | outcome             |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create candidate">
      <Note>
        Created candidates in Zvoove enter an inbox queue. Their id will change when their application is accepted.
      </Note>

      | Input Field                  | Notes |
      | ---------------------------- | ----- |
      | candidate.first\_name        |       |
      | candidate.last\_name         |       |
      | candidate.email\_address     |       |
      | candidate.phone\_number      |       |
      | candidate.location.city      |       |
      | candidate.location.zip\_code |       |
      | candidate.gender             |       |
      | candidate.availability\_date |       |
      | application.job\_id          |       |
      | attachments.name             |       |
      | attachments.content\_type    |       |
      | attachments.data\_url        |       |
      | attachments.data             |       |
      | attachments.type             |       |
      | source.name                  |       |
      | source.unified\_key          |       |
      | source.id                    |       |
    </Accordion>

    <Accordion title="Create application">
      <Note>
        Created candidates in Zvoove enter an inbox queue. Their id will change when their application is accepted.
      </Note>

      | Input Field                  | Notes |
      | ---------------------------- | ----- |
      | candidate.first\_name        |       |
      | candidate.last\_name         |       |
      | candidate.email\_address     |       |
      | candidate.phone\_number      |       |
      | candidate.location.city      |       |
      | candidate.location.zip\_code |       |
      | candidate.gender             |       |
      | candidate.availability\_date |       |
      | application.job\_id          |       |
      | attachments.name             |       |
      | attachments.content\_type    |       |
      | attachments.data\_url        |       |
      | attachments.data             |       |
      | attachments.type             |       |
      | source.name                  |       |
      | source.unified\_key          |       |
      | source.id                    |       |
    </Accordion>

    <Accordion title="Get application attachments">
      | Input Field     | Notes |
      | --------------- | ----- |
      | application\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | API Passthrough  |       |
    | Scope Testing    |       |
    | Source Writing   |       |
    | Connection Guide |       |
  </Tab>
</Tabs>


# FAQ
Source: https://docs.kombo.dev/ats/faq

Frequently Asked Questions

#### How can I count the number of applications I created as a job board?

Kombo tracks all the applications that you've created through our platform, allowing you to count and effortlessly track all the candidates you've created in your customer's ATS systems.

* For talent acquisition customers, only created candidates will be returned by the Kombo API. Just call the ["Get Candidates"](/ats/v1/get-candidates) endpoint on the Kombo API, fetching a precise list of all your created candidates. This allows you to count created candidates easily and improves compliance as less data is stored in Kombo.

#### Do I have to wait for the first sync to complete?

Yes, during the first sync, customers will need to wait for the process to complete before accessing the latest data. The duration of the first sync depends on the amount of data being synchronized and the efficiency of the data transfer process. Kombo's system will handle the sync and can notify you when it's finished via a webhook.

#### How long does the first sync take?

The duration of the first sync can vary based on factors such as the volume of data (which is influenced by [your scopes](./features/scopes)), network conditions, and the bulk export capabilities of the target system's API.

Generally, you can expect initial syncs to take **just a few minutes** for most integrations. A major exception to this are syncs involving large amounts of historical data. If you, for example, connect a large ATS instance with hundreds of thousands of applications, an initial sync might take **up to several hours** depending on the system.

In these cases, we'd recommend thinking about whether you can reduce the data points you're syncing and [adapting your scope config](./features/scopes). As a job board, you might, for example, only need to [access the applications that you created](/ats/features/application-status-tracking#syncing-only-created-candidates).

#### What should I show my customers during the first sync?

During the very first sync, you should display an informative message to users about the ongoing data update and reassure them that the app is actively fetching and updating data with a loading state or progress indicator.

#### What happens when I change my Kombo scope configuration?

The [Kombo scope configuration](./features/scopes) lets you control the data you read from your customers' systems and communicate this information when they are setting up their integrations.

But once the connection is established, your customer will **not** be forced to accept new changes you made to the scope config. That's because changes to the scope config will often be made for purely technical reasons, like enabling a single new field we expose. In these cases, we don't want to force hundreds of end customers to reconnect their systems.

Thus, when planning to make significant changes to your Kombo scopes, you should communicate this with your customers in advance and give them enough time to react.

**Important note:** Most systems allow specifying specific permissions on the API credentials. If the API credentials don't grant permissions to a specific data point, changing the Kombo scope config can't expose any more data (but it will often make Kombo syncs fail because of authorization errors). In that case, you will actually have to ask your customer to enable the missing permissions on their API credentials to allow you reading those data points.

#### What time zone and format does Kombo use for times and dates?

We return times and dates in the UTC time zone and in the standard UTC format (ISO 8601).


# Application attribution
Source: https://docs.kombo.dev/ats/features/application-attribution

Learn how to attach source information to applications easily.

As a job board or recruiting agency, you want to make sure that your customers
can see **which candidates and applications came from your platform**.

The cleanest way to achieve this is usually by filling a special "source" field
in the ATS with the name of your platform. We call this **"application
attribution"**.

Systems almost universally support some form of application
attribution, but the exact implementation can vary. We've unified the
application attribution process across all supported integrations.

## Automatic attribution

When using automatic application attribution, sources are automatically
attached to each application created through our API.

You can enable the feature in the [configuration section](https://app.kombo.dev/configuration/writing-candidates) on the dashboard.

### Setup requirements

Some ATS integrations require additional setup to enable
automatic application attribution. When this feature is enabled, we will
prompt users to complete the setup process with customized flows
for each ATS.

On the end-user side, the setup process is usually a matter of going into the
ATS's settings and setting up a new source (some ATSs also call this
differently). Let's look at Personio as an example:

After we've verified the credentials in the connection flow, we will prompt the
user to set up application attribution. In the case of Personio, the user needs
to create a so-called "recruiting channel" and then paste its ID.

<Frame>
  <img title="Personio application attribution" />
</Frame>

Once the setup is complete, we will validate the configuration and attach the
source to all candidates created for that integration.

## Manual attribution

It is also possible to manually attribute applications by passing the `source`
parameter when creating a [candidate](/ats/v1/post-candidates) or
[application](/ats/v1/post-jobs-job-id-applications). Please note that this
approach will only work for ATSs that allow passing a raw source string. For
others, where some setup work is required, automatic attribution must be used.

## FAQ

#### The manual attribution is marked as deprecated. Can I still use it?

Yes, you can. We've marked it as deprecated because it's not supported by all
ATSs. We recommend using automatic attribution as most use cases just require
a single source.

#### If I already use automatic attribution, can I still pass a source manually?

Yes, you can. If you pass a source manually, it will override the automatic
attribution. Note that it will only be overwritten if manual source writing is
supported by the ATS.

#### What happens if I already use automatic attribution and change the source label in the settings?

For integrations that support setting up the source via API, we will create a new
source and use it for all new applications. For integrations that require manual
setup, we will continue using the old source. It can be updated with the [relink feature](/ats/guides/connect/reconnection).

#### What happens if I try to specify a source manually but the ATS doesn't support it?

The request will go through but no source will be attached to the application.


# Application tracking
Source: https://docs.kombo.dev/ats/features/application-status-tracking

Track a candidate's application status.

As a job board or recruiting agency, tracking your candidate's
application status is crucial. At Kombo, we offer a streamlined solution for
application status tracking and compliant, efficient data synchronization
across all supported integrations.

## Outcome detection

Kombo's outcome detection categorizes the application
based on your customer's hiring decision. Our system lets you stay
informed about each of your submitted candidates, allowing you to track the
candidates you submitted more accurately in your customer's system.

This is especially useful, because most ATS systems expose the application outcome
in no unified way (stages, booleans, dates, statuses, etc.). Kombo abstracts away
this complexity and offers a unified `outcome` for every application.

## Syncing only created candidates

To reduce the amount of data that needs to be synchronized, Kombo keeps track
of candidates created by your integration, and only syncs those applicants.
By default, this feature is enabled for all customers of Kombo.

If you don't need to read candidates other than the ones created by you, we
recommend keeping this setting on. Syncing all candidates can have a big impact
on sync times and the amount of data you need to process. Only syncing created
applicants also reduces the amount of data that is exposed, and therefore
improves compliance.

This feature can be turned off on [this page](https://app.kombo.dev/configuration/writing-candidates) of the Kombo dashboard.

<Note>
  🔭 That means, when connecting a new customer, you will initially receive an empty array for the candidates and applications (until you create an application or candidate through the Kombo API).
</Note>


# Audit Logs
Source: https://docs.kombo.dev/ats/features/audit-logs

Audit sensitive changes to your Kombo environment.

## Use Case

Audit logs are essential for maintaining compliance and security within your
organization. They provide a detailed record of actions taken within your
Kombo environment, helping you track changes, identify unusual activity,
and ensure accountability.

## Accessing Audit Logs

You can access audit logs through the
[Audit Logs section in the Dashboard](https://app.kombo.dev/audit-logs).
Logs are environment-specific, so make sure to select the appropriate environment.
The dashboard allows you to query logs using the provided filter functionality.

<Frame>
  <img alt="Audit Logs Screenshot" />
</Frame>

## Limitations

Audit logs are available only on and above the scale plan and are retained for
one year, with retention periods of up to three years available on higher plans.
Custom retention policies and automated access to logs are
available on larger plans. If you require these customizations,
please contact Customer Success for assistance.


# Screening questions
Source: https://docs.kombo.dev/ats/features/candidate-screening-questions

Attach your candidates' answers to screening questions when creating applications.

Kombo simplifies answering screening questions for each job as we provide a
unified interface across all integrations to read questions and write answers. With our platform, you
can effortlessly display your customers' specific screening questions to
candidates during the application process and ensure that candidates' responses
are submitted in the designated format. This streamlined approach allows your
customers to conveniently review and evaluate candidate responses, making
informed decisions about potential hires.

### Setup requirements

1. **Read screening questions from jobs:** We give you a unified format for all
   your customers' screening questions. When [reading jobs](/ats/v1/get-jobs)
   that include screening questions, simply create a customized form that
   displays these screening questions to your candidates during the application
   process.

2. **Submit answers with applications:** Applications need to [be
   submitted](/ats/v1/post-jobs-job-id-applications) with their answers to the
   screening questions in the designated format. Your customers can then access and
   review candidates' responses, streamlining the candidate evaluation process
   and facilitating informed decision-making.

### Auto-answering required screening questions

<Warning>
  This feature is currently in beta. Please reach out if you would be interested
  in using it.
</Warning>

If, by design, your product does not support screening questions, we provide you with the option to automatically answer these questions. This is necessary as some tools will validate and reject applications that do not have answers to the required questions.

When a candidate applies for a job, we will automatically answer any required screening questions that were not answered with default values. These default values are based on the question type and are as follows:

| Type            | Answer                                                                                           |
| --------------- | ------------------------------------------------------------------------------------------------ |
| `TEXT`          | `-`                                                                                              |
| `NUMBER`        | `0` (unless min and/or max are described, in which case we take the minimum number in the range) |
| `BOOLEAN`       | true                                                                                             |
| `SINGLE_SELECT` | The first option                                                                                 |
| `MULTI_SELECT`  | The first option                                                                                 |
| `DATE`          | The current date                                                                                 |
| `FILE`          | An empty file                                                                                    |

#### Handling tool-specific logic

Some tools will include a score or disqualification value to a question. If these values can be read via API, we will ensure that the submitted answer does not disqualify the created candidate. Kombo will never try to manipulate or maximize a score.

#### Display type

The `display_type` for screening questions contain information about the display and validation.
For example a screening question of type `TEXT` can have an these `display_type` properties: `SINGLE_LINE`, `MULTI_LINE`, `EMAIL` and `URL`.
`EMAIL` and `URL` have additional validation rules.

### Conditional screening questions

A conditional screening question is a question that should only appear based on the answer to another question. You will want to implement logic that only displays the conditional screening question to the applicant if this precondition is met. Answers to conditional screening questions may be required, although this requirement is only true if the precondition is met. An example of this could be:

**Question 1:** Do you have a valid driver's license?

* **Yes**
* **No**

**Question 2:** How many years of driving experience do you have?

* **Less than 1 year**
* **1-2 years**

For this example, you would only want to show the second question if the applicant answered **Yes** to the first question.

<Tip>
  Use Kombo's sandbox integration in your development environment to test
  conditional screening questions and build your user interface.
</Tip>

Kombo would return these questions on the [Get Jobs endpoint](/ats/v1/get-jobs) as shown below. On the second question, the value of `precondition_question_id` is the `id` of the first question, and `precondition_options` includes the `id` of the **Yes** option of the first question.

```
"screening_questions": [
  {
    "id": "26vafvWSRmbhNcxJYqjCzuJg",
    "remote_id": "48b4d36a-1d4b-4c50-ada7-9519078e65b4",
    "title": "Do you have a valid driver's license?",
    "description": "Please state if you have a valid driver's license.",
    "format": {
      "display_type": "DROPDOWN",
      "type": "SINGLE_SELECT",
      "options": [
        {
          "id": "5KMj443ZBfzBkqFhDuvdoZJP",
          "remote_id": "59c5d36a-1d4b-4c50-ada7-9519078e65b4",
          "name": "Yes"
        },
        {
          "id": "H5benHrFr66wh9wU3RQegRRN",
          "remote_id": "61d6d36a-1d4b-4c50-ada7-9519078e65b4",
          "name": "No"
        }
      ]
    },
    "index": 0,
    "required": true,
    "precondition_question_id": null,
    "precondition_options": null
  },
  {
    "id": "9SmkUABUZnQdoPGeK83CdGnH",
    "remote_id": "21b4d36a-1d4b-4c50-ada7-9519078e65b4",
    "title": "How many years of driving experience do you have?",
    "description": "Please state how many years of driving experience you have.",
    "format": {
      "display_type": "DROPDOWN",
      "type": "SINGLE_SELECT",
      "options": [
        {
          "id": "AFN58qWqutLt4ZMZgykD483W",
          "remote_id": "11c5d36a-1d4b-4c50-ada7-9519078e65b4",
          "name": "Less than 1 year"
        },
        {
          "id": "6MHzLUCEaNmccbf6bP18466J",
          "remote_id": "66d6d36a-1d4b-4c50-ada7-9519078e65b4",
          "name": "1-2 years"
        }
      ]
    },
    "index": 1,
    "required": true,
    "precondition_question_id": "26vafvWSRmbhNcxJYqjCzuJg",
    "precondition_options": ["5KMj443ZBfzBkqFhDuvdoZJP"]
  }
],
```


# Custom Fields
Source: https://docs.kombo.dev/ats/features/custom-fields

Learn how to extend Kombo's unified data models with additional fields.

## What are Kombo custom fields?

Kombo's unified models cover the fields that are standard across HR, ATS, and other business systems. When your product needs additional read-side data, custom fields let you extend those models with your own stable field keys.

For example, you might add `t_shirt_size` to employees, `benefit_eligibility` to employments, or `source_campaign` to applications. Once a custom field is configured and mapped, Kombo returns it in the `custom_fields` object of the relevant API response.

This makes custom fields a good fit whenever you need a data point that is not part of Kombo's standard unified model, but you still want to read it in an integration-agnostic way.

<Info>
  Custom fields are for **reading** additional data from connected systems.
  Looking to **write** extra data when creating candidates or applications? See
  [Remote Fields](/extending-the-model#remote-fields). For a full comparison of
  all extension mechanisms, see [Extending the Model](/extending-the-model).
</Info>

## How mappings work

A Kombo custom field is the target field that appears in your API response. A field from the connected system is the source field that provides the value for a specific integration.

The source field can be anything Kombo can discover from the connected system: a standard field in that system, a niche provider-specific field, or a custom field that your customer created in their HR or ATS tool.

For example:

* A Personio employee attribute called **"Favorite Color"** can be mapped to your Kombo custom field `favorite_color`.
* A provider-specific employee field for cost center, employment type, or benefit eligibility can be mapped to a Kombo custom field if your product needs that value and Kombo's standard model does not expose it exactly the way you need.
* Different customers can use different field names, such as **"Favorite Color"** and **"Favourite Colour"**, while your API integration always reads the same Kombo key.

## Setting up custom fields in Kombo

### Create the Kombo custom field

Open [the Dashboard](https://app.kombo.dev/) and click on **Configuration** in the sidebar, then on the **Custom Fields** tab.

<Frame>
  <img
    alt="Custom fields empty
state"
  />
</Frame>

Find the relevant data model on the page. In this example, we want to add a field to employees, so click **Add custom field** in the **Employees** section.

<Frame>
  <img
    alt="Create custom field
dialog"
  />
</Frame>

Enter the field key that should appear in the API response. Let's call it `favorite_color`. The field key you choose here becomes the key in the `custom_fields` object of every mapped record.

### Prepare the field in the connected system

Sometimes the field you want to map already exists in the connected system. In other cases, your customer may first need to create or expose it there.

Let's take Personio as an example where the source field is a custom attribute in the HR system.

Under **Settings > Employee Information**, you can add new attributes or entire sections to employee profiles. We will add a new attribute called **"Favorite Color"** to the **"Public Profile"** section.

<Frame>
  <img alt="image" />
</Frame>

If we now go to the profile of an employee, we can see the new field. Let's set a value for it.

<Frame>
  <img alt="image" />
</Frame>

In the case of Personio, we need to let the API key know that we want to expose the new attribute. Go to **Settings > API Credentials**, click on the API key you used to connect to Kombo, then open the **"Readable employee attributes"** section and select the field.

<Frame>
  <img alt="image" />
</Frame>

Don't forget to click **save**.

### Map fields manually

To map a field manually, open the overview for the integration. Kombo discovers available fields during syncs, so run a sync first if the field is new or has not appeared yet.

After the sync is finished, open the custom field dropdown for the relevant model and select the field from the connected system that should fill your Kombo custom field.

<Frame>
  <img
    alt="Custom field mapping
dropdown"
  />
</Frame>

Don't forget to click **Save changes** to save your changes. After creating the mapping, the next sync will read the source value and return it under your Kombo custom field key.

<a />

### Map fields based on live data

For supported integrations, the custom field dropdown also includes a recommended option to **Identify field using live data** (see screenshot above). Click **Open Custom Field Explorer** to search the connected system directly and find the field based on real records.

<Frame>
  <img alt="Custom Field Explorer" />
</Frame>

This is useful when the field name is unclear, or when you know an example value but not the exact field key. For example, you can search for an employee with the value **"Large"** to find the field that stores T-shirt size, then map that field to your Kombo custom field.

If the Explorer is not available for an integration yet, use the regular dropdown mapping flow described above.

### Add automatic mapping rules

On the custom field detail page, you can see how many integrations use the field and which **automatic mapping rules** are defined for it.

Automatic mapping rules tell Kombo which fields of new integrations should automatically be mapped to this Kombo custom field. Each rule matches against a field key or label and can optionally be scoped to a connector. You can add as many rules as you need.

Click **Add rule** to create a new automatic mapping rule.

<Frame>
  <img
    alt="Automatic mapping rules empty
state"
  />
</Frame>

In the dialog, choose whether the rule should apply to one connector or every integration in the category. Then choose whether Kombo should match against the remote field's key or label, and enter the value to match.

<Frame>
  <img
    alt="Create automatic mapping rule
dialog"
  />
</Frame>

Whenever a sync discovers a field in an integration whose key or label matches one of your rules, its value is automatically mapped to your Kombo custom field. Going back to the Personio example: if you had set up a rule for **"Favorite Color"** scoped to Personio, the next Personio sync would have automatically mapped the value to `favorite_color`.

## Self-Serve Custom Field Configuration

To simplify the mapping process, you can allow your customers to map fields themselves using our self-serve **Setup Flow**. This is especially useful when your customer knows best which field in their system contains the value your Kombo custom field should receive.

Custom fields can be mapped as part of the connection, reducing the need for manual setup.

[Learn more about enabling self-serve field mapping here.](./setup-flow/introduction)

## Accessing custom fields in the API

Each model that supports custom fields has a `custom_fields` attribute. This attribute is a JSON object containing all mapped Kombo custom fields for that record.

When you query the API, you receive mapped custom field values in the `custom_fields` attribute. In this example, we query the [GET /employees](/hris/v1/get-employees) endpoint.

The value of a custom field mirrors what is returned by the underlying API. It is not always a string; it can also be a number, boolean, object, or array.

```json {7-17} theme={null}
{
  "status": "success",
  "data": {
    "results": [
      {
        ...
        "custom_fields": {
          "favorite_color": "blue",
          "manager": {
            "name": "Frank"
          },
          "reports": [
            {
              "name": "Tom"
            }
          ]
        }
      }
    ]
  }
}
```


# Data Explorer
Source: https://docs.kombo.dev/ats/features/data-explorer

Interact with customer data from a convenient UI in the Kombo dashboard.

## Overview

The Data Explorer is a visual layer on top of Kombo's unified API. It allows
you to view and search for data entries and execute all write actions from a
convenient UI in the Kombo dashboard.

This allows you to easily debug issues with your integrations, develop new
features, and test changes with your customer's data or your sandboxes.

<Frame>
  <img />
</Frame>

## Features

Below a few examples showing what you can do with the Data Explorer.

<AccordionGroup>
  <Accordion title="View data">
    You can view any data field of any data model available
    on the Kombo API in the Data Explorer. This includes jobs, candidates,
    users, stages, interviews and rejection reasons, attachments, and all their
    relations to each other.

    <Frame>
      <img />
    </Frame>

    <Frame>
      <img />
    </Frame>

    <Frame>
      <img />
    </Frame>
  </Accordion>

  <Accordion title="Modify data (e.g. creating applications)">
    You can run any write action supported by the Kombo API in the Data
    Explorer. This includes adding tags, attachments, creating applications,
    moving candidates between stages, rejecting candidates, and more.

    Write actions can be accessed by clicking the three dots next to a data
    entry, for example here on the application.

    <Frame>
      <img />
    </Frame>

    You can also create applications from the Data Explorer.

    <Frame>
      <img />
    </Frame>
  </Accordion>

  <Accordion title="View available custom fields">
    For supported models you can view all
    [available custom fields](./custom-fields#map-fields-based-on-live-data) in
    the Data Explorer. This feature is currently only implemented for some
    integrations.

    You can access it either from the custom fields card on a data entry or from
    the three dots menu under **Fetch live data**.

    <Frame>
      <img />
    </Frame>

    A window will open, showing all available custom field values for the data
    entry.

    <Frame>
      <img />
    </Frame>
  </Accordion>
</AccordionGroup>

## How It Works

The Data Explorer is a feature built on top of the Kombo API. It allows you to
interact with the Kombo API in a convenient UI in the Kombo dashboard. All
integration-specific read and write actions that are possible via the Kombo API
are available in the Data Explorer.

## Where to find the Data Explorer

The Data Explorer is located within individual integration pages in the Kombo
dashboard:

1. **Go to Integrations**: Navigate to the [Integrations page](https://app.kombo.dev/integrations) in your dashboard
2. **Select an Integration**: Click on any connected integration from your list
3. **Access Data Explorer**: Click the "Data Explorer" tab in the integration interface

<Frame>
  <img />
</Frame>

## Access Permissions

The Data Explorer is available to:

* **Production Environment**: Users with admin role
* **Development Environment**: Users with admin or developer role


# Deletion Policy
Source: https://docs.kombo.dev/ats/features/deletion-policy

Understand how Kombo deletes data.

## General

Kombo prioritizes privacy and security by cleaning up any data that is no longer
used. We do that by following the deletion policies below. Kombo will not store
any sensitive data for longer than needed.

## Integration Data

### Case: an entry is not found anymore

When Kombo can't find an entry during a sync, we will mark it with
`remote_deleted_at` and 14 days later set all the fields to `null`.

### Case: an integration has been deleted

Kombo will delete all the data of an integration **14 days** after the integration
was deleted via API or UI.

### Case: scope config changed

**Field is turned off:** While running the next sync, Kombo will overwrite
the turned-off field for all entries with the value `null`.

**Model is turned off:** When a model gets turned off, Kombo will mark all entries with `remote_deleted_at`
and delete the entries after **14 days**.

***

## Logs

Kombo will delete statistics about syncs and write actions after **60 days**.

On all plans but the enterprise plan, Kombo will delete request data in the logs,
including the request and the response after **30 days**.


# EEO questions
Source: https://docs.kombo.dev/ats/features/eeo-questions

Getting and answering EEO and demographic questions

EEO questions are a special type of demographic questions used exclusively in the United States. These questions help companies comply with federal regulations and collect statistical data. All responses are sensitive and cannot be used in hiring decisions. Here's what you need to know:

## What is EEO and OFCCP?

Large companies in the US need to prove they're not discriminating when hiring. They collect statistical data for the *Equal Employment Opportunity Commission* (EEOC). For federal contractors and subcontractors, the *Office of Federal Contract Compliance Programs* (OFCCP) has additional reporting obligations.

Here are typical EEO/OFCCP questions:

* What is your **gender**? *(Male, Female, I choose not to disclose)*
* What is your **race/ethnicity**? *(White, Black or African American, Hispanic or Latino, ...)*
* Are you a protected **veteran**? *(Yes, No, I don't wish to answer)*
* Do you have a **disability**? *(Yes, No, I don't wish to answer)*

<Note>
  When getting jobs from Kombo, you can identify these questions by checking if
  the `category` is `"EEO"`.
</Note>

## What is *not* EEO?

While EEO questions are specifically for US regulatory compliance, some companies collect additional demographic/diversity information to gain deeper insights into their applicant pool. Though these questions may *resemble* EEO questions, they differ significantly as EEO requirements follow strict regulatory guidelines.

Here are typical demographic questions:

* How would you describe your **gender identity**?
* How would you describe your **sexual orientation**?
* ...

<Note>
  When getting jobs from Kombo, you can identify these questions by checking if
  the `category` is `"DEMOGRAPHIC"`.
</Note>

<Frame>
  <img />
</Frame>

## Tools

Many ATS handle EEO data collection differently. Here are the common approaches:

* **Dedicated EEO feature:** These ATS include a global setting to enable EEO/demographic questions. They determine if the organization is a government contractor to configure the appropriate OFCCP questions. Applicants receive a standardized set of questions with required legal disclaimers and compliance text.

  <Frame>
    <img />
  </Frame>

* **Via email after the initial application:** Instead of collecting responses during the initial application, the system sends applicants a follow-up email with the EEO questions.

  <Frame>
    <img />
  </Frame>

* **Generic questions:** Some ATS have no dedicated EEO feature. Instead, they use other features like marking normal questions as sensitive/confidential so that hiring managers cannot see the answers.

  <Warning>
    For these ATS we are unable to automatically detect which questions are
    EEO-related. As a result, all questions will have a `category` of `null`.
  </Warning>

  <Frame>
    <img />
  </Frame>

## Setup

To implement EEO questions, follow these steps. The process is exactly the same as regular screening questions — you can however customize it by looking at the `category` of a question.

```json {9, 11, 41, 43} [expandable] theme={null}
{
  "screening_questions": [
    {
      "id": "2rohQtBSjscDVBttkqMx3ji9",
      "remote_id": "k_survey_info:FZRFVBch2JxVquT8eYA4Mo1h",
      "title": "",
      "description": "<p><strong>SELF-IDENTIFICATION OF VETERAN STATUS </strong> (Completion is voluntary and will not subject you to adverse treatment)</p> [...]</li></ul>",
      "format": {
        "type": "INFORMATION"
      },
      "category": "EEO",
      "index": 8,
      "required": false,
      "precondition_question_id": null,
      "precondition_options": null
    },
    {
      "id": "APca7spVWAvy7SXpaojjkQUs",
      "remote_id": "f5a325c7-7f92-475d-8146-88cea860ad02",
      "title": "Veteran Status",
      "description": null,
      "format": {
        "display_type": "RADIO",
        "options": [
          {
            "id": "6gf8f9n749a3hDABotKqSZMb",
            "remote_id": "protected_veteran",
            "name": "I identify as one or more of the classifications of protected veteran listed above"
          },
          {
            "id": "EQ6bFJeiWsFJ5heHBXENXuRa",
            "remote_id": "non_protected_veteran",
            "name": "I am not a protected veteran"
          },
          {
            "id": "G1m7orKqwb4wf6jj8CqYjv9D",
            "remote_id": "decline_to_self_identify",
            "name": "I decline to self-identify for protected veteran status"
          }
        ],
        "type": "SINGLE_SELECT"
      },
      "category": "EEO",
      "index": 9,
      "required": false,
      "precondition_question_id": null,
      "precondition_options": null
    }
  ]
}
```

<Steps>
  <Step title="Get questions">
    When [reading jobs](/ats/v1/get-jobs), you'll receive a list of questions. Look for questions where `category` is set to `"EEO"` or `"DEMOGRAPHIC"`. For more details on handling questions, refer to the [implementation guide for screening questions](/ats/implementation-guide/screening-questions).
  </Step>

  <Step title="Display questions">
    Display the questions to the applicant, ensuring you follow these guidelines:

    <Warning>
      Please ensure that the text of all legal disclaimers is displayed. You must show the `description` field in two contexts:

      1. Below form inputs (single-select, multi-select, etc.)
      2. As standalone information blocks for `"type": "INFORMATION"`
    </Warning>
  </Step>

  <Step title="Submit answers">
    When [submitting](/ats/v1/post-jobs-job-id-applications) an application, include the answers to the EEO/demographic questions. For more information on creating applications, see the [implementation guide on creating applications](/ats/implementation-guide/creating-applications).
  </Step>
</Steps>

## FAQ

#### Can EEO & diversity questions be enabled at the same time?

Yes, this is possible. For example, in Greenhouse you can enable both EEO & demographic questions simultaneously. They will appear in the same array of questions but with different `category` values (`"EEO"` vs `"DEMOGRAPHIC"`).

#### How do I know if a question is EEO-related?

When getting jobs from Kombo, check the `category` field of each question:

* `"EEO"` indicates an EEO/OFCCP compliance question
* `"DEMOGRAPHIC"` indicates a general diversity/demographic question
* `null` is the default and likely means a screening question

#### Are EEO questions required?

The actual questions are typically marked as optional for applicants. However, you should always display these questions when they are present in the job data as organizations are dependent on collecting enough responses.

### Do I only need to display the questions to people in the US?

No action is required on your part.

The ATS (or Kombo) will automatically determine whether EEO questions should be shown, based on the **job’s location**. EEO questions are typically only displayed for jobs *located* in the United States, and will only be returned via the API when relevant.

### What tools are supported?

You can find a detailed overview of supported ATS platforms in the [ATS coverage grid](https://app.kombo.dev/coverage/ats) on your dashboard. This grid also provides information about how each ATS handles EEO questions (for example, whether they are collected via email or directly in the initial application).

If you need support for an additional ATS, please contact us to request coverage.


# Integration Fields
Source: https://docs.kombo.dev/ats/features/integration-fields

Learn how to use integration fields to read additional data properties from your customer's systems.

<Warning>
  The Integration Fields API was built for a very specific niche use case. This
  is likely not what you want to use. See [Custom Fields](./custom-fields)
  instead.
</Warning>

## What is an integration field

An integration field is a field returned from the raw response of the remote system.

## Setting up integration fields in Kombo

Before we set up the integration field in Kombo, let's talk about how you will receive the data.

Each model that supports integration fields has an `integration_fields` attribute. This attribute is an Array of JSON objects that contains all selected integration fields. We will discuss how to select integration fields in a [later step](#selecting-an-integration-field).

### View available integration fields

To list which integration fields are available for a specific integration, you should use our [GET integration-fields](../v1/get-integrations-integration-id-integration-fields) endpoint.

Example response:

```JSON theme={null}
{
    "status": "success",
    "data": {
        "results": [
            {
                "id": "123AbcDEFG4hijK5Lmn67OPq",
                "key": "dynamic_5487319",
                "model": "hris_employees",
                "type": "CUSTOM",
                "label": "Name of health insurance",
                "is_passthrough_enabled": false
            },
            ...
        ]
    },
    "next_cursor": null
}
```

If your array is empty or does not contain the values that you are looking for, double check if "integration fields" is enabled for the specific model in your [scope config](https://app.kombo.dev/scope-config).

<Note>
  Please note that this endpoint is paginated, featuring a default page size of
  250 and a maximum page size of 2000 (specified via the `page_size` parameter).
</Note>

### Selecting an integration field

To select an integration field to be passed through, use the [PATCH integration-fields](../v1/patch-integrations-integration-id-integration-fields-integration-field-id) endpoint.

An example payload would look like this:

```JSON theme={null}
{
    "enable_passthrough": true
}
```

Example response:

```JSON theme={null}
{
    "status": "success",
    "data": {
        "id": "123AbcDEFG4hijK5Lmn67OPq",
        "key": "dynamic_5487319",
        "model": "hris_employees",
        "type": "CUSTOM",
        "label": "Name of health insurance",
        "is_passthrough_enabled": true
    }
}
```

After successfully enabling passthrough on an integration field, the **next sync** will collect the values for the selected field and save them. These values then become part of our API response as follows:

## Getting integration fields as part of the API response

When you query the API, you will receive any selected integration fields in the `integration_fields` attribute. In this case, we query the [GET /employees](/hris/v1/get-employees) endpoint.
The value of an integration field mirrors what is returned by the underlying API (i.e. it's not always a `string` but can be a `number` or even an `object` too).

```JSON theme={null}
{
  "status": "success",
  "data": {
    "results": [
      {
        "first_name": "Frank",
        ...,
        "integration_fields": [
          {
            "id": "123AbcDEFG4hijK5Lmn67OPq",
            "key": "dynamic_5487319",
            "type": "CUSTOM",
            "value": "National Health",
            "label": "Name of health insurance"
          }
        ],
        ...
      }
    ]
  }
}
```


# Issue types
Source: https://docs.kombo.dev/ats/features/issue-types

All customer-visible issue types Kombo can raise, and when they are created and resolved.

Kombo [raises an issue](./issues) when a condition is true and resolves it when that condition clears. This page lists every customer-visible type. Internal-only types are not included.

`issue.type` on the [`issue-status-changed`](../guides/webhooks#issue-status-changed) webhook is the identifier shown under each heading. We add types over time, so your handler should treat `issue.type` as an open set and not fail on unknown values.

## Authentication failed

Type: `integration.authentication_failed`

Raised when Kombo cannot authenticate with the connected tool. That happens when a sync's connection test fails with an authentication error, or when a scheduled OAuth credential refresh fails because the credentials are invalid. Rate limits during a sync do not raise this issue.

Resolved when a later sync successfully tests the connection, or when OAuth credentials refresh successfully.

## Action failing

Type: `integration.action_failing`

Raised when at least 50% of the finished calls for a specific action on an integration have failed in the last 24 hours, and there have been at least 5 finished calls in that window. Kombo checks this after each action call.

Resolved when a later check finds fewer than 5 finished calls in the window, or a failure rate below 50%. If the action is not called again, the issue also resolves 24 hours after it was last raised.

## Incoming webhooks failing

Type: `integration.incoming_webhook_failing`

Raised when at least 50% of the incoming webhooks for an integration have failed in the last 6 hours, and there have been at least 5 incoming webhooks in that window. Kombo checks this after it receives a webhook from the tool.

Resolved when at least 5 incoming webhooks in the last 6 hours have a failure rate below 50%. It stays open if webhooks stop, or if fewer than 5 have arrived in the window.


# Issues
Source: https://docs.kombo.dev/ats/features/issues

See which integrations need attention, and how long the problem has been going on.

When an integration starts failing, you want to know about it before your customer does. Issues put those problems on the dashboard as soon as Kombo observes them, so you can act before the end customer complains.

<Frame>
  <img alt="Issues column on the integrations list" />
</Frame>

The integrations list shows an issue count on any integration that currently has an open issue. Hover the count to see the title and how long Kombo has been observing it.

Open the integration to read what is wrong and what to do next.

<Frame>
  <img alt="Issue details on an integration" />
</Frame>

## What an issue is

Kombo's issues track a problem of an integration over time. Kombo raises them when a condition is true (for example, authentication is failing) and keeps it open while that condition is still observed. When the condition clears, the issue resolves on its own.

Each issue tells you:

* what is broken
* how to investigate or fix it
* when Kombo first observed it, and when it last saw it again

See [all issue types](./issue-types) for when each one is raised and resolved. More types will follow.

## What to do when you see one

1. Open the integration from the list.
2. Read the issue. Follow the linked [logs](./logs) if you need the underlying requests.
3. If credentials are invalid, [reconnect the integration](../guides/connect/reconnection).

The [integration state](../guides/integration-states) on the same page is the current snapshot (`Active`, `Sync failing`, `Authentication failing`). The issue is the durable record that the problem is still happening, and for how long.

You can snooze an issue to hide it in the Kombo dashboard for a while. Snoozing only affects the UI. The issue stays open, Kombo keeps observing it, and it does not send an [`issue-status-changed`](../guides/webhooks#issue-status-changed) webhook.

Subscribe to that webhook to get raised and resolved events as they happen. Slack notifications will follow.

<CardGroup>
  <Card title="Issue types" icon="list" href="./issue-types">
    When each issue type is raised and resolved.
  </Card>

  <Card title="Logs" icon="scroll" href="./logs">
    Inspect the requests behind a failing sync or action.
  </Card>

  <Card title="Reconnecting" icon="arrow-rotate-right" href="../guides/connect/reconnection">
    Restore credentials when authentication has failed.
  </Card>

  <Card title="Integration states" icon="traffic-light" href="../guides/integration-states">
    Read the current operational status of an integration.
  </Card>

  <Card title="Webhooks" icon="webhook" href="../guides/webhooks#issue-status-changed">
    Get raised and resolved issue events as they happen.
  </Card>
</CardGroup>


# Komboman
Source: https://docs.kombo.dev/ats/features/komboman

Test and troubleshoot both Kombo API and passthrough API calls with our built-in API client.

## Overview

Komboman is a powerful API testing tool built directly into the Kombo dashboard that allows you to test, explore, and troubleshoot both Kombo's unified API endpoints and integration-specific passthrough API calls. It provides a convenient way to interact with APIs without requiring you to provide any authentication credentials.

<img alt="Komboman" />

## Key Benefits

* **Test Kombo API Endpoints**: Validate Kombo's unified API responses and test data models directly
* **Test Passthrough Functionality**: Quickly verify the functionality of integration-specific API endpoints
* **Troubleshoot Data Quality Issues**: Identify and resolve data format or content issues directly
* **Self-Service Debugging**: Diagnose and resolve API issues independently
* **Request History**: Save and revisit previous API requests for reference and troubleshooting
* **Simplified Authentication**: No need to manage API keys or tokens separately - we handle the authentication

## Supported API Types

### Kombo API

Test Kombo's unified API endpoints directly from the dashboard, including all HRIS, ATS, and general endpoints like `/hris/employees`, `/ats/jobs`, `/ats/applications`, `/integrations/{integration_id}`, etc. Automatic authentication and audit logging are included.

### Passthrough APIs

Test integration-specific APIs for connected tools to access native functionality not covered by unified endpoints and debug integration-specific issues.

## How It Works

Komboman provides an intuitive interface for working with both API types:

1. **Select API Type**: Choose between "kombo" (unified API) or integration-specific passthrough APIs
2. **Configure Request**: Set the HTTP method, path, query parameters, and body for your request
3. **Send and View Responses**: Instantly see the API response, including status codes and data
4. **Save Request History**: Automatically save your requests for future reference

## Where to Find Komboman

Komboman is located within individual integration pages in the Kombo dashboard:

1. **Go to Integrations**: Navigate to the [Integrations page](https://app.kombo.dev/integrations) in your dashboard
2. **Select an Integration**: Click on any connected integration from your list
3. **Access Komboman**: Click the "Komboman" tab in the integration interface

<img alt="Komboman" />

## Getting Started

To use Komboman:

1. Select the desired API from the dropdown:
   * **"kombo"** - Test Kombo's unified API endpoints for the selected integration.
   * **Integration-specific APIs** - Test passthrough functionality
2. Configure your request with the appropriate method, path, and payload
3. Send your request and analyze the response

### Testing Kombo API Endpoints

When testing Kombo API endpoints, select "kombo" from the API dropdown and enter the endpoint path (e.g., `/employees`, `/jobs`, `/applications`). Refere to our API reference for all available endpoints. All requests are automatically authenticated and audit logged.

### Testing Passthrough APIs

When testing integration-specific passthrough APIs, select the appropriate passthrough API from the dropdown and configure the request according to the integration's native API documentation which is linked on the selected API.

Komboman works directly with our [Passthrough API](./passthrough-api), which enables you to interact with the native APIs of specific integrations while we handle the authentication.

## Access Permissions

Komboman is available to:

* **Production Environment**: Users with admin role
* **Development Environment**: Users with admin or developer role


# Logs
Source: https://docs.kombo.dev/ats/features/logs

Learn how Kombo's logs allow you to monitor and troubleshoot your integrations.

## Overview

Our logs enable you to dig deeper into what is happening behind your integrations. Depending on the type of interaction, different logs are available.

You can find the logs in the [sidebar of the Kombo dashboard](https://app.kombo.dev/logs).

<Frame>
  <img alt="logs-overview" />
</Frame>

### Available Log types

| Log Type             | Description                                                                                                                                                                   | Features                                                                 |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| **Sync**             | Created for each recurring sync of an integration                                                                                                                             | [Sync Metrics](#sync-metrics), [Request Logs](#request-logs)             |
| **Connection Flow**  | Created for each connection flow interaction                                                                                                                                  | [Event Logs](#connection-flow-event-logs), [Request Logs](#request-logs) |
| **Action**           | Created whenever Kombo receives an API request which triggers Kombo to make external API requests to a tool. E.g. [create application](/ats/v1/post-jobs-job-id-applications) | [Request Logs](#request-logs)                                            |
| **Passthrough**      | Created for each [passthrough](./passthrough-api) request made                                                                                                                | [Request Logs](#request-logs)                                            |
| **Incoming Webhook** | Created whenever a tool sends an API request to Kombo                                                                                                                         | [Request Logs](#request-logs)                                            |

### Filters

Use filters to narrow your search and find exactly what you're searching for.

We additionally make sure to link back to any logs from relevant dashboard pages. For example, you can instantly query an integration's logs by clicking "logs" on the integration's details page.

<Frame>
  <img alt="log-filters" />
</Frame>

## Request Logs

Request logs help you see any API requests that Kombo is making to the integrated tool, and debug any issues. If an integration is having issues, request logs let you deep dive into understanding which endpoints are causing problems, such as finding requests returning `403` status codes for missing permissions.

<Frame>
  <img alt="request-logs" />
</Frame>

### Viewing Details

Click on a row to view details of the API request. Kombo will redact any sensitive data.

You can view the response of the request by clicking on **Open response**.

<Frame>
  <img alt="request-log-details" />
</Frame>

### Retention

By default, Kombo stores logs for 30 days. Longer retentions are available upon request on the enterprise plan.

## Connection Flow Event Logs

We store any decisive events that happen throughout the connection flow to enable you to understand exactly what your customer is experiencing. This visibility lets you detect what is preventing your customers from connecting their tool, and ultimately reach out to them with the right help to complete the integration.

<Frame>
  <img alt="connection-flow-logs" />
</Frame>

View your current connection flow logs in the [Kombo dashboard](https://app.kombo.dev/logs?kind=CONNECTION_FLOW).

### Identifying User Sessions

The logs are grouped by user sessions, with a 'broken' line indicating a break between two sessions. Viewing sessions allows you to gain insights on when a user exited and/or re-entered the connection flow.

<Frame>
  <img alt="flow-log-sessions" />
</Frame>

## Sync Metrics

The sync metrics tab allows you to gain insights into which data was read and whether any issues occurred. Use this to quickly verify that the expected data is being synced without having to make any API calls.

<Frame>
  <img alt="sync-metrics" />
</Frame>


# Passthrough API
Source: https://docs.kombo.dev/ats/features/passthrough-api

Implement any edge case feature with our passthrough API.

## Overview

The Passthrough API lets you call the native API of any connected integration directly, while Kombo handles authentication for you. This bridges the gap between the unified API and integration-specific requirements — you get the consistency of Kombo's auth layer with the flexibility of the underlying tool's full API surface.

## When to Use It

Use the Passthrough API when you need integration-specific data or actions that the unified API does not cover. Common examples:

* Reading provider-specific resources (e.g., HiBob work history, Workday compensation plans)
* Calling write endpoints that Kombo doesn't offer as a unified action
* Accessing tool-specific configuration (e.g., ATS picklists, custom templates)

<Tip>
  For reading additional fields on standard models, prefer [custom
  fields](./custom-fields) — they're simpler and work across integrations.
  [Integration fields](./integration-fields) cover a narrow niche and are rarely
  the right choice. The Passthrough API is best for accessing entirely different
  endpoints or performing writes that aren't part of the unified API.
</Tip>

## How It Works

1. **Authentication**: Authenticate with your Kombo API key as usual. Kombo forwards the request with the correct tool-specific credentials.
2. **Choose the API**: Find the API identifier for your integration in the [passthrough endpoint reference](../v1/post-passthrough-tool-api).
3. **Build your request**: Specify the HTTP method, endpoint path, headers, query parameters, and request body — exactly as the tool's native API expects.

## The `api_options` Parameter

Most integrations don't require `api_options` — simply set the `path` and Kombo routes to the right API.

However, some integrations have multiple underlying APIs or services that share the same authentication but use different base URLs or protocols. For these, `api_options` tells Kombo which specific service to target.

Integrations that use `api_options` document the required fields directly on their passthrough endpoint specification. Common examples:

* **Workday REST**: requires `service_name` (e.g., `"staffing"`, `"compensation"`) and optionally `version` to select the correct REST service
* **Workday SOAP**: requires `service_name` (e.g., `"Staffing"`, `"Recruiting"`) and optionally `service_version` to target the right SOAP service
* **SOAP-based tools** (Nmbrs, HR Office, Taleo): require `service_name` or `operation_name` to route to the correct SOAP service

If an integration doesn't document `api_options`, you don't need to provide it.

## Testing with Komboman

Use [Komboman](./komboman), the built-in API client in the Kombo dashboard, to test passthrough calls interactively. It handles authentication automatically and saves request history, making it easy to experiment with native API endpoints.

Find the full passthrough endpoint specification [here](../v1/post-passthrough-tool-api).


# Real-time Data
Source: https://docs.kombo.dev/ats/features/real-time-data

Get near-real-time updates when any data changes in connected ATS systems.

## Overview

Many applications require real-time or near real-time data access, particularly
for AI-screening, assessments, and integrated ATS workflows. Our unified
**real-time data** approach enables these use cases, significantly improving the
UX for your customers.

We provide real-time data through upstream webhooks to all customers. However,
for systems without webhook support, near real-time data access requires
accelerated sync frequencies, which are available on our Scale and
Enterprise plans.

## How It Works

### Upstream Webhooks

For integrations that support [upstream webhooks](/ats/guides/upstream-webhooks), Kombo subscribes directly to
the ATS system's webhook events during setup of the integration. When data
changes occur, we receive notifications within seconds and immediately process
the updates, making them available through our `data-changed` webhook. With active webhooks,
regular sync frequency is reduced since webhooks already keep the data fresh.

### Enhanced Sync Frequencies

For integrations without upstream webhook support, Kombo can sync data at
configurable intervals to ensure data freshness while maintaining system
performance.

<Note>
  **Plan-based sync frequencies:** Faster sync intervals are available on Scale
  and Enterprise plans.
</Note>

## Key Benefits

### Immediate Data Updates

With webhook-enabled integrations, your application receives updates within 20
seconds of changes occurring in the connected ATS system. This enables real-time
candidate tracking, instant job posting updates, and immediate application
status notifications.

### Efficient Data Processing

Our data-changed webhook system ensures you only process data when actual
changes occur, reducing unnecessary API calls and improving your application's
performance.

### Comprehensive Coverage

Whether an integration supports webhooks or relies on sync intervals, Kombo
ensures consistent data delivery across all supported ATS systems through our
unified `data-changed` approach.

## Implementation

Learn more about implementing real-time data updates:

<CardGroup>
  <Card title="Fetching Data Guide" icon="download" href="/ats/getting-started/fetching-data">
    Learn how to implement the data-changed webhook and fetch data efficiently.
  </Card>

  <Card title="Upstream Webhooks" icon="cloud-arrow-down" href="/ats/guides/upstream-webhooks">
    Understand how upstream webhooks enable real-time data updates.
  </Card>
</CardGroup>


# Remapping array fields
Source: https://docs.kombo.dev/ats/features/remapping/array-remapping

Learn how to use the remapping feature to adjust Kombo array fields based on fields in your customer's systems.

## Remapping an array field

Array fields in the Kombo data model can have multiple entries per entity. For example our HRIS employee can have multiple `bank_accounts` and an ATS candidate can have multiple `email_addresses`.
These fields will offer two mapping modes: `Replace` and `Append`

<Frame>
  <img alt="image" />
</Frame>

This will decide wether you would like to persist the Kombo default mappings in
the array or replace the array entirely.

After deciding on the mapping mode you can start adding entries to the array. Please note that all required fields for an entry need to be mapped.

<Frame>
  <img alt="image" />
</Frame>

For `bank_accounts` you need to select an account type before the fields show up. You can mix multiple types in the array.

<Frame>
  <img alt="image" />
</Frame>

## Fallbacks

Fallbacks are not available for these fields. Instead you can add multiple values to the array. If any required field (marked with red asterix) of single entry is missing, the entry will not be added to the array.

<Frame>
  <img alt="image" />
</Frame>


# Remapping date fields
Source: https://docs.kombo.dev/ats/features/remapping/date-remapping

Learn how to use the remapping feature to adjust Kombo date fields based on fields in your customer's systems.

## Remapping a date field

1. Select the source field of the date. It can bei either a string or number.
   <Frame>
     <img alt="image" />
   </Frame>
2. Pick a date format from our presets or choose `Custom format`.
   <Frame>
     <img alt="image" />
   </Frame>
3. (optional) If you have custom field examples enabled we will display a validation section below. Adjust the format until the dates are parsed as desired.
   <Frame>
     <img alt="image" />
   </Frame>
4. Press the `Save configuration` button on the bottom right.
   <Frame>
     <img alt="image" />
   </Frame>


# Remapping enum fields
Source: https://docs.kombo.dev/ats/features/remapping/enum-remapping

Learn how to use the remapping feature to adjust Kombo enum fields based on fields in your customer's systems.

## Remapping an enum field

1. Select the source field to map the enum from.
   <Frame>
     <img alt="image" />
   </Frame>
2. Define a default value. This will be the result in case the value is not mapped or null. If you want to use `fallbacks` make sure to select `None (null)` here.
   <Frame>
     <img alt="image" />
   </Frame>
3. Define an enum map. For this you first input the source string on the left. Then click the `Add mapping` button.
   <Frame>
     <img alt="image" />
   </Frame>
   After adding the source string, select one of the Kombo enum values.
   <Frame>
     <img alt="image" />
   </Frame>


# Introduction
Source: https://docs.kombo.dev/ats/features/remapping/introduction

Learn how to use the remapping feature to adjust Kombo default fields based on fields in your customer's systems.

## Prerequisits

The remapping UI is located on each individual integration right next to the "Custom Field Mappings" tab.

<Frame>
  <img alt="image" />
</Frame>

1. Your scope config for the integration will need either `custom_fields` or `integration_fields` **enabled for each model** you wish to remapp.
   <Frame>
     <img alt="image" />
   </Frame>
2. The initial sync has **finished successfully** and the integration is **not in QA mode**.
   <Frame>
     <img alt="image" />
   </Frame>
3. (optional) To improve your mapping experience we recommend enabling custom field examples for new integrations. The setting can be found under `Configuration` in the left sidebar.
   <Frame>
     <img alt="image" />
   </Frame>

We offer different user interfaces to accomedate the complexity that comes with each specific field:

1. [Simple string/number/boolean fields](./simple-remapping)
2. [Enum fields](./enum-remapping)
3. [Date fields](./date-remapping)
4. [Address fields](./struct-remapping)
5. [Reference fields](./reference-remapping)
6. [Array fields](./array-remapping)

Additionally, you can use the [Kombo Default Fallback](./kombo-default-fallback) to include Kombo's standard mapping logic as a priority in your fallback chain — available for simple, enum, and date fields.


# Kombo default fallback
Source: https://docs.kombo.dev/ats/features/remapping/kombo-default-fallback

Learn how to use Kombo's standard mapping logic as a fallback priority in your remapping configuration, giving you full control over the mapping order.

## What is the Kombo Default Fallback?

When you [override a field mapping](./introduction), you replace Kombo's built-in mapping logic with your own custom configuration. This is powerful, but sometimes you don't want to *replace* Kombo's logic entirely — you want to **combine** your custom mapping with Kombo's standard logic in a specific priority order.

The **Kombo Default Fallback** lets you insert Kombo's standard mapping logic as one of the priorities in your fallback chain. This means you can:

* Use a custom integration field as the primary source, and **fall back to Kombo's default** if that field is empty
* Use Kombo's default mapping as the **primary value**, but override it with a custom field when Kombo's value is empty
* Place Kombo's default logic **between** two custom field sources in a multi-level fallback chain

<Note>
  The Kombo Default Fallback is available for **simple** (string, number,
  boolean), **enum**, and **date** field remappings. It is not available for
  address, reference, or array field types.
</Note>

## When should you use it?

Consider using the Kombo Default Fallback when:

* **Kombo's default mapping works well in most cases**, but a small number of your customer's records store the value in a different field. You can set Kombo's default as Priority 1 and your custom field as a fallback.
* **A custom field is your preferred source**, but it isn't always populated. By adding Kombo's default as a fallback, you ensure no data is lost when the custom field is empty.
* **You want to experiment with a custom mapping** without losing the safety net of Kombo's proven default logic. If your custom source produces `null`, Kombo's standard mapping takes over automatically.

## How it works

The remapping engine evaluates your fallback chain **from top to bottom** (Priority 1 first, then Priority 2, and so on). For each record (employee, candidate, job, etc.), it checks each priority in order and **stops as soon as a valid, non-empty value is found**.

When the engine reaches a "Default Kombo value" entry in the chain, it uses the value that Kombo's standard mapping logic would have produced for that field — exactly as if no remapping had been configured.

### Example: Custom field with Kombo default as safety net

Suppose you want to map the `first_name` field from a custom integration field called `preferred_name`, but not every record has a preferred name set.

| Priority | Source                               | Behavior                                                                           |
| -------- | ------------------------------------ | ---------------------------------------------------------------------------------- |
| 1        | `preferred_name` (integration field) | Used when the field has a value                                                    |
| 2        | Default Kombo value                  | Falls back to Kombo's standard `first_name` mapping when `preferred_name` is empty |

**Result**: Records with a `preferred_name` get that value. Records without it seamlessly fall back to whatever Kombo would have mapped by default.

### Example: Kombo default with a custom override

You trust Kombo's mapping for most records, but for a few edge cases you know a specific integration field has better data.

| Priority | Source                             | Behavior                                               |
| -------- | ---------------------------------- | ------------------------------------------------------ |
| 1        | Default Kombo value                | Used when Kombo's standard mapping produces a value    |
| 2        | `backup_field` (integration field) | Only used when Kombo's default mapping produces `null` |

**Result**: Kombo's default logic runs first. Only when it returns nothing does the system check `backup_field`.

## Adding a Kombo Default Fallback

1. Open the remapping modal for the field you want to configure (see [simple](./simple-remapping), [enum](./enum-remapping), or [date](./date-remapping) remapping for details on how to open the modal).
2. At the bottom of the modal, click the **Fallback to Kombo's mapping** button.
   <Frame>
     <img alt="image" />
   </Frame>
3. A new priority entry will appear showing **"Default Kombo value"** with the description *"Uses Kombo's standard mapping logic for this field."*
   <Frame>
     <img alt="image" />
   </Frame>
4. You can **reorder** priorities by removing and re-adding entries. The Kombo Default Fallback can be placed at any position in the fallback chain — it does not have to be last.
5. Click **Save** to apply the configuration. Remember that **a sync is required** for saved changes to take effect.

## Combining with other fallbacks

You can freely mix Kombo Default entries with custom integration field entries. For example, a three-level fallback chain for an enum field might look like:

| Priority | Source                                                      |
| -------- | ----------------------------------------------------------- |
| 1        | `custom_status_field` (integration field) with enum mapping |
| 2        | Default Kombo value                                         |
| 3        | `legacy_status_field` (integration field) with enum mapping |

The engine will try `custom_status_field` first. If it's empty, it falls back to Kombo's default enum mapping. If even that produces `null`, it tries `legacy_status_field` as a last resort.

<Tip>
  If the **only** entry in your fallback chain is a Kombo Default, the
  configuration is equivalent to having no remapping at all. In this case, the
  system will automatically clear the remapping configuration when you save.
</Tip>

## Supported field types

| Field type                                             | Kombo Default Fallback supported |
| ------------------------------------------------------ | -------------------------------- |
| [Simple](./simple-remapping) (string, number, boolean) | Yes                              |
| [Enum](./enum-remapping)                               | Yes                              |
| [Date](./date-remapping)                               | Yes                              |
| [Address](./struct-remapping)                          | No                               |
| [Reference](./reference-remapping)                     | No                               |
| [Array](./array-remapping)                             | No                               |


# Remapping reference fields
Source: https://docs.kombo.dev/ats/features/remapping/reference-remapping

Learn how to use the remapping feature to adjust Kombo reference fields based on fields in your customer's systems.

## Remapping an reference field

Reference fields are fields that reference related entities. For example our employee model has three reference fields: manager\_id, legal\_entity\_id and work\_location.
These fields can offer up to two mapping types.

<Frame>
  <img alt="image" />
</Frame>

## Refernce existing record

1. When choosing `Refernce existing record` the model will be linked to an already existing record.
2. You will need to select a field that contains the same remote id as the model you wish to reference.
   <Frame>
     <img alt="image" />
   </Frame>
   If the referenced record does not exist, it will be created but all other
   fields except the id will be `null`.

## Create new record with mapped data

1. When choosing `Create new record with mapped data` the model will be linked to a new record. You will be able to create a new work location, legal entity, etc.
2. Fill the the remote id with the unique identifier you want to use for the new record.
3. Then fill the rest of the properties.
   <Frame>
     <img alt="image" />
   </Frame>

You will be able to receive the new record on both the `/employees` endpoint, as well as the relations own endpoint (`/work-locations`, `/legal-entities`).
Note: This option is not available for all reference fields.


# Remapping simple fields
Source: https://docs.kombo.dev/ats/features/remapping/simple-remapping

Learn how to use the remapping feature to adjust simple Kombo default fields based on fields in your customer's systems.

## Remapping a simple string/number/boolean field

To start the remapping process open the remapping UI and click on the `Override default Kombo value` button of the field you want to remapp.

<Frame><img alt="image" /></Frame>A new popup will
appear allowing you to configure the remapping for the individual field.

<Frame>
  <img alt="image" />
</Frame>

Under `Priority 1` you can select the source field you would like to use for the
remapping. You can search in the selection box, see the example values and even
use our custom field explorer feature.

<Frame>
  <img alt="image" />
</Frame>

After selecting the field, you can press the `Save` button to save the
configuration.

<Frame>
  <img alt="image" />
</Frame>

If this is your first remapping, a popup will appear, which reminds you that **a
sync is required** for the saved changes to show their effect.

<Frame>
  <img alt="image" />
</Frame>

## Fallbacks

In case the selected field is removed (`undefined`), `null` or changes it's structure (`string` => `array`), the remapping will result in `null` as output.
For these cases it makes sense to define one or multiple fallback values, when configuring a remapping. You can do so by clicking the `Add fallback` button in the configuration UI.

<Frame>
  <img alt="image" />
</Frame>

We will execute the remapping top to bottom. This means the remapping stops for
each the entity (employee, candidate, job...) has soon as valid value is found.

<Frame>
  <img alt="image" />
</Frame>

You can also use the **Fallback to Kombo's mapping** button to include Kombo's standard mapping logic as one of the priorities in your fallback chain. This is useful when your custom field is not always populated and you want to fall back to what Kombo would have mapped by default. Learn more in the [Kombo Default Fallback](./kombo-default-fallback) guide.


# Remapping address fields
Source: https://docs.kombo.dev/ats/features/remapping/struct-remapping

Learn how to use the remapping feature to adjust Kombo address fields based on fields in your customer's systems.

## Remapping an address field

1. An address in Kombo consists out of multiple fields. Select an integration field for each field you wish to fill. Unfilled will result in `null` for the respective property.
   <Frame>
     <img alt="image" />
   </Frame>
2. You might need to scroll to see all available fields.

Note: English country names will get automatically resolved to the ISO 3166-1 alpha-2 country code.

## Fallbacks

Fallbacks are only executed if **all fields** in the priority above are missing (`undefined`), `null` or empty (`''`).


# Extend write endpoints
Source: https://docs.kombo.dev/ats/features/remote-fields

Learn how Kombo allows you to write additional, otherwise unsupported fields with unified write actions.

## Overview

Kombo supports a feature called **Remote Fields** for many write endpoints. This
feature solves a similar problem as the [passthrough API](./passthrough-api) while still allowing you
to use the unified Kombo API.

## How does it help you

While we always try to solve even niche use cases with our unified API, there are cases
where an integration requires particular data (for example, because your customer
uses required custom fields or customizes their system a lot). In these cases, the
remote fields feature allows you to pass this data to the connected system.

Remote fields also allow you to customize specific endpoints even more, as it
would be out of scope for the unified model.

If you need to read additional data from connected systems instead, use
[custom fields](./custom-fields).

## How to use it

Write actions that support this feature support have a property called `remote_fields`
on the root level request body. This object follows a record structure where the
key is the name of the tool (e.g., `greenhouse`), and the value is an object
highly specific to the tool. On a high level, most available fields are documented in the endpoint specification.

A good example of a write endpoint supporting this feature is [the ATS API endpoint to create a new application](/ats/v1/post-jobs-job-id-applications) (search for 'remote fields').

### Example

A SuccessFactors instance requires the nationality of applicants as an attribute.
`nationality` isn't an attribute that is ordinarily supported by our
'Create application' endpoint. Because application creation generally works the
same otherwise, you can use `remote_fields` to extend the requests that we send
to SuccessFactors with the `nationality` field.

### Remote fields in practice

You will likely find out about any required remote fields during testing.
You may try to submit a dummy candidate, however, you receive an error message like the
following:

```
{'status': 'error', 'error': {'message': {'remote_http_status': 500, 'remote_error': {'error': {'code': 'COE_GENERAL_SERVER_FAILURE', 'message': {'lang': 'en-US', 'value': '[COE0019]Unexpected error occurred: custNationality required for external candidate, custFutSponsor required for external candidate as per field override,  for templateId 579 ,  with the index 0'}}}}}}
```

For example, for the above error message, you would then need to add the following fields to your create candidate call for the parameter `remote_fields`:

```
{
    "successfactors": {
        "Candidate": {
            "custNationality": "some-nationality",
            "custFutSponsor": "some-sponsor"
        }
    }
}
```

You can then use an iterative process based on the error messages
("trial-and-error") to tell whether you are now submitting the correct remote fields.

### Help

Don't hesitate to contact us if you have any questions about this feature
or you need help with a specific use case.


# Roles
Source: https://docs.kombo.dev/ats/features/roles

Understanding system roles and job roles in ATS integrations

Roles define what a person is allowed to do in an ATS. Kombo syncs these roles and exposes them through a unified schema so you can build permissions-aware features without worrying about the differences between ATS systems.

## What are roles?

A **role** represents a function or permission level assigned to a user in an ATS. Roles control what users can see, edit, and manage — both globally and within the context of a specific job.

Here are typical roles you'll encounter:

* **Admin** — Full system access, can configure settings and manage all users
* **Recruiter** — Manages candidate pipelines and coordinates the hiring process
* **Hiring Manager** — Oversees hiring for specific positions, reviews and approves candidates

Kombo syncs all roles and always returns how the role is called with the `remote_label` field.
Additionally, Kombo tries to categorize the role. For example, the role of "Administrator" is categorized as `unified_type: "ADMIN"`.
There are some cases, where the `unified_type` can be `null`, for example: Some built-in roles (e.g., "Onboarding Owner") simply don't have a corresponding unified type (yet). Or the customer has defined custom roles in their ATS (e.g., "Hiring Wizard").

## Job roles vs system roles

ATS systems typically assign roles at two levels:

|                    | System roles                                   | Job roles                                                   |
| ------------------ | ---------------------------------------------- | ----------------------------------------------------------- |
| **Scope**          | Entire ATS instance                            | Single job                                                  |
| **Purpose**        | Control platform-wide permissions              | Define hiring team responsibilities                         |
| **Example**        | "Admin" — can configure settings for all users | "Hiring Manager" — responsible for a specific open position |
| **Where in Kombo** | `system_roles` on `/ats/users`                 | `job_roles` on hiring team members in `/ats/jobs`           |

A single user can have both: they might be an **Admin** system-wide and a **Hiring Manager** for a specific job.

## ATS systems

How roles work varies across ATS platforms. Here are the common approaches:

* **Predefined roles:** The ATS provides a fixed set of roles (e.g., Admin, Recruiter, Hiring Manager) that cannot be customized. These map cleanly to Kombo's unified types.

* **Customizable roles:** The ATS allows creating custom roles with granular permissions. Kombo syncs all roles. Well-known ones are categorized with a `unified_type`. Custom roles are passed through with `unified_type: null` and the original label in `remote_label`.

* **Implicit roles:** Some ATS don't have an explicit roles system. Instead, adding someone as a "Hiring Manager" on a job implicitly assigns them that role. Kombo still normalizes this into the same `job_roles` structure.

<Frame>
  <img />
</Frame>

***

<Frame>
  <img />
</Frame>

## Setup

### Scopes

The **Roles** scope is disabled by default. To start syncing roles, enable it in your [scope configuration](/ats/features/scopes). You also need the **Users** scope to be enabled, since all roles are connected to users.

<Frame>
  <img />
</Frame>

### Roles endpoint

Use the [`GET /ats/roles`](/ats/v1/get-roles) endpoint to list all roles defined in the connected ATS. You can filter by scope to get only system-level or job-level roles.

```json [expandable] theme={null}
// GET /ats/roles
{
  "status": "success",
  "data": {
    "next": null,
    "results": [
      {
        "id": "26vafvWSRmbhNcxJYqjCzuJg",
        "remote_id": "101",
        "remote_label": "Admin",
        "scope": "SYSTEM",
        "unified_type": "ADMIN",
        "remote_data": null,
        "changed_at": "2024-11-07T14:00:00.000Z",
        "remote_deleted_at": null
      },
      {
        "id": "7yNRgs4cGFpUfhwbGBDaB5Gk",
        "remote_id": "202",
        "remote_label": "Recruiter",
        "scope": "JOB",
        "unified_type": "RECRUITER",
        "remote_data": null,
        "changed_at": "2024-11-07T14:00:00.000Z",
        "remote_deleted_at": null
      },
      {
        "id": "4kTPJfmNaQdhzRCVLd83FYWJ",
        "remote_id": "203",
        "remote_label": "Hiring Wizard",
        "scope": "JOB",
        "unified_type": null,
        "remote_data": null,
        "changed_at": "2024-11-07T14:00:00.000Z",
        "remote_deleted_at": null
      }
    ]
  }
}
```

<Note>
  Above, you see that this customer has one role on the system level ("Admin")
  and two on the job level ("Recruiter", "Hiring Wizard").

  The role of "Admin" and "Recruiter" are categorized in the `unified_type` of
  `ADMIN` and `RECRUITER`.

  However Kombo does not know how to categorize the "Hiring Wizard" role, so the
  `unified_type` is `null`.
</Note>

### Job roles

When [reading jobs](/ats/v1/get-jobs), each hiring team member includes a `job_roles` array showing what roles they have for that specific job.

```json {13-26} [expandable] theme={null}
// GET /ats/jobs
{
  "status": "success",
  "data": {
    "results": [
      {
        "id": "8VkMaFnDx4gNRFfraFgnLbVp",
        "name": "Backend Engineer",
        "hiring_team": [
          {
            "first_name": "John",
            "last_name": "Doe",
            "job_roles": [
              {
                "remote_id": "202",
                "remote_label": "Recruiter",
                "scope": "JOB",
                "unified_type": "RECRUITER"
              },
              {
                "remote_id": "203",
                "remote_label": "Hiring Wizard",
                "scope": "JOB",
                "unified_type": null
              }
            ]
          }
        ]
      }
    ]
  }
}
```

<Warning>
  The `hiring_team_roles` field on hiring team members is deprecated. Use
  `job_roles` instead — it provides the full list of roles including custom ones
  and the original remote label.
</Warning>

### System roles

When [reading users](/ats/v1/get-users), each user includes a `system_roles` array showing their platform-wide roles.

```json {8-15} [expandable] theme={null}
// GET /ats/users
{
  "status": "success",
  "data": {
    "results": [
      {
        "id": "26vafvWSRmbhNcxJYqjCzuJg",
        "system_roles": [
          {
            "remote_id": "101",
            "remote_label": "Admin",
            "scope": "SYSTEM",
            "unified_type": "ADMIN"
          }
        ]
      }
    ]
  }
}
```

## FAQ

### How do I check if a user is an admin?

Look at the `system_roles` array on the user object from `/ats/users`. If any role has `unified_type` set to `"ADMIN"`, the user has admin-level access.

### Can a user have multiple roles?

Yes. A user can have multiple system roles and multiple job roles on different jobs. For example, someone could be both an Admin and a Manager system-wide and a Hiring Manager on a specific job.

### What if a role doesn't have a `unified_type`?

This means the role is custom or doesn't map to one of Kombo's unified types. Use the `remote_label` field to identify what the role is.

### What tools are supported?

You can find a detailed overview of supported ATS platforms in the [ATS coverage grid](https://app.kombo.dev/coverage/ats) on your dashboard.

If you need support for an additional ATS, please contact us to request coverage.


# Scopes
Source: https://docs.kombo.dev/ats/features/scopes

Scopes allow you to customize what data is being synced by Kombo.

By default, Kombo syncs all available data from connected systems. This can be
pretty convenient for exploring what's available during development, but as soon
as you take Kombo into production, you'll likely want to restrict what data is
extracted and stored for privacy and security reasons.

For this purpose, Kombo provides what we call "Scopes." These allow you to
configure precisely which models and data points are being extracted and stored.
Scopes can, for example, be used to anonymize data by removing all personal
identifiable information from the data we store.

## Configuring scopes

To get started configuring scopes, log into the
[Kombo Dashboard](https://app.kombo.dev) and open the "Scope Config" page. It
should look something like this:

<Frame>
  <img alt="1464" />
</Frame>

### Configure scope config

When editing your scope configs or creating a new one, a page similar to this
one will open:

<Frame>
  <img alt="1464" />
</Frame>

All of Kombo's Data Models are listed here, and you can disable, enable or
mark an entire Data Model as optional.
We do not sync data from disabled data models. Optional Data Models aren't
synced if your customer opts out of having the field exposed. Enabled
models are always synced.

We recommend turning all Data Models off that you are not interested in. For example,
if you want to sync employee, employment and organization data
but are not interested in absences, turning off the absence type, absences and
time off balance Data Models is recommended. This will simplify the setup for your customer, improve sync times, and
not expose any data that does not need to be exposed.

### Configuring fields

If you only want to turn off individual model fields, you can expand
each model in the edit page. You will now see all the fields it supports:

<Frame>
  <img alt="1426" />
</Frame>

For example, if you don't want to sync sensitive data like SSNs or Tax IDs,
you can turn them off here. Similarly, if you would like to read
personal identifiable information but it is not required for your use-case,
consider marking the field as optional. This will give your customers the choice
of whether they want to expose it or not.

## Building trust with your customers

Some of the systems we help you integrate contain very sensitive data (like
personal addresses or tax IDs of employees). That's why
communicating which data points you access and which you don't is critical to
building trust and eradicating concerns during the sales process.

To help you with this, we're exposing your scope config to the end user as part
of our connection flow:

<Frame>
  <img alt="1002" />
</Frame>

This way, your customers can see exactly which data points you're accessing.


# Setup Flow
Source: https://docs.kombo.dev/ats/features/setup-flow/introduction

Let your customers configure their integration end-to-end.

<img alt="Setup Flow" />

The [Connection Flow](/kombo-connect) lets your customers authenticate and
validate their credentials. The Setup Flow covers everything that comes after:
any additional configuration the integration needs before it can sync the right
data. It is presented to your customers as a self-serve UI inside the Kombo
Connect SDK, so they can complete it without you building anything yourself.

## What appears in the Setup Flow

Each integration decides which steps it actually needs. The most common ones
are:

* **[Field mapping](../custom-fields#self-serve-custom-field-configuration)**,
  where customers connect your custom fields to fields in their tool. Available
  for any category as long as you've defined custom fields.
* **[Employee filtering](/hris/features/filtering/introduction)**, where HRIS
  customers choose which employees Kombo should sync.
* **Tool-specific steps**, surfaced automatically by some connectors (for
  example Greenhouse, Teamtailor, or SCIM) to handle one-time configuration that
  the tool itself requires, like activating webhooks or providing additional
  credentials.

Steps only show up when they are relevant. If a customer connects a tool that
does not support filtering, the filtering step is hidden even when the feature
is enabled on the integration.

## Enabling Setup Flow steps

Field mapping and employee filtering are opt-in per integration. Tool-specific
steps require no configuration on your side, they appear automatically when
needed.

### When creating a new integration

In the Dashboard, open the [Integrations
page](https://app.kombo.dev/integrations) and toggle the steps you want at the
bottom of the create-link form.

<img
  alt="Integration Creation Form Setup Flow
Toggles"
/>

You can do the same via the API by setting `enable_field_mapping` and/or
`enable_filtering` (HRIS only) to `true` on the [Create Connection Link
endpoint](../../v1/post-connect-create-link).

### For an existing integration

Open the integration in the Dashboard and use the toggles in the **Integration
Settings** tab.

<img alt="Integration Settings Setup Flow Toggles" />

## Showing the Setup Flow to your customers

Setup Flow steps run automatically as part of the [Connection
Flow](/kombo-connect) the first time a customer connects a tool, so the
embedded flow you already have in place will pick them up without any changes.

To send customers back into the Setup Flow later, for example to update field
mappings or change which employees are synced, create a setup link with the
[Create Setup Flow link
endpoint](../../v1/post-integrations-integration-id-setup-link) and pass it to
`showKomboConnect` from the [Kombo Connect
SDK](../../guides/connect/embedded-flow#opening-the-flow), the same way you do
with a connection link.

You can also generate a setup link from the Integration Details page in the
Dashboard if you'd rather not wire up the API yourself.


# Upstream filtering
Source: https://docs.kombo.dev/ats/features/upstream-filtering

Filter candidate and application sync to recent data only for improved performance.

As an AI screening provider or assessment platform, you typically only need
current and up-to-date candidate applications, not historical data that
accumulates in ATS systems over time. Kombo's upstream filtering feature allows
you to significantly reduce sync times and data processing overhead by filtering
candidates and applications to only those updated within a specific timeframe.

This solution is a "best effort" solution. We do not guarantee that all data
will match the filters exactly. Not all integrations support the nessesary
filtering granularity. If you are building workflows on your side that rely on
specific filters, please filter on our API or during processing in your system
as well.

## Performance benefits

Upstream filtering provides substantial performance improvements:

* **Faster sync times**: Dramatically reduce the time needed to synchronize data
  from large ATS systems
* **Reduced data volume**: Process only relevant, recent applications instead of
  entire historical datasets
* **Improved reliability**: Smaller datasets reduce the likelihood of sync
  timeouts and failures

This is especially valuable when working with enterprise customers whose ATS
systems may contain thousands of historical applications that are irrelevant for
current assessment workflows.

## Filtering options

You can configure upstream filtering using two approaches:

### Cutoff date

Set a specific date after which candidates and applications should be
synchronized. Only records updated after this date will be included in syncs.

**Use case**: You want to start fresh from a specific point in time, ignoring
all historical data before a certain date.

### Rolling duration

Specify a number of days to look back from the current date. Only candidates and
applications updated within this rolling window will be synchronized.

**Use case**: You want to maintain a consistent window of recent data (e.g.,
always sync applications with activities from the last 90 days).

## Configuration

<img alt="Upstream filtering configuration" />

Navigate to your integration settings and configure the sync mode to "Sync all
candidates" with upstream filtering enabled.

<Note>
  Upstream filtering is not compatible with the [Sync created candidates
  only](/ats/features/application-status-tracking#syncing-only-created-candidates)
  sync mode.
</Note>

## Implementation considerations

When using upstream filtering:

* **Only filtered data**: We apply the filters while syncing data from the ATS.
  If you modify the filter, previously synced data outside the filter window
  will get deleted from our system after 14 days.
* **Filter changes**: Adjusting filter parameters may cause some applications to
  fall outside the sync scope.
* **Integration compatibility**: Most ATS integrations support upstream
  filtering, though the exact implementation may vary
* **Webhook compatibility**: Upstream filters only apply to get recently changed
  data, so anything that would trigger a webhook on the ATS, will usually bring
  back the candidate and application to be synced as well.


# Overview
Source: https://docs.kombo.dev/ats/getting-started

Let's get you up and running with our API!

<Note>
  This guide assumes you already have a Kombo account. If that's not the case,
  visit [our website](https://www.kombo.dev/) to learn more and get access.
</Note>

# Getting started

There are a few simple steps that you should follow to get started with our API.

1. [Get access to a sandbox integration](./getting-started/sandbox-integrations)
2. [Create an integration](./getting-started/create-integrations)
3. [Call our API](./getting-started/authentication)
4. [Querying the API](./getting-started/querying-api)
5. [Fetching Data](./getting-started/fetching-data)


# Authentication
Source: https://docs.kombo.dev/ats/getting-started/authentication

Learn how to authenticate with the Kombo API and manage API keys securely.

## Authentication

You need to get an API key from the Kombo dashboard to call our API.
You can create one on the [Secrets page](https://app.kombo.dev/secrets).

You might have multiple environments in your Kombo account. Each API key is
specific to an environment.

This will allow you to call some general endpoints that are not
integration-specific. For example, try calling the following test API key endpoint:

```bash theme={null}
curl --request GET \
  --url https://api.kombo.dev/v1/check-api-key \
  --header 'Authorization: Bearer <YOUR_API_KEY>'
```

## Calling Integration Endpoints

To call integration-specific endpoints, you need the integration ID. An integration ID identifies a specific
instance of a tool connected to Kombo. If you haven't created an integration yet,
read the [creating integrations guide](./create-integrations).
Get the integration ID from the details of integration on the [integrations dashboard page](https://app.kombo.dev/integrations).

Pass the integration ID with the `X-Integration-Id` header in your API requests. For example:

```bash theme={null}
curl --request GET \
  --url https://api.kombo.dev/v1/hris/employees \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'X-Integration-Id: <integration_id>'
```

<Note>
  Find out more about the integration-specific endpoints for
  [HRIS](/hris/getting-started) or [ATS](/ats/getting-started)
</Note>

## API Key Security

Kombo provides several features to help you manage API keys securely.

### Key Scoping

Each API key is scoped to a single [environment](../guides/environments) (Production or Development). Keys created in Production cannot access Development data and vice versa. The key prefix reflects the environment: `ks_prod_...` for production, `ks_dev_...` for development.

### Expiration

When creating an API key, you can set an optional expiration date. Once expired, any request using the key will return an authentication error. To rotate keys without downtime, you must overlap the old and new keys: create a new key, migrate all of your services to use it, and only then let the old key expire (or revoke it).

### IP Allowlisting

You can restrict each API key to a set of IP addresses or CIDR ranges. When an allowlist is configured, requests from non-listed IPs are rejected. An empty allowlist (the default) permits any IP. You can update the allowlist at any time without recreating the key.

### Revocation

API keys can be individually disabled from the dashboard. Disabling a key takes effect immediately — all subsequent requests using that key will fail. Disabled keys cannot be re-enabled; create a new key instead.

### Audit Trail

All key operations — creation, disabling, and IP allowlist changes — are recorded in the [audit log](../features/audit-logs).


# Creating Integrations
Source: https://docs.kombo.dev/ats/getting-started/create-integrations

Learn how to connect tools to Kombo.

<Note>
  This guide assumes you already have a Kombo account. If that's not the case,
  visit [our website](https://www.kombo.dev/) to learn more and get access.
</Note>

## Ways of Creating Integrations

There are three ways of creating integrations in Kombo:

1. **For you in development**: Use the Kombo Dashboard and enter the integration credentials yourself.
   This is the easiest way to get started if you want to test out Kombo.
2. **For customers with a magic link**: Create a magic link and send that to your customer to create the integration.
   This is the simplest way to launch integrations for selected customers (for example, as a POC).
3. **For customers with Kombo embedded**: Embedding Kombo into your application and allowing the customer to create the integration there.
   This will give your customer the best experience and is generally recommended when rolling out Kombo to your customers.

If you are testing Kombo or developing the integration to us, make sure to
select the development environment in the top left corner.
This will not count against your billing and will have useful features like saving
the credentials that you entered and filled out some fields by default.

# Creating Integrations in the Dashboard

<Tip>Recommended for development purposes.</Tip>

Go to the [dashboard integrations page](https://app.kombo.dev/integrations) and
click on the "Create Integration" button. Select `Create the integration yourself`.

<Frame>
  <img alt="image" />
</Frame>

Select a category and continue (if you use the development environment,
the organization and email will be auto-filled). Select a tool that you have
access to and enter the credentials. The flow will explain, in most cases, what
you need to do to get the credentials out of the tool.

# Creating a magic link

<Info>Use this to get started immediately with a selected customer.</Info>

Open the [dashboard integrations page](https://app.kombo.dev/integrations) and
click on the "Create Integration" button. Select *Let your customer create the integration*.

Select the category and fill out the organization name and email address.
This data is only for you to identify who created the integration and will be used
as a label in the dashboard.

Features that you can use with the embedded flow are:

* Pre-defining a tool
* Defining a language

# Embedding Kombo into your Application

<Info>
  This is only necessary if you want to allow your customer to create
  integrations completely on their own.
</Info>

Embedding Kombo in your application requires implementing the Kombo API into your product.
Embedding Kombo allows you to provide a better experience to your customers and customize the
connection flow the most.

Features that you can use with the embedded flow are:

* Pre-defining a tool
* Defining a language
* Specifying the `remote_environment` (for using sandbox credentials with some tools)
* Using a scope config template
* Setting the `origin_id` (id of the customer in your system)

<Note>
  Read more about embedding Kombo into your application
  [here](../guides/connect/embedded-flow).
</Note>


# Fetching Data
Source: https://docs.kombo.dev/ats/getting-started/fetching-data

Learn how to get the newest data back from Kombo.

To minimize latency between data changes in the connected tool and your system,
and to prevent data drift, we recommend combining data-changed notifications
with periodic full fetches.

Best-practice implementation:

* Listen to our **data-changed webhook** to receive notifications of data
  changes.
* Fetch only updated data.
* Periodically **fetch all data** to fully align your dataset and correct any
  potential data drift.
* Combine both strategies for a setup that is robust and efficient.

## Overview

```mermaid theme={null}
sequenceDiagram
    participant K as Kombo
    participant YS as Your System
    participant T as Timer

    Note over K,YS: Data-changed notifications
    K->>YS: Webhook: Data Changed
    YS->>K: Fetch Updated Data
    K-->>YS: Updated Data Response

    Note over T,YS: Periodic full fetch
    T->>YS: Periodic Trigger
    YS->>K: Fetch All Data
    K-->>YS: Full Data Response
```

## Listening to data-changed webhook

We provide a webhook called `data-changed`. This is sent to your system whenever
data has changed inside Kombo. For example, after:

* We finish syncing (full or delta sync)
* We receive an update through [upstream
  webhooks](/ats/guides/upstream-webhooks)

By listening to this webhook, you can receive updates from Kombo efficiently,
allowing for the best possible UX.

<Note>
  For near real-time updates, the connected tool must have upstream webhooks
  enabled for the integration. Some tools allow Kombo to enable these
  automatically, while others require a one-time manual step in the
  integration's Setup Flow by the end-customer. If upstream webhooks are not
  enabled or not supported, `data-changed` will reflect updates after the next
  scheduled sync.
</Note>

The webhook will look similar to this, with an array of models that have changed
in our database since we last sent you that webhook:

```json theme={null}
{
  "id": "FhghqjnCi9WuAoLT8Z75CFcs",
  "type": "data-changed",
  "data": {
    "integration_id": "bombohr:ats-dev",
    "integration_tool": "bombohr",
    "integration_category": "ATS",
    "changed_models": [
      {
        "name": "ats_applications"
      }
    ]
  }
}
```

**Simplified approach**

To make things simple, you can, whenever you receive a new data-changed webhook,
pull the models you're interested in, independent of the models we're telling
you changed.

**Recommended approach**

You can also listen to the data models we're telling you changed and pull data
based on those models. For that please look into the [list of
models](#all-models) that can appear.

Based on this list of changed models, figure out which requests you would like
to send. Keep in mind that models do not map 1:1 to our endpoints. For example,
you might be using the `/candidates` endpoint to fetch both candidates and their
applications.

Furthermore, after every successful fetch from us, store the timestamp of when
the respective fetch started. Use this timestamp during your next fetch and pass
it with your requests to the Kombo API as the `updated_after` query parameter.
Kombo will then only return the entries that changed since that timestamp. Read
more about this
[here](/ats/implementation-guide/reading-jobs#getting-updates-on-the-data).

**Good to know:** The `updated_after` filter also considers changes in models
that are returned by the endpoint as nested values. For example, the
`/candidates` endpoint will include every candidate that has had changes to
their list of applications, even if the candidate profile itself did not change.

## All models

You should call the endpoints you care about based on the models we tell you
have changed. The following table shows endpoints connected to the relevant
models that will be part of the data-changed webhook.

We recommend the following approach:

1. **Decide which endpoints are relevant for your use case** (e.g., if your
   system is centered around applications, you primarily use Get Applications).
2. **Map changed models to those endpoints** using the table.<br />For instance,
   if both ats\_applications and ats\_candidates are listed in the webhook, but
   you primarily care about applications, you only need to call Get
   applications, since candidate data is included there too.

This helps avoid unnecessary API calls while still ensuring your data is up to
date.

| **Endpoint**                                               | **Models**                                                                                                                                                                                                                      |
| ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [**Get applications**](/ats/v1/get-applications)           | ats\_applications<br />ats\_application\_stages<br />ats\_candidates<br />ats\_interviews<br />ats\_jobs<br />ats\_join\_candidates\_tags<br />ats\_offers<br />ats\_tags                                                       |
| [**Get candidates**](/ats/v1/get-candidates)               | ats\_candidates<br />ats\_application\_stages<br />ats\_applications<br />ats\_jobs<br />ats\_join\_candidates\_tags<br />ats\_join\_jobs\_application\_stages<br />ats\_tags                                                   |
| [**Get interviews**](/ats/v1/get-interviews)               | ats\_interviews<br />ats\_applications<br />ats\_candidates<br />ats\_jobs<br />ats\_join\_interviews\_users<br />ats\_users                                                                                                    |
| [**Get jobs**](/ats/v1/get-jobs)                           | ats\_jobs<br />ats\_application\_stages<br />ats\_job\_postings<br />ats\_join\_jobs\_application\_stages<br />ats\_join\_jobs\_screening\_questions<br />ats\_join\_jobs\_users<br />ats\_screening\_questions<br />ats\_users |
| [**Get offers**](/ats/v1/get-offers)                       | ats\_offers<br />ats\_applications<br />ats\_candidates<br />ats\_jobs                                                                                                                                                          |
| [**Get rejection reasons**](/ats/v1/get-rejection-reasons) | ats\_rejection\_reasons                                                                                                                                                                                                         |

## Preventing Data Drift

In addition to fetching data from Kombo's endpoints in response to receiving the
data-changed webhook, we recommend running a periodic full data fetch for the
data models you care about. In most cases, a 7-day schedule is ideal.

This helps to remedy any drift that may occur in your data, e.g. from accidental
manual changes or lost webhooks.

To implement this, perform GET requests for the Kombo data models you care about
without passing the `updated_after` query parameter. Then upsert the data
returned by Kombo and merge it with your existing data copy.

## Full Example Code

```ts theme={null}
async function handleDataChangedWebhook(body) {
  // Verify webhook sender here

  // Assuming we are using prisma as our ORM
  const integration = await prisma.integration.findUniqueOrThrow({
    where: {
      kombo_integration_id: body.data.integration_id,
    },
    select: {
      id: true, // Need the customer ID for the update
      last_fetched_from_kombo_at: true,
      kombo_integration_id: true, // Also select the integration ID
    },
  })

  // Track when WE start fetching (not when Kombo synced from the ATS)
  const fetchStartDate = new Date() // This time should be in UTC
  const lastFetchStartDate =
    integration.last_fetched_from_kombo_at?.toISOString()

  // Fetch data only when data-changed webhook indicates a change
  const applicationsChanged = !!body.data.changed_models.find(
    entry => entry.name === 'ats_applications',
  )
  if (applicationsChanged) {
    await fetchApplications(
      integration.kombo_integration_id,
      lastFetchStartDate,
    )
  }

  await prisma.integration.update({
    where: {
      id: integration.id,
    },
    data: {
      last_fetched_from_kombo_at: fetchStartDate,
    },
  })
}

async function handleCronJob(integration) {
  const fetchStartDate = new Date() // This time should be in UTC

  // Do not pass a starting date here; fetch everything
  // Fetch the models you care about (repeat for applications, candidates, jobs, ...)
  await fetchApplications(integration.kombo_integration_id)

  await prisma.integration.update({
    where: {
      id: integration.id,
    },
    data: {
      last_fetched_from_kombo_at: fetchStartDate,
    },
  })
}

async function fetchApplications(integrationId: string, updatedAfter?: string) {
  let cursor
  do {
    const resp = await axios.get('https://api.kombo.dev/v1/ats/applications', {
      headers: {
        Authorization: `Bearer ${KOMBO_API_KEY}`,
        'X-Integration-Id': integrationId, // Use the stored integration ID
      },
      params: {
        cursor: cursor,
        updated_after: updatedAfter,
      },
    })

    cursor = resp.data.data.next

    // Implement your handling logic here
    // Usually, you will upsert the data into your database and build specific
    // domain logic here.
    await handleApplicationData(integrationId, resp.data.data.results)
  } while (cursor)
}
```

## Understanding `changed_at` vs `updated_after` Behavior

A common source of confusion is understanding when records are returned by the
`updated_after` filter and how this relates to each record's `changed_at`
timestamp. Here's the key distinction:

### Record-level `changed_at` Field

Each record has a `changed_at` timestamp that **only updates when properties
directly on that record change**. For example:

* If a candidate's `first_name` changes, the candidate's `changed_at` updates
* If an application's `current_stage_id` changes, the application's `changed_at`
  updates
* **However**: If a candidate's name changes, related applications' `changed_at`
  fields do **NOT** update

### Endpoint Filtering with `updated_after`

The `updated_after` parameter works differently - it returns records when
**either the record itself OR its nested data has been updated**:

#### Example: Applications Endpoint

When you call `GET /applications` with `updated_after`, you'll receive
applications if:

1. **Direct application changes**: The application itself was modified (stage
   change, rejection, etc.)
2. **Nested candidate changes**: The candidate's data was updated (name, email,
   etc.)

This means an application can be returned even if its own `changed_at` timestamp
hasn't changed.

#### Concrete Scenario

Let's say you call `GET /applications` at 9:00 AM and get:

```json theme={null}
{
  "id": "app123",
  "changed_at": "2023-10-01T08:00:00Z",
  "candidate": {
    "id": "cand456",
    "first_name": "John",
    "changed_at": "2023-10-01T08:00:00Z"
  }
}
```

At 10:00 AM, the candidate's name is changed to "Mike" in the ATS. If you then
call `GET /applications?updated_after=2023-10-01T09:00:00Z`, you'll receive:

```json theme={null}
{
  "id": "app123",
  "changed_at": "2023-10-01T08:00:00Z", // ← Same timestamp!
  "candidate": {
    "id": "cand456",
    "first_name": "Mike", // ← Updated data
    "changed_at": "2023-10-01T10:00:00Z" // ← New timestamp
  }
}
```

**Key Point**: The application's `changed_at` remains unchanged, but the
application is still returned because it contains updated nested data.

### Best Practice

When using `updated_after` filtering:

1. **Don't assume** a record was directly modified just because it's returned
2. **Compare nested data** to determine what actually changed
3. **Use the nested objects' `changed_at` fields** to identify which parts were
   updated
4. **Design your sync logic** to handle both direct and indirect changes

## FAQ

### Why do you not provide the changed data inside of data-changed?

We want to make integrating with Kombo as simple as possible for you. Since we
recommend running occasional full fetches anyways, it means you can re-use most
of your logic for both fetch types. Furthermore, this allows you to iterate and
upsert data at your own pace. Unlike if we were to send you a *really* large
payload after an initial sync. By listening to just this single unified webhook,
you are always guaranteed to benefit from our latest innovations to help you get
the freshest data.

### How often do you send the data-changed event? Do you debounce the webhook?

Yes, by default we debounce data-changed with a 30-second window. That means no
matter how many events we're receiving, you'll receive at most one webhook every
30 seconds.

This works as follows: The first time this event fires, we will pass it through
to you right away. Then we will wait 30 seconds. All the events we receive in
those 30 seconds will then be sent to you as a single update with the next
webhook.

For more details, please refer to the
[webhooks](/ats/guides/webhooks#data-changed) page.


# Querying the API
Source: https://docs.kombo.dev/ats/getting-started/querying-api

Learn how to filter and paginate the Kombo `GET` endpoints. This will help you implement incremental fetching and more.

## SDKs

You can use our officially supported SDKs to interact with our API. For more information, see the [Libraries and SDKs](/libraries-and-sdks) section.

## General Response Format

All *GET* endpoints of Kombo follow the same principle. All of them return a list
of results and a next cursor. All results follow the same basic structure with the
following properties:

* `id`: An ID generated by Kombo, also referred to throughout the documentation as "Kombo ID".
* `remote_id`: The ID of the object in the remote system. This can be null for some objects.
* `changed_at`: Part of Kombo's change tracking — this is the timestamp of the last change that was detected by Kombo.
* `remote_deleted_at`: Part of Kombo's change tracking — this is the timestamp where the object was not found anymore in the remote system.

*Other properties are model-specific.*

### A note on Kombo IDs and their uniqueness

We generate the Kombo ID by referencing the remote ID and the integration ID.

This results in the following statements being true:

* A Kombo ID is unique across all integrations for *the same model*.
  * This is because we reference the integration ID itself when generating the Kombo ID.
* A Kombo ID is *not* unique across different models for the same integration.
  * This will occur for remote systems that follow a sequential ID pattern. For example, both the first employee and department have the ID `1`. As the integration ID is the same, so will the Kombo ID.

## Pagination

Each request returns either a value on the `next` field or `null`. The
value will be a cursor which you can use to get the next page of results. Use
the `cursor` query parameter to request the next page. (Please note that you
still need to add the relevant filters while paginating.)

In addition, you can use the `page_size` parameter to specify the number of results per page.

```bash theme={null}
curl --request GET \
  --url 'https://api.kombo.dev/v1/hris/employees?cursor=eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0&page_size=100' \
  --header 'Authorization: Bearer <YOUR_API_KEY>'
```

## Filtering

All models provide the same filters in addition to some model-specific filters.
The following filters apply to all models:

* `updated_after`: Only return objects where the `changed_at` value is after
  the given timestamp. This can be used to fetch data incrementally.
  This filter also includes all expanded relations — so if only they have
  changed (but none of the primary attributes of the object), this will still
  count as the object having changed and it will still be returned.
* `include_deleted`: By default, all values with a `remote_deleted_at` value are
  not returned. If you want to include them, set this to `true`. This is helpful
  if you want to remove them from your database.
* `ids`: List of comma-separated ids. Only return objects with these IDs.
* `remote_ids`: List of comma-separated remote ids. Only return objects with
  these remote IDs.

## Error Codes

When the Kombo API encounters an error, it returns a structured error response with a specific `code` for programmatic handling.
For a complete list of error codes and detailed explanations see the [Error Handling guide](/guides/errors).

```json theme={null}
{
  "status": "error",
  "error": {
    "code": "REMOTE.INPUT_INVALID",
    "title": "The remote system returned validation errors.",
    "message": "Candidate field 'email' must be a valid email address for Greenhouse"
  }
}
```

## Rate limiting

The rate limiter restricts the number of API requests you can send to Kombo. Currently, we permit 300 requests over 60 seconds **per environment** (i.e., PROD or DEV environment). After the time window has passed, the limit is reset. If you need a higher quota, reach out to the Kombo team.

Independent of this cap, [concurrency limiting](../guides/concurrency-limiting) limits how many unified actions can run at the same time per integration.

This information is exposed as headers on the response of every authenticated API request:

| Header              | Sample Value | Description                                           |
| ------------------- | ------------ | ----------------------------------------------------- |
| ratelimit-limit     | 300          | The maximum number of requests permitted              |
| ratelimit-remaining | 298          | The remaining number of requests permitted            |
| ratelimit-reset     | 57           | The remaining seconds until the rate limiter is reset |

When exceeded, you will receive a failed response with the [error `code`](/guides/errors) of `PLATFORM.RATE_LIMIT_EXCEEDED`:

```json theme={null}
{
  "status": "error",
  "error": {
    "code": "PLATFORM.RATE_LIMIT_EXCEEDED",
    "title": "Rate limit exceeded.",
    "message": "Maximum requests are 300 every 60 seconds. Try again in 57 seconds.",
    "log_url": null
  }
}
```

### Concurrency limiting

In addition to rate limiting, Kombo applies [concurrency limiting](../guides/concurrency-limiting) to unified actions. While rate limiting caps total requests over a time window, concurrency limiting caps simultaneous in-flight unified actions per integration to prevent backpressure buildup on downstream tools. Endpoints for reading synced model data are not affected by concurrency limiting.

### Handling 429 responses

Both rate limiting and concurrency limiting return HTTP `429`, but they have different error codes and require different responses:

* **`PLATFORM.RATE_LIMIT_EXCEEDED`** -- You've sent too many requests in the current time window. This applies to all endpoints. Wait for `ratelimit-reset` seconds or retry with exponential backoff.
* **`PLATFORM.CONCURRENCY_LIMIT_EXCEEDED`** -- Too many unified actions are in flight for this integration. The underlying tool can't keep up. Retry the failed request after a short backoff (e.g., 1s, 2s, 4s). You likely still have rate limit quota remaining, so waiting for `ratelimit-reset` is unnecessary. See the [concurrency limiting guide](../guides/concurrency-limiting) for details.


# Remote Data
Source: https://docs.kombo.dev/ats/getting-started/remote-data

Learn how to use remote data to access any available field.

Remote data is a feature exposing the raw, unchanged data
that we receive from the APIs, allowing you to read data that might
not be available in our unified API model.

It is disabled by default because it has compliance implications
(we need to store all data we receive, not just the data points selected in the
scope configs) and because you will need to write parsing logic for each
integration/tool.

It is mainly used to read data that might not be available in our unified Data Models.
Some customers are for example interested in some specific government-issued
company IDs, which are currently not part of our Data Model, but can be extracted
from these raw responses. An example response might be:

```json theme={null}
{
  "status": "success",
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "first_name": "John",
        "last_name": "Doe",
        ...
        "remote_data": {
          "EmployeeData": {
            "Names": {
              "FirstName": "John",
              "LastName": "Doe"
            },
            "Company": {
              "GovernmentID": "123456789"
            }
          }
        }
      }
    ]
  }
}
```

<Info>
  `remote_data` gives you the raw API response from the connected system. If you
  need **structured** extra fields for reading, see [Custom
  Fields](../features/custom-fields). If you need to **write** additional data
  when creating records, see [Remote
  Fields](/extending-the-model#remote-fields).
</Info>

## When to use remote data

Remote data should be used when our unified Data Model does not offer specific
fields that you are interested in. Note that we do not unify remote data, so the
data structure might differ between tools and might even differ between
individual integrations of the same tool.

## When not to use remote data

Remote data might potentially expose sensitive data, even if your customers
opt out of it. We might, for example, always receive personally identifiable
information (e.g. emails, names and addresses). If your customers opt out of
these data fields, we will discard this data and never store it.
If remote data is active, however, we will expose the raw responses and therefore
information that should optimally not be stored.

We also offer [custom fields](../features/custom-fields), which are a more versatile and compliant variant
of remote data.

## How to use remote data

Remote data can be enabled on a per-model basis in the scope config. To enable
it, please contact us.


# Sandbox Integrations
Source: https://docs.kombo.dev/ats/getting-started/sandbox-integrations

Learn how to access tools you can connect to Kombo for development purposes.

If you wish to get started as quickly as possible, use our built-in **Sandbox Integration (HRIS/ATS/LMS)**.
You can find it in the **"Integrations"** section in the Kombo dashboard. The sandbox integration
is only available in your [development environment](../guides/environments#development).

<Card title="Sandbox Integration" icon="flask" href="../connectors/sandbox">
  Connect the built-in sandbox to start exploring the API right away — no
  credentials required.
</Card>

### What the sandbox covers

The sandbox requires **no credentials** and can be set up in minutes. It
provides a representative dataset that covers common edge cases you'll encounter
in production — including active, terminated, and pending employees, multiple
currencies, and various bank account formats.

**Read data** — the sandbox includes data for all major models:

* **HRIS**: Employees, employments, groups, locations, legal entities, absences,
  absence types, time-off balances, timesheets, performance reviews, skills,
  and employee skill proficiency ratings
* **ATS**: Candidates, applications, jobs, job posts, stages, offers,
  interviews, rejection reasons, users
* **LMS**: Users, courses, skills, providers, progress records

**Write actions** — all major write operations work against the sandbox:

* **HRIS**: Create employees, create/delete absences, upsert employee skill
  proficiency ratings
* **ATS**: Create candidates (with applications), move applications to stages,
  add attachments, add/remove tags, add notes
* **LMS**: Enroll users, mark completions, create and manage courses

The sandbox dataset is **deterministic** — syncs always return the same base
data, making it well-suited for automated testing with stable assertions.
Records created through write actions persist in Kombo's database and appear in
subsequent API calls, but don't modify the base dataset.

### Third-party sandboxes

Some tools also offer free demo accounts that you can use to test out Kombo.

We recommend the following tools, as they provide great coverage and are broadly used:

* When testing HRIS integrations, we recommend using [Personio](https://www.personio.com/free-trial/).
* When testing ATS integrations, we recommend using [Recruitee](https://auth.recruitee.com/sign-up). If you want to gain access to a sandbox instead of using the free trial, please fill out [this form](https://www.tellent.com/technology-partner-application). In the section “Please describe the use case for this integration on a high-level”, mention “Referred by Kombo”.

Additionally, here are some more tools that offer free trials or test accounts: [BambooHR (HRIS)](https://www.bamboohr.com/signup/), [Sage HR (HRIS/ATS)](https://sage.hr/register), [Deel (HRIS)](https://app.deel.com/signup), [CharlieHR (HRIS)](https://www.charliehr.com/join), [Planday (HRIS)](https://www.planday.com/signup/), [Factorial (HRIS)](https://factorialhr.com/get-started), [Humaans (HRIS)](https://app.humaans.io/signup), [BreezyHR (ATS)](https://breezy.hr/signup), [Jazzhr (ATS)](https://info.jazzhr.com/free-trial.html), [Join (ATS)](https://join.com/auth/signup/recruiter), [Teamtailor (ATS)](https://tt.teamtailor.com/users/new?locale=en), [Workable (ATS)](https://www.workable.com/free-trial)

### Enterprise tools

Enterprise tools like Workday, SAP SuccessFactors, or SmartRecruiters usually
don't offer free sandbox access. However, for customers on the enterprise plan,
we offer joint testing sessions with these enterprise tools.


# Concurrency Limiting
Source: https://docs.kombo.dev/ats/guides/concurrency-limiting

Concurrency limiting caps simultaneous in-flight unified actions per integration, giving you fast feedback instead of slow timeouts.

## What is concurrency limiting?

When you invoke unified actions in Kombo (e.g., creating a candidate, moving
an application, reading attachments), each call is forwarded to the underlying HR or ATS tool.
These tools have their own rate limits, which are often significantly lower than
what Kombo allows.

If many unified actions run in parallel, they all compete for limited
downstream throughput. Completion times grow, your HTTP clients may hit
timeouts while work is still in flight, and retries can overlap with operations
that are still running.

Concurrency limiting solves this by capping how many unified actions
can be processed simultaneously per integration. When the cap is
reached, additional requests are immediately rejected with a `429` status code.
This gives you a fast, clear signal to retry with backoff instead of stacking
unbounded in-flight work that might eventually time out on your side.

<Note>
  Concurrency limiting only applies to unified actions (calls that run work
  against the underlying tool). Model endpoints for reading synced data are not
  affected.
</Note>

<Frame>
  <img alt="Two-panel diagram comparing overload (client timeout before completion, ambiguous retries) with concurrency limiting (429 and controlled in-flight work)." />
</Frame>

## How it differs from rate limiting

For Kombo-wide request volume over time, see [Rate limiting](../getting-started/querying-api#rate-limiting).

|                    | Rate Limiting                  | Concurrency Limiting                  |
| ------------------ | ------------------------------ | ------------------------------------- |
| **What it caps**   | Total requests per time window | Simultaneous in-flight requests       |
| **Scope**          | All API requests               | Unified actions only                  |
| **When it resets** | After the time window elapses  | As in-flight requests complete        |
| **Error code**     | `PLATFORM.RATE_LIMIT_EXCEEDED` | `PLATFORM.CONCURRENCY_LIMIT_EXCEEDED` |

Both return HTTP `429`, but with different error codes and headers.

## Response headers

When concurrency limiting is active, every unified action response includes two headers:

| Header                  | Example | Description                                                                             |
| ----------------------- | ------- | --------------------------------------------------------------------------------------- |
| `Concurrency-Limit`     | `30`    | The maximum number of concurrent in-flight unified actions allowed for this integration |
| `Concurrency-Remaining` | `12`    | How many additional concurrent unified actions can be accepted right now                |

The limit may vary per integration. Sensitive integrations (e.g.,
reverse-engineered APIs) may have significantly lower limits. Use the response
headers to discover the actual limit rather than assuming a specific number. The
default limit is 30.

These headers appear on both successful responses and `429` rejections, so you can monitor utilization proactively.

## Handling concurrency limit errors

When you exceed the concurrency limit, you receive a `429` response with the error code `PLATFORM.CONCURRENCY_LIMIT_EXCEEDED`. The response includes both concurrency and rate limit headers:

```
HTTP/1.1 429
concurrency-limit: 30
concurrency-remaining: 0
ratelimit-limit: 1000
ratelimit-remaining: 834
ratelimit-reset: 44
```

```json theme={null}
{
  "status": "error",
  "error": {
    "code": "PLATFORM.CONCURRENCY_LIMIT_EXCEEDED",
    "title": "Concurrency limit exceeded.",
    "message": "Maximum concurrent action requests per integration is 30. Currently 30 in flight."
  }
}
```

Notice how the rate limit headers show remaining quota (`ratelimit-remaining: 834`) while the concurrency headers show no remaining slots (`concurrency-remaining: 0`). This tells you:

* The underlying tool is at capacity for this integration, not Kombo itself.
* You still have rate limit quota, so waiting for `ratelimit-reset` is unnecessary.
* Slots free up quickly as in-flight requests complete, so a short retry is effective.

### How to retry

For `PLATFORM.CONCURRENCY_LIMIT_EXCEEDED`, retrying the same request is
expected and does not run the unified action twice. Kombo rejects the call
before the unified action runs (no concurrency slot was acquired). That differs
from failures where the outcome is unclear, e.g., a timeout after a write may
still have succeeded, so retries need extra care.

1. Retry the failed request with exponential backoff: start with a short delay (e.g., 1s) and increase on repeated `429`s (2s, 4s, 8s, ...).
2. Optionally, throttle proactively: check `Concurrency-Remaining` on successful responses to slow down before hitting the limit.

## What this means for your integration

Concurrency limiting does not cap steady-state throughput below what the
downstream tool can sustain. The integrated system still bounds how fast work
completes. The limit turns that constraint into immediate `429` responses
instead of long waits and unbounded in-flight unified actions.


# Embedded flow
Source: https://docs.kombo.dev/ats/guides/connect/embedded-flow

Embed Kombo Connect into your app for the most seamless experience.

If you've gone through the general [Kombo Connect](./introduction) documentation,
you'll know there are
[different ways of using the flow](./introduction#getting-started). Our embedded flow
provides the most seamless experience to your customers but also involves some
engineering on your side. In this guide, we'll go over what that means exactly.

## Implementing the flow

The embedded flow requires you to:

* Add an **endpoint** to your back-end for initiating the flow
* Add a **button** to your frontend to show the flow to your user using the SDK
* React to a flow being completed through the "activation token" returned by the SDK or by listening to a webhook

Let's go over each of these steps in detail.

### Adding the endpoints

Both endpoints are mostly just wrappers around endpoints of the Kombo API and
mainly exist for security reasons (so that malicious actors can't set up
arbitrary integrations in your Kombo environment).

#### Initiating the flow

The first one initializes the flow by calling the Kombo API and returns a link
that we then use in the frontend:

```js Node.js (Express + Axios) theme={null}
app.post('/integrations/kombo/init', async (req, res) => {
  // TODO: Get user details from your database
  const user = await getUser()

  const response = await axios.post(
    'https://api.kombo.dev/v1/connect/create-link',
    {
      end_user_email: user.email,
      end_user_organization_name: user.company.name,
      end_user_origin_id: user.company.id,

      integration_category: 'HRIS',
    },
    {
      headers: {
        authorization: `Bearer ${KOMBO_API_KEY}`,
      },
    },
  )

  res.send({ link: response.data.data.link })
})
```

The `end_user_*` fields identify which of your customers an integration belongs to:

* **`end_user_email`** (required): Contact email for this end user. Used as a label in the dashboard and included in webhooks.
* **`end_user_organization_name`** (required): Company name. Used as a label in the dashboard and included in webhooks.
* **`end_user_origin_id`** (optional): Your internal ID for this customer. Echoed back in webhooks and API responses so you can map integrations to your own records.

These fields are metadata — they do not affect integration identity. Changing the email or organization name in a subsequent `create-link` call with the same `end_user_origin_id` does **not** update an existing integration; it creates a new flow link.

<Warning>
  Kombo does **not** deduplicate integrations based on these fields. Each
  completed flow creates a new integration. You are responsible for preventing
  customers from connecting the same tool twice. Use the [reconnection
  link](../../v1/post-integrations-integration-id-relink) if a customer needs to
  update their credentials for an existing integration.
</Warning>

#### Reacting to the flow being completed

After your user completes the flow, you can retrieve the integration details and store them in your database for future use. There are two ways to achieve this:

1. By using the ["Get integration by token" endpoint](../../v1/get-connect-integration-by-token-token)
2. By listening to the `integration-created` webhook

**Option 1: Using the endpoint**

The activation token is returned from the frontend after the user completes the integration flow. You can use this token to retrieve the integration details via the ["Get integration by token" endpoint](../../v1/get-connect-integration-by-token-token) and store them in your database.

Here's how you might implement the activation endpoint:

```js Node.js (Express + Axios) theme={null}
app.post('/integrations/kombo/activate', async (req, res) => {
  const response = await axios.get(
    `https://api.kombo.dev/v1/connect/integration-by-token/${req.body.token}`,
    {
      headers: {
        authorization: `Bearer ${KOMBO_API_KEY}`,
      },
    },
  )

  const integrationId = response.data.data.id

  // TODO: Store the integration ID in your database

  res.sendStatus(200)
})
```

**Option 2: Listening to the `integration-created` Webhook**

Alternatively, you can set up a webhook endpoint on your backend to listen for the `integration-created` event that Kombo sends when a new integration is created. This webhook contains the integration ID and other relevant details, allowing you to associate the integration with your user in your database.

Here's how you might set up the webhook endpoint:

```js Node.js (Express) theme={null}
app.post('/webhooks/kombo/integration-created', async (req, res) => {
  const integration = req.body.data

  // TODO: Verify the webhook signature for security purposes

  // TODO: Store the integration ID in your database

  res.sendStatus(200)
})
```

* Make sure to [verify the webhook signature](../../guides/webhooks#validate-the-data) to ensure that the request comes from Kombo.
* Make sure to set up the webhook in the [dashboard](https://app.kombo.dev/configuration/webhooks).

### Adding the button

For now, we're all set on the back-end side, so let's switch to the front-end:

Here we'll have to add a button that lets your users start the flow. Most of our
customers already have an "Integrations" page within their product's settings.
If you do, too, then that's the perfect place to add the button.

How exactly you're going to do this will depend on your tech stack, but it's
probably going to look something like this:

<CodeGroup>
  ```jsx React theme={null}
  <button onClick={() => connectHris()}>Connect HRIS</button>
  ```

  ```jsx Vue.js theme={null}
  <button @click="connectHris()">
    Connect HRIS
  </button>
  ```

  ```html HTML theme={null}
  <button onclick="connectHris()">Connect HRIS</button>
  ```
</CodeGroup>

<br />

<Note>
  Right now, we require you to specify the integration category when
  initializing the flow, so you'll likely want to label your button accordingly
  (e.g., "Connect HRIS" or "Connect ATS").
</Note>

When a user clicks on the button, two things need to happen:

* An integration link has to be retrieved through your endpoint
* The embedded flow has to be started

#### Getting a link

Here's what the first part might look like:

```js JavaScript theme={null}
async function getKomboConnectLink() {
  // Note: The URL below points to *your* API and could be different
  const response = await fetch('/integrations/kombo/init')
  const data = await response.json()

  return data.link
}
```

#### Opening the flow

Now it's time to actually show the flow to the user. This can be through
[the @kombo-api/connect JavaScript library](https://www.npmjs.com/package/@kombo-api/connect).
It's tiny (about 50 lines of JavaScript as of now) and basically just
initializes an `<iframe>` to display the flow.

<Note>
  **Important:** Since the Kombo Connect flow is displayed in an iframe, you'll need to ensure your Content-Security-Policy allows it. Add `frame-src https://connect.kombo.dev` to your CSP header:

  ```
  Content-Security-Policy: frame-src https://connect.kombo.dev;
  ```
</Note>

Let's, first of all, add it as a dependency to our front-end:

<CodeGroup>
  ```bash npm theme={null}
  npm install @kombo-api/connect
  ```

  ```bash yarn theme={null}
  yarn add @kombo-api/connect
  ```

  ```bash pnpm theme={null}
  pnpm add @kombo-api/connect
  ```
</CodeGroup>

Then, import it like so:

```js JavaScript theme={null}
import { showKomboConnect } from '@kombo-api/connect'
```

##### Can't use npm packages or imports?

You can also load the library from the unpkg CDN:

```html HTML theme={null}
<script src="https://unpkg.com/@kombo-api/connect@1/dist/index.js"></script>
```

This makes the library available globally as `KomboConnect`.

#### Reacting to the flow being completed

After the user completes the flow, you'll receive an activation token. This token can be used to retrieve the integration details from Kombo. Depending on the method you choose (activation endpoint or webhook), you'll handle this token differently.

If you're using the activation endpoint, send the token to your backend:

```js JavaScript theme={null}
async function activateKomboIntegration(token) {
  // Note: The URL below points to *your* API and could be different
  const response = await fetch('/integrations/kombo/activate', {
    method: 'POST',
    body: JSON.stringify({ token }),
  })
}
```

If you're using the webhook method, you don't need to handle the activation token on the frontend. Instead, the webhook will notify your backend when a new integration is created.

### Putting all together

Now it's time to put it all together:

```js JavaScript theme={null}
// You can call this whatever you want (just attach this to your button)
async function connectHris() {
  // We wrote this function earlier (make sure to import/include it)
  const link = await getKomboConnectLink()

  const activationToken = await showKomboConnect(link)

  // Not necessary if you're reacting to the `integration-created` webhook
  await activateKomboIntegration(activationToken)
}
```

<Info>
  **What if the user doesn't finish?** No integration is created until the user
  completes the entire flow. Abandoned or closed flows leave no orphan records
  in Kombo. You can safely generate a new link via `POST /connect/create-link`
  for the user to retry. To avoid duplicate integrations for users who *do*
  complete the flow, track completed `integration_id`s on your side, ideally via
  webhook.
</Info>

And that's it! You've successfully embedded Kombo Connect!


# Introduction
Source: https://docs.kombo.dev/ats/guides/connect/introduction

Our interactive embeddable connection flow.

<img alt="1376" />

We know that the experience of setting up new integrations is just as core to
your application as the integrations themselves, so we've put special care into
making this as easy and user-friendly as possible for your customers.

*The best part:* **Kombo Connect** — that's what we call our interactive
connection flow — can be
[fully embedded within your own application](./embedded-flow).

## How it works

To get a better idea of how Kombo Connect fits into your application, let's take
a look at the typical flow a customer will go through:

1. They **initiate the flow** within your app (e.g., through a "Connect HRIS"
   button)
2. They are **presented with the Kombo Connect UI** where they can:
   * Select the tool they want to connect (e.g., Factorial)
   * Get an overview of the requested data points (see [Scopes](../../features/scopes))
   * Grant access to the requested data points
   * See which credentials are required to set up the tool and how to get them
   * Enter the necessary credentials (e.g., an API key)
3. They **return to your app**, and their integration has been set up

## Getting started

The flow described above applies to the situation where you've
[*embedded* the Kombo Connect flow](./embedded-flow) into your own app. This
provides the most seamless experience but isn't the quickest way to get started.

If you just want to try out Kombo quickly and **onboard selected customers**,
consider these other options that **don't require any changes to your app**:

<CardGroup>
  <Card title="Manual setup" icon="wrench" href="./manual-setup">
    Perfect when you *already have* the relevant credentials from your customer
    and just want to add the integration to Kombo
  </Card>

  <Card title="Magic links" icon="wand-magic-sparkles" href="./magic-links">
    Similar in that they also don't require any code, but they still allow your
    customers to go through the flow and enter the credentials themselves.
  </Card>
</CardGroup>


# Magic links
Source: https://docs.kombo.dev/ats/guides/connect/magic-links

Let your customers set up integrations without changing your app.

When you're just getting started with Kombo, you might not want to invest in the
time into building a proper integration with [Kombo Connect](./introduction) yet.
Because of that, we allow you to send what we call "Magic links" to your
customers that allow them to go through the connection flow without you having
to change anything about your application.

## Setting up an integration

To get started, open up [the dashboard](https://app.kombo.dev) and click on "New
integration":

<Frame>
  <img alt="1448" />
</Frame>

Then, select "Let your customer create the integration":

<Frame>
  <img alt="764" />
</Frame>

In the next step, select the integration category (e.g., HRIS) and which
customer it's for:

<Frame>
  <img alt="1762" />
</Frame>

After clicking "Continue," you'll get a link that you can share with your
customer:

<Frame>
  <img alt="786" />
</Frame>

Clicking on this link will take your customer to a special version of the Kombo
Connect flow hosted by us:

<Frame>
  <img alt="1376" />
</Frame>

After they've gone through the flow, the integration will be set up and we will
send you a [webhook](../webhooks). You can then start using our unified API. To
learn more about that, check out
[our general Getting Started guide](../../getting-started).


# Manual setup
Source: https://docs.kombo.dev/ats/guides/connect/manual-setup

Manually set up integrations on behalf of your customers.

When you're just getting started with Kombo, you might not want to invest the
time into building a proper integration with [Kombo Connect](./introduction) yet.
Because of that, we allow you to *manually* set up integrations through the
Kombo Dashboard.

## Setting up an integration

To get started, open up [the dashboard](https://app.kombo.dev) and click on "New
integration":

<Frame>
  <img alt="1448" />
</Frame>

Then, select "Create the integration yourself":

<Frame>
  <img alt="758" />
</Frame>

In the next step, select the integration category (e.g., HRIS) and which
customer it's for:

<Frame>
  <img alt="1762" />
</Frame>

After clicking "Continue," you'll then be presented with the regular
[Kombo Connect](./introduction) flow, except that in this case, it's *you* going
through it and not your customer:

<Frame>
  <img alt="1376" />
</Frame>

After going through the flow, the integration will be set up, and you can start
using our unified API. To learn more about that, check out
[our general Getting Started guide](../../getting-started).


# Reconnecting an integration
Source: https://docs.kombo.dev/ats/guides/connect/reconnection

This document explains why and how to reconnect an integration.

## When to reconnect an integration

### Authentication issues

Sometimes customers change integration authentication details, API keys expire,
or other integration setup details are changed and Kombo can no longer
authenticate with an integration that was previously connected.

After three consecutive days of failing authentication (which we check before every
sync), Kombo will pause scheduling syncs and will prompt you to reconnect the
integration.

#### How to Identify Authentication Issues

Authentication issues can be identified in two ways: programmatically (recommended) or operationally via the Kombo dashboard.

1. **Programmatically:**
   Use the [Integration State Changed webhook](../../guides/webhooks#integration-state-changed). This webhook allows you to monitor changes in the `state` value, helping you quickly detect authentication-related issues.

2. **Operationally:**
   Open the [integrations list](https://app.kombo.dev/integrations). An [issue](../../features/issues) appears on the integration as soon as authentication starts failing, and the integration state updates as well.

By leveraging these approaches, you can promptly diagnose and address authentication challenges.

### Changes in data scope

If you want to update which data you're interacting with in your customer's HR
systems, you will likely need to update your [Kombo scope config](../../features/scopes).
Updating your scope config in Kombo will usually go hand in hand with your
customer having to update their API credentials. Therefore, expanding your scope
config will likely end up with syncs showing warnings that not all permissions
are granted to the API credentials.

Syncs failing due to scope-mismatches can be avoided by using reconnection
links, as described [below](#a-note-on-updating-the-scope-config).

## Methods of reconnecting

### Use the dashboard to create an update link

In the [Kombo dashboard](https://app.kombo.dev), navigate to any integration
that you want to reconnect. Scroll down to the **Relink integration** section to
create an update link.

You can send this link to your customer to update the credentials of the
integration. Once they have reconnected successfully, syncs will run using the
newly entered credentials.

<Frame>
  <img alt="image" />
</Frame>

### Use the API to create a reconnection link

You can also create a reconnection link using the [create reconnection link endpoint](../../v1/post-integrations-integration-id-relink).
Specify the `link_type` for it to be used either in the [embedded flow](../connect/embedded-flow),
or sent out as a [magic link](../connect/magic-links).

## A note on updating the scope config

You are able to define the scope config of a reconnection link both in the UI
and using the API.

<Frame>
  <img alt="image" />
</Frame>

Setting a different scope config than the current integration's scope config
results in the following:

* Your customer will see the updated scope config in the connection flow (i.e.,
  they will have to create credentials with the newly desired permissions)
* On connection flow completion, the scope config of the integration will
  automatically be updated to reflect the new scope config

Use this functionality to smoothly migrate your customers to a new scope config,
without running into any sync issues. While the reconnection link has not been
completed, syncs will continue successfully working using the old scope config;
the new scope config will only be used once the reconnection link has been
completed.


# Troubleshoot connection flow problems
Source: https://docs.kombo.dev/ats/guides/debugging/debug-connection-flow

Investigate and resolve issues that prevent your customers from connecting.

<Frame>
  <img alt="Pending connection detail view" />
</Frame>

When a customer cannot finish the connection flow, work through the steps below to isolate whether the problem originates from the customer’s configuration, Kombo, or the remote tool.

## 1. Identify the failing connection

* Open the [Pending Connections page](https://app.kombo.dev/pending-connections) in the dashboard.
* Locate the affected connection and open its detail view. This page aggregates the context you need, including flow status and quick links.
* If you can't find the connection, you can also try to locate it from the [Logs page](../../features/logs).

## 2. Inspect event and request logs

* Use the **Event Log** tab to understand exactly which step failed and what the customer saw in the UI. These entries often include an error message or hints the customer might have missed.
* Switch to the **Logs** tab to inspect the HTTP calls Kombo made:
  * Review failing requests. HTTP `401`/`403` responses typically mean a missing permission on the customer’s side.
  * `500`-level responses usually indicate a temporary issue in the remote tool—confirm their status page or retry later.
  * Other status codes (e.g. validation errors) can surface configuration issues on Kombo’s side.
  * Also inspect the response bodies, they might contain more information on whats failing.

<Frame>
  <img alt="Event log vs. request log tabs" />
</Frame>

For a deeper dive into logs, see [Logs](../../features/logs) and [Komboman](../../features/komboman) for reproducing calls manually.

## 3. Validate setup with connection guides

* Share the [connection guide](https://help.kombo.dev/hc/en-us/sections/14349683218961-Connection-Guides) for the tool with your customer. The guide lists mandatory permissions, API scopes, and any tool-specific prerequisites.
* Confirm that the customer followed the guide
* If the guide highlights optional scopes your product relies on, ensure the customer understands why they must be enabled.


# Diagnosing missing or incorrect data
Source: https://docs.kombo.dev/ats/guides/debugging/debug-data-issues

A step-by-step guide to troubleshooting data discrepancies between Kombo and the remote tool.

When customers report missing, outdated, or incorrect data, the goal is to determine whether the discrepancy exists inside Kombo or originates from the remote tool.

This guide provides a structured workflow to pinpoint the issue and resolve it.

## 1. Verify the data in Kombo

First, check if the data is actually missing or incorrect in Kombo's own database.

### Check Data Quality View

Use the Data Quality View to see how many data points are synced for each model and field. This helps you to get an overview whether the data is complete.

<img alt="Data Quality View" />

### Check Data Explorer

Use the [Data Explorer](../../features/data-explorer) to inspect specific records. The data explorer shows the ground truth inside of Kombo. You can find all records and their fields values inside of the data explorer.

<img alt="Data Explorer" />

### Validate with Komboman

Use [Komboman](../../features/komboman) to make requests to the Kombo API (e.g., `GET /hris/employees` or `GET /ats/applications`) and check the JSON response directly.

<img alt="Komboman" />

<Note>
  If the data is correct and up-to-date in Kombo but missing or incorrect in
  your system, the issue is likely with how you fetch data from Kombo. Ensure
  you are [syncing data correctly](../../getting-started/fetching-data).
</Note>

## 2. Check the data in the remote tool

If the data is missing or wrong inside the Kombo app, we need to verify what Kombo is receiving from the remote tool.

### Use the Custom Field Explorer

The [Custom Field Explorer](../../features/custom-fields#map-fields-based-on-live-data) shows you all the raw fields Kombo has discovered from the remote tool, including those that aren't mapped to Kombo's unified model.

* If you see the field here, Kombo has access to the data, but it just isn't mapped to a standard field. You can use remappings to update the mapping of the field that is wrong.
* This at times might not show all the fields.

<img alt="Custom Field Explorer" />

### Inspect Request Logs

Go to the [Logs page](../../features/logs) to find the actual HTTP requests Kombo performed during the sync.

* Look for the relevant endpoint (e.g., `/GET employees`).
* Inspect the **Response Body** to see the raw data Kombo received.
* You can even replay the request in [Komboman](../../features/komboman) to see the live response.

<img alt="Request Logs" />

### Use Komboman (Passthrough)

If you can't find the request in the logs, use [Komboman](../../features/komboman) to manually send a request to the remote tool's API (using the "Passthrough" mode).

* This uses the customer's actual credentials, so it shows you exactly what the API returns.
* Compare this raw JSON with what you expected to see.

## 3. Resolutions

Once you've identified where the data is missing, use these steps to resolve the issue.

### Data is not available or incorrect in the remote tool

If you cannot find the correct data in the remote tool's API response (via Komboman or Logs), Kombo cannot sync it.

* **Permission Issue**: The most common cause is that the API user/token connected to Kombo does not have permission to view these fields. Ask the customer to check their permissions and scope settings in the remote tool.
* **Setup Issue**: The specific field wasn't exposed. Read the [connection guide](https://help.kombo.dev/hc/en-us/sections/14349683218961-Connection-Guides) for the tool. Some tools require additional setup, for example, to read custom fields.
* **Wrong Endpoint**: Some tools return data only on specific endpoints. Verify in the tool's documentation if the data is expected to be returned by the endpoint Kombo is calling (which you found in the logs).

### Data is correct in the remote tool, but not in Kombo

If you see the correct data in the raw API response but it doesn't appear (or appears incorrectly) in Kombo's unified API:

* **Check Scope Configuration**: Ensure the model or field is enabled in the integration's scope configuration. If a scope is disabled, Kombo will drop that data.
* **Check Filtering**: Verify if the record is being excluded by [filtering](/hris/features/filtering/introduction) configuration. For example, employees might be filtered out based on their employment status or location (HRIS), or applications might be skipped due to [upstream filtering](/ats/features/upstream-filtering) (ATS).
* **Remap the Data**: If the data is present but not in the field you expect (or is a custom field), you can map it manually:
  * Use [Custom Fields](../../features/custom-fields) to map the raw field to a new property in Kombo.
  * Use [Remapping](../../features/remapping/introduction) to override where a standard field gets its value from.


# How to troubleshoot issues with Kombo
Source: https://docs.kombo.dev/ats/guides/debugging/introduction

Identify and resolve issues across connections, data, and actions using Kombo’s troubleshooting tools.

This guide helps you understand how to **troubleshoot and resolve issues in Kombo**—whether that’s missing data, connection problems, or failing actions.

Kombo provides built-in tooling like [Issues](../../features/issues), [Komboman](../../features/komboman), [Logs](../../features/logs), or the [Data Explorer](../../features/data-explorer) so you can investigate what’s happening behind the scenes and often fix problems yourself.

By the end of this guide you will be able to:

* verify whether an issue lies within Kombo or the connected tool
* choose the right troubleshooting tool for each situation
* collect the right evidence before reaching out to Kombo support

## Kombo support

Our support team is always here to help—but in many cases you can diagnose and even resolve issues yourself using the tools described below. When contacting support, include:

* a short description of what’s wrong
* the affected integration(s) or customers
* any screenshots, logs, or links from your troubleshooting steps

The more detail you share, the quicker we can get you back up and running.

## Common issues

<CardGroup>
  <Card title="Connection issues" icon="link-slash" href="./debug-connection-flow">
    Pending connection fails, customers get stuck in the flow, or you need to
    force a connection.
  </Card>

  <Card title="Data quality issues" icon="magnifying-glass" href="./debug-data-issues">
    Records look missing, outdated, or mapped incorrectly inside Kombo or your
    product.
  </Card>

  <Card title="Action issues" icon="bolt" href="./investigate-failing-actions">
    A write, passthrough, or dashboard-triggered action fails and you need to
    see why.
  </Card>
</CardGroup>

## Key tools for troubleshooting

<CardGroup>
  <Card title="Issues" icon="triangle-exclamation" href="../../features/issues">
    See which integrations currently need attention, and how long the problem
    has been observed.
  </Card>

  <Card title="Komboman" icon="terminal" href="../../features/komboman">
    Send manual Kombo or passthrough API requests to validate data or retry
    failing operations.
  </Card>

  <Card title="Logs" icon="scroll" href="../../features/logs">
    Inspect sync, action, and connection flow logs including detailed
    request/response payloads.
  </Card>

  <Card title="Data Explorer" icon="table" href="../../features/data-explorer">
    Inspect specific records and their field values to see the ground truth
    inside of Kombo.
  </Card>

  <Card title="Custom field explorer" icon="list" href="../../features/custom-fields#map-fields-based-on-live-data">
    Discover available custom fields in the remote tool and map them into Kombo.
  </Card>

  <Card title="Remapping" icon="sliders" href="../../features/remapping/introduction">
    Adjust how Kombo maps data into your models when the default setup is not
    the right fit.
  </Card>

  <Card title="Custom & remote fields" icon="grid" href="../../features/custom-fields">
    Learn how to work with Kombo’s field model, including automatic mapping
    rules and remote references.
  </Card>
</CardGroup>


# Investigate failing actions
Source: https://docs.kombo.dev/ats/guides/debugging/investigate-failing-actions

Diagnose failed write actions using Logs and Komboman.

While most actions succeed automatically, occasional failures are inevitable when syncing data with external systems. Strict validation rules, changing permissions, or complex data dependencies can sometimes cause requests to be rejected.

This guide introduces tools like [Logs](../../features/logs) and [Komboman](../../features/komboman) to help you isolate and understand the error.

## 1. Find the action in the logs

<Frame>
  <video />
</Frame>

To find the relevant log entry, head to the [Logs page](../../features/logs) and use the filters on the top:

* **Type**: Select **Action** to see only write operations (excluding syncs and webhooks).
* **Status**: Select **Failed** to focus on the errors.
* **Integration**: Narrow down results to a specific customer connection.
* **Date**: If you know when the error happened, setting a time range helps filter out noise.

Once you've filtered the list, you should see the failed action.

## 2. Inspect the logs

Click on the log entry to open the detail view. This is your view for understanding what happened.

* **Review the input**: Check the `Incoming Request` tab to see exactly what data you sent to Kombo.
* **Inspect the requests**: An action often involves multiple HTTP calls to the remote tool. Check the timeline for any failed requests.
* **Dig deeper**: Click on a specific request in the timeline to see the raw payload Kombo sent and the error response from the remote system. These often contain more specific details than the top-level error message.

<Frame>
  <img alt="Request log details" />
</Frame>

## 3. Common issues

We have a dedicated [Error Handling guide](/guides/errors) that covers how to handle common API errors programmatically. Below, you'll find visual examples of the most common issues specific to actions:

### Missing permissions or Invalid authentication

If you receive a `403 Forbidden` or `401 Unauthorized` error, the integration
likely lacks the necessary permissions or it's authentication is invalid. Below
are some examples of how these errors might look in the logs:

<AccordionGroup>
  <Accordion title="Missing Permissions Example">
    <Frame>
      <img alt="Missing permissions error" />
    </Frame>
  </Accordion>

  <Accordion title="Invalid Authentication Example">
    <Frame>
      <img alt="Invalid authentication error" />
    </Frame>
  </Accordion>
</AccordionGroup>

**Solution**: Identify the missing permission from the error message. Ask your
customer to check their settings or API key, as they might have revoked access
or changed their role. In some cases, they will need to [reconnect the
integration](../connect/reconnection) to grant the missing scopes.

### Invalid input

If the error is a `400 Bad Request`, `422 Unprocessable Entity`, or a validation
error, the remote tool rejected the data you sent. Below are some examples of
how these errors might look in the logs:

<AccordionGroup>
  <Accordion title="Invalid Input Example 1">
    <Frame>
      <img alt="Invalid input error 1" />
    </Frame>
  </Accordion>

  <Accordion title="Invalid Input Example 2">
    <Frame>
      <img alt="Invalid input error 2" />
    </Frame>
  </Accordion>
</AccordionGroup>

**Solution**:

1. Identify the incorrect or missing data in the `Incoming Request` tab.
2. Use [Komboman](../../features/komboman) to replay the action with adjusted inputs and verify the fix.
3. Check the integration's **Field Report** (in the dashboard) to see which fields are required by the remote tool.
4. If a connection always requires specific static inputs, you can set up Remote field overrides.

### Logical errors (e.g., Job closed)

Sometimes the request is valid, but the operation cannot be performed due to the state of the remote system (e.g., applying to a closed job or creating a duplicate candidate). Below are some examples of how these errors might look in the logs:

<AccordionGroup>
  <Accordion title="Logical Error Example 1">
    <Frame>
      <img alt="Logical error 1" />
    </Frame>
  </Accordion>

  <Accordion title="Logical Error Example 2">
    <Frame>
      <img alt="Logical error 2" />
    </Frame>
  </Accordion>

  <Accordion title="Logical Error Example 3">
    <Frame>
      <img alt="Logical error 3" />
    </Frame>
  </Accordion>
</AccordionGroup>

**Solution**: Check the state of the referenced records (e.g., is the `job_id` open?) before sending the action, or handle these specific error codes gracefully in your application.

### Temporary issues

If you see a `500` error or a timeout from the remote tool, it might be a temporary issue. Below is an example of how this error might look in the logs:

<AccordionGroup>
  <Accordion title="Temporary Issue Example">
    <Frame>
      <img alt="Temporary remote tool error" />
    </Frame>
  </Accordion>
</AccordionGroup>

**Solution**: Try resending the action directly from the log details view.

## 4. Still not sure?

If the error is unclear or you suspect a bug in Kombo:

1. Copy the URL of the failing log entry.
2. Reach out to [Kombo support](/support).
3. Paste the link so we can look at the exact same trace you are seeing.


# Environments
Source: https://docs.kombo.dev/ats/guides/environments



In Kombo, you will have access to two environments; a **production** environment (prod) and a **development** environment (dev). You can switch between these in the sidebar:

<Frame>
  <img />
</Frame>

## What differs per environment?

Only your tenant name ("Acme" in the case of the screenshot above) is shared
across environments. That means that all your other configurations, including
scopes, enabled tools, webhooks, custom fields, and secrets,
will be different per environment.

## Production

This is where you should create integrations with your customers. We are stricter
in this environment about default privacy settings and data retention.

### Saving the connection flow input in production

When connecting customers via your production environment, their connection flow
input is saved in [session storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage).
This is done so that while the same tab/window is open, your customer will not
have to enter the same data for the same input if they move back and forth
through the connection flow. When the tab/window is closed, the credentials
are forgotten. This differs from the development credential storage,
as described below.

## Development

The development environment is meant to be used with
your [sandbox environments](../getting-started/sandbox-integrations) during
development and testing. This environment is less strict about privacy settings
and data retention.

### Saving the connection flow input in development

In the development environment, the connection flow input is saved
in [local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage).
This is a quality-of-life feature meant for developers to prevent having
to enter the same inputs when creating multiple connections to the same
sandbox. Local storage will persist between browser sessions until it
is manually cleared.

### Kombo sandbox

You have access to our built-in **Kombo Sandbox** tool in the development
environment. You can create a new integration with this sandbox as you would
with any other integration, and instantly start reading data without having
to connect a HR system.

### Stale integrations

**In the development environment only**, integrations that did not receive an
API requests in the past two weeks will automatically
become [inactive](./integration-states#inactive). If you want to continue
using the integration, you can activate it again.

## Roles and Access Control

Kombo uses role-based access control so you can grant team members the right level of access. Roles are assigned per user in the dashboard.

| Role          | Environments             | Configuration          | API Keys               | User Management             |
| ------------- | ------------------------ | ---------------------- | ---------------------- | --------------------------- |
| **Admin**     | Production + Development | Full access            | Full access            | Can invite and manage users |
| **Developer** | Development only         | Full access (dev only) | Full access (dev only) | No access                   |
| **Operator**  | Production only          | Read + limited writes  | No access              | No access                   |

### Admin

Full access across both environments, including all configuration (scopes, webhooks, custom fields), API key management, and user administration.

### Developer

Full access to the Development environment only, including API keys and all configuration within that environment. Cannot access Production or manage users.

### Operator

Read access to the Production environment plus the ability to create integrations, reconnections, and provisioning links, edit integration settings, and map custom fields. Cannot manage API keys, scopes, audit logs, or users.

### SSO and MFA

Kombo's dashboard authentication supports **SSO** (SAML and OIDC) and **MFA** for users who want additional security. These are not available on all plans — contact the Kombo team to check availability and configure them for your tenant.


# Implementing New Tools
Source: https://docs.kombo.dev/ats/guides/implementing-new-tools

Learn about best practices when using a new tool.

To enable a new tool, navigate to the [tools page](https://app.kombo.dev/tools) in the Kombo dashboard and enable it.

Before enabling it, we highly recommend using Kombo's resources to learn more about the tool. The reason for this is that not all HR tools support the exact same feature set. We try to unify these differences as much as possible, but we also aim to provide the best possible resources to prevent any surprises when using a tool.

Below is a list of the resources Kombo provides, and a short explanation on why they could be useful.

## Coverage Grid

The coverage grid provides a high-level overview of which data point is supported across all of our integrations. Hovering over noteworthy data points will also offer explanations of their implementation.

You can access the [HRIS coverage grid](https://app.kombo.dev/coverage/hris) or the [ATS coverage grid](https://app.kombo.dev/coverage/ats) from your dashboard.

## Tools Page

Our [tools page](https://app.kombo.dev/tools) provides in-depth documentation on each tool. Click on a tool's name to view its content.

### Resources

Under the resources tab, you'll find links to the tool's specific resources and guides.

* **Preview Connection Flow:** An interactive overview of the connection flow. Here, you'll be able to see each step that your customer will take, allowing you to provide support if necessary.
* **Connection Guide:** A written guide meant for customers, where we provide screenshots and explanations for navigating the tool's user interface to generate credentials.
* ***Sandbox***: If the tool allows for free demo accounts, we will provide a link here.

**ATS-Specific**

* **How to View Sources**: A guide to show where your company's desired attribution will be displayed in the customer's system.
* ***How to Set Up a Source***: If a tool has a complicated process for setting up source attribution, we provide an additional guide to assist your customer in doing so here.

### Limitations

The limitations tab provides general and data-point-specific explanations of how Kombo unifies the tools' data and, in some cases, which limitations the tool comes with.

For example, when a tool's data model differs too much from the unified Kombo model, we would explain how the data is mapped to the Kombo model here.


# Integration States
Source: https://docs.kombo.dev/ats/guides/integration-states



## What is an Integration Status

After the connection flow has been completed, the integration will appear on
your [integrations page](https://app.kombo.dev/integrations).

Each integration has a status indicator informing you about the current
operational status.

<Note>
  ### API vs UI Integration States

  The [GET integration states](../v1/get-integrations-integration-id) endpoint returns a subset of the below-listed states, returning only those relating to the actual **sync status**.

  The [integrations page](https://app.kombo.dev/integrations) expands on these states for a more human-readable interface.
</Note>

## Possible Integration States

### Active

<Frame>
  <img />
</Frame>

The integration is running as expected, and data is being synced successfully.

### Sync Failing

<Frame>
  <img />
</Frame>

The last sync was not completed successfully. This can be the result of critical
errors, such as missing data, missing permissions, or the tool's API having downtime.

**Next steps:**

* Check the [logs](../features/logs) of the sync to read the error message.
* Reach out to Kombo for help with resolving an issue.

### Sync Has Warnings

<Frame>
  <img />
</Frame>

The last sync was successful with warnings. This can be the result of smaller
unexpected behavior, such as a specific field not being able to be fetched.

**Next steps:**

* Check the [logs](../features/logs) of the sync to read the warning message.
* Reach out to Kombo for help with resolving an issue.

### Quality Assurance

<Frame>
  <img />
</Frame>

If we detect any issues while performing the first sync, the integration status
will automatically be set to quality assurance mode. Our engineering team will
be notified, and we will contact you once we have resolved the issue and
re-enabled the integration.

### Authentication Failing

<Frame>
  <img />
</Frame>

The last sync failed because the credentials could no longer authenticate the
data transfer. This can be the result of expired credentials.

**Next steps:**

* [Reconnect the integration](./connect/reconnection#methods-of-reconnecting)

### Credentials Invalid

<Frame>
  <img />
</Frame>

The status is moved from **authentication failing** to **credentials invalid**
if every sync over the last 24 hours has failed due to authentication. The
integration will be automatically set to pause future syncs until new
credentials are provided.

**Next steps:**

* [Reconnect the integration](./connect/reconnection#methods-of-reconnecting)

### Setup

<Frame>
  <img />
</Frame>

An integration in the setup state has been successfully connected but no filters have been configured yet.

**Next steps:**

* [Create a provisioning link](/hris/v1/post-provisioning-groups-group-id-setup-links) to set up filters for the integration. You can also do this in the dashboard.

### Inactive

<Frame>
  <img />
</Frame>

An inactive integration will no longer automatically sync data. All credentials
and configuration are preserved — reactivating resumes syncing without
reconnection.

You can set an integration to active/inactive in two ways:

* **Dashboard:** Toggle in the settings page of the integration, as shown below.
* **API:** Use [Set integration enabled](../v1/put-integrations-integration-id-enabled) with `{ "value": false }` to pause or `{ "value": true }` to resume.

<Frame>
  <img />
</Frame>

In your [development environment](./environments#development), integrations will
be set to inactive if you did not send an API request to it over the past two
weeks. If desired, you can always reactivate it.

**Next steps:**

* Reactivate the integration in the dashboard or via the API.

### Deleted

<Frame>
  <img />
</Frame>

You previously deleted the integration. You can read more about our deletion policy [here](../features/deletion-policy).


# Partner Credentials
Source: https://docs.kombo.dev/ats/guides/partner-credentials

Learn how existing partnerships to integrated systems can be used with Kombo.

## Overview

When you are already a partner with some of the tools that we are integrating,
Kombo allows you to bring your own credentials and settings to get the most out of
the partnership.

Partner credentials and options can, for example, be the OAuth master-level credentials
that are used to issue access tokens and initialize OAuth flows. That will allow
you to show your logo and name in the OAuth flow instead of Kombo's.

For most integrations, Kombo provides a set of default credentials and settings
so that you don't need to get a partnership with every tool you want to integrate.
However, if you have your own partnership, you can configure custom partner credentials
that work in a revision system, allowing you to manage multiple credential sets and
safely update them without breaking existing integrations.

## Understanding Credential Revisions

Partner credentials work in a revision system. Each time you create or update
credentials, a new revision is created with a label you can assign (e.g.,
"Production credentials" or "Staging credentials").

### How Revisions Work

The revision system ensures that credential changes are safe and non-destructive:

* **New integrations**: When you create a new integration, it automatically uses
  the latest revision (the most recently created one).
* **Reconnecting integrations**: When you reconnect an existing integration, it
  automatically upgrades to use the latest revision.
* **Existing integrations**: Existing integrations continue using their assigned
  revision and are **not automatically migrated** when you create a new
  revision. This ensures that creating new credentials doesn't break existing
  integrations.

## Managing Credentials and Revisions

You can manage partner credentials and revisions on the [tool settings page](https://app.kombo.dev/tools)
for all tools that support this feature.

<Frame>
  <img alt="image" />
</Frame>

The new revision will become the latest revision, and all new integrations will
automatically use it.

Each integration's details page shows which revision it's currently using,
including whether it's using customer-submitted credentials or Kombo default
credentials.

## Best Practices

Always test new credential revisions in your development environment before
using them in production. This helps you catch common issues like:

* Mismatched redirect URLs
* Insufficient OAuth scopes
* Incorrect API endpoints or base URLs
* Invalid authentication tokens

### Upgrading Existing Integrations

To upgrade an existing integration to a new revision, you must reconnect it
using the [reconnection flow](./connect/reconnection). This ensures
that the integration is properly tested with the new credentials before they're
applied.

The reconnection flow allows your customer to re-authenticate with the updated
credentials, ensuring a smooth transition without breaking the integration.

### Getting Help

We are always improving the support for custom partner credentials. If you are
missing this feature for a tool, or if you encounter any issues while setting
up credentials, please reach out to us.


# Static IPs
Source: https://docs.kombo.dev/ats/guides/static-ips

Route all Kombo API calls through a fixed set of IP addresses so your customers can allowlist them.

## Use Case

Some systems are locked down to only accept inbound requests from a pre-approved set of IP addresses. Without Static IPs, Kombo's API calls to these systems would be rejected because our traffic originates from a dynamic address range.

Enabling Static IPs routes all outgoing API calls for a given integration through a fixed pool of addresses that you can share with your customer's system administrator to allowlist.

## Enabling Static IPs

Static IPs are configured per integration link at the time you create the connection link.

1. In the [Kombo dashboard](https://app.kombo.dev/integrations), click **New integration**.
2. Fill in the required fields and expand **Advanced settings**.
3. Toggle **Static IPs** on.
4. The dialog will display the IP addresses assigned to this integration. Copy them — you'll need to share them in the next step.
5. Click **Continue** and send the link to your customer as usual.

<Frame>
  <img
    alt="Static IPs toggle in the New Integration
dialog"
  />
</Frame>

## Sharing the IPs

Once you have enabled Static IPs, share the displayed IP addresses with the administrator of the connected system and ask them to add the addresses to their allowlist. Kombo's API calls will be rejected by the system until the allowlist is in place.

The exact steps to add IPs to an allowlist depend on the connected system. Refer to your customer's system documentation or share our [connection guides](https://help.kombo.dev) for step-by-step instructions.

## Existing Integrations

If you need to enable Static IPs for an integration that has already been set up, open the integration in the [Kombo dashboard](https://app.kombo.dev/integrations), go to its settings page, and toggle **Static IPs** on. The IPs to allowlist will appear immediately below the toggle.

<Frame>
  <img
    alt="Static IPs section on the Integration Settings
page"
  />
</Frame>


# How Kombo Syncs Data
Source: https://docs.kombo.dev/ats/guides/sync

Understanding how Kombo keeps integration data up-to-date internally without sacrificing API reliability and performance.

# Syncs in Kombo

We're mirroring the data in the source systems into a database at regular
intervals (or when you [manually trigger a sync](../v1/post-force-sync)). When you
call our API, we will simply read from our database, resulting in endpoints that
always respond reliably and quickly.

Through our syncing approach, we can also provide [webhooks](./webhooks) for
systems that don't provide webhooks themselves.

<Info>
  This page explains how Kombo syncs data internally. If you're looking for how
  to fetch data from Kombo into your system, see our [Fetching Data
  guide](../getting-started/fetching-data).
</Info>

<Note>
  Note that syncs adhere to [your scope config](../features/scopes), so if there
  are sensitive data points you're not using, then those will **not** end up in
  our database.
</Note>

## Full Syncs vs. Delta Syncs

Kombo uses two different sync strategies to keep your data up-to-date. Each
serves a different purpose and has different trade-offs regarding speed,
completeness, and frequency.

### Full Syncs

A full sync **re-fetches all data** from the connected system. It pulls every
record (employees, candidates, jobs, etc.) regardless of whether it changed
since the last sync.

**Key characteristics:**

* Fetches the **complete dataset** from the remote system
* **Detects deletions**: records that existed before but are no longer returned
  by the source system are marked as deleted in Kombo
* **Reconciles data quality issues**: because everything is re-fetched, full
  syncs can correct inconsistencies that may have been missed by delta syncs or
  webhooks
* **Picks up configuration changes**: if you update your
  [scope config](../features/scopes) to include new fields, a full sync is needed to
  backfill those fields across all existing records
* Runs at a **lower frequency** than delta syncs
* Takes **longer to complete** since it processes all records

Full syncs are essential because they are the only sync type that can reliably
detect deletions and ensure the complete dataset is consistent.

### Delta Syncs

A delta sync **fetches only data that changed** since the last sync. It uses
upstream filters (like `updated_after` timestamps) to request only new or
modified records from the source system.

**Key characteristics:**

* Fetches only **new and modified records**, making it significantly faster
* **Cannot detect deletions**: since it only asks for changes, it has no way of
  knowing which records were removed
* Runs at a **higher frequency** than full syncs
* **Not available for all integrations**: delta syncing depends on the source
  system's API supporting change-based filtering

### How They Work Together

When an integration supports delta syncs, Kombo runs both types on
complementary schedules:

| Sync type  | Frequency | What it fetches      | Detects deletions |
| ---------- | --------- | -------------------- | ----------------- |
| Full sync  | Lower     | All records          | Yes               |
| Delta sync | Higher    | Only changed records | No                |

For integrations that **don't** support delta syncs, Kombo runs full syncs at a
higher frequency to compensate for the lack of incremental updates.

The exact sync frequency depends on your plan and can be customized on higher
tiers.

<Info>
  Some integrations also support **upstream webhooks**, which provide near
  real-time updates for individual record changes. When webhooks are active, the
  polling sync frequency may be reduced since webhooks already keep the data
  fresh. Learn more about [upstream webhooks](./upstream-webhooks).
</Info>

## Sync Units

For some integrations, Kombo splits a sync into smaller, independent **sync
units**. Instead of syncing all data types together, each unit syncs a focused
part of the dataset (for example, one model or a group of related models) and
completes on its own. This is currently being rolled out for a subset of tools
and environments, and doesn't change how you read data from our API.

Because units run independently, a few behaviors are scoped to the unit rather
than the sync as a whole:

* **Deletion tracking is per unit**: after a unit finishes its full sync, only
  the records belonging to that unit are considered for deletion tracking.
  Records from other units are unaffected until their own unit completes.
* **Webhooks are sent per unit**: "Data changed" [webhooks](./webhooks#data-changed)
  fire as each unit processes its data, so you receive updates progressively
  rather than all at once at the end of a full sync.
* **Endpoints unlock as units finish**: for newly connected integrations, an
  endpoint becomes available as soon as the unit responsible for its data
  completes, rather than waiting for the entire initial sync to finish.

## Sync Scheduling

Kombo uses a frequency-based scheduling system that automatically determines
when syncs should run for each integration.

### How Scheduling Works

The scheduling system works by tracking the **last sync time** and adding the
**configured frequency** to determine when the next sync is due.

For example, if a full sync completed at 2:00 PM and the configured frequency is
10 hours, the next sync will be due at 12:00 AM (midnight).

### Sync Frequencies

Different sync types run at different frequencies:

* **Full syncs** run less often when delta syncs are available, and more often
  when they are not
* **Delta syncs** run more frequently than full syncs

The exact frequency depends on your plan and can be customized on higher tiers.

When you manually trigger a sync, it **moves the schedule forward**:

**Example**: Say automatic full syncs are scheduled every 10 hours:

* Last sync: 10:00 AM → Next due: 8:00 PM
* Manual sync at 2:00 PM → Next due: 12:00 AM (midnight) (not 8:00 PM)

The schedule resets from the time of the manual sync, rather than keeping the
original schedule.

## Real-time Data Updates

In addition to full and delta syncs, we are also able to receive webhooks from
selected tools to keep our data in sync more efficiently. Read more about it
[here](./upstream-webhooks).

## Data Normalization

When syncing data from connected systems, Kombo normalizes records into the
unified model. Here's how different data scenarios are handled:

### Missing and Unsupported Fields

If a field is not available in the source system or the integration doesn't
support it, Kombo sets it to `null`. Records are **never dropped** due to
missing fields — you'll always receive the full record with `null` for any
unavailable properties.

This means you should design your system to handle `null` values gracefully,
since different source systems expose different sets of fields.

### Enum Normalization

For categorical fields like `gender`, `employment_type`, or
`employment_status`, Kombo maintains extensive mapping tables that translate
hundreds of system-specific values into unified enum values. For example,
"Vollzeit" or "CDI" from a German or French system both map to `FULL_TIME`.

If a value from the source system cannot be mapped to a known enum value, Kombo
**passes through the original string** rather than discarding it. This means you
may occasionally see raw values from the source system alongside standardized
ones for less common integrations. See the documentation of the specific
endpoint and enum for more information. Some enums don't pass unknown values through.

You can use [remapping](../features/remapping/introduction) to customize how specific
values are mapped if the defaults don't fit your needs.

### Scope-Based Filtering

Fields that are not included in [your scope config](../features/scopes) are set to `null`
during sync. This ensures that sensitive data points you're not using never
enter the Kombo database, even if the source system provides them.

## How Syncs Write Data to the Database

Understanding how Kombo syncs write data to the database is crucial for
understanding data availability and timing behavior.

### Non-Atomic Data Streaming

**Syncs are not atomic operations**. Instead of waiting to commit all data at
the end of a sync, Kombo streams data directly into the database as it's
processed during the sync. This means:

* **Data becomes available immediately**: Updated records appear in API
  responses as soon as they're processed, even while the sync is still running
* **Partial sync results**: If you query the API with `updated_after` during an
  ongoing sync, you'll receive records that have already been processed
* **No "commit phase"**: There's no single point where all sync data becomes
  available at once

### Change Tracking with `changed_at`

Each record in Kombo's database has a `changed_at` timestamp that tracks when
the record was last modified. This field is automatically updated by database
triggers when any tracked field changes:

* **Immediate updates**: `changed_at` is set as soon as a record is upserted
  during sync
* **API filtering**: The `updated_after` parameter in API requests filters based
  on this `changed_at` timestamp
* **Real-time availability**: Records with updated `changed_at` timestamps
  become immediately visible in API responses that use `updated_after` filtering

### Sync Lifecycle and Database Operations

During a sync, Kombo performs these database operations:

1. **Upsert operations**: Each record is upserted (created or updated)
   immediately when processed. If there were changes, the `changed_at` timestamp
   is updated.
2. **Deletion tracking**: For full syncs, records not seen during the sync are
   marked with `remote_deleted_at` after the sync completes successfully.
3. **Reference validation**: Ensures data integrity by validating relationships
   between records.

### Implications for API Consumers

* **Progressive data updates**: You can start receiving updated data before the
  sync completes
* **Timestamp-based filtering works reliably**: Using `updated_after` will
  correctly capture changes made during ongoing syncs
* **No need to wait**: There's no need to wait for sync completion to access
  newly updated data
* **Consistent behavior**: This works the same way for all sync types (full,
  delta, and default syncs)


# Upstream webhooks
Source: https://docs.kombo.dev/ats/guides/upstream-webhooks

Kombo can subscribe to webhooks of the systems that your customers connect. We call this feature upstream webhooks. This document explains how they work and how you can leverage them.

<Note>
  Please be aware that this page covers upstream webhooks. These are webhooks
  that Kombo receives from the connected ATS/HRIS such as Personio or Recruitee.
  If you try to understand webhooks that Kombo sends to your system for new
  integrations or finished syncs, check out [this page](./webhooks).
</Note>

## Concept

Kombo subscribes to webhooks of the systems that your customers connect.
We call this feature upstream webhooks. The goal of this system is to enable you
to receive data in real-time without waiting for a normal sync to complete. Please
note that this is not available for all integrations and depending on the granted
permissions, this might require a re-connect for existing integrations.

When upstream webhooks are successfully enabled and you're subscribed to the data-changed webhook,
Kombo automatically reduces the sync frequency from 3 hours to 24 hours since most updates
are delivered in real-time.

## Availability

Upstream webhooks are available for a limited set of integrations as not all
integrations support them yet. We are actively working on implementing this
feature for more integrations.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/ats/connectors/smartrecruiters">SmartRecruiters</a></li>
    <li><img /><a href="/ats/connectors/lever">Lever</a></li>
    <li><img /><a href="/ats/connectors/recruitee">Tellent Recruitee</a></li>
    <li><img /><a href="/ats/connectors/greenhouse">Greenhouse (V1)</a></li>
    <li><img /><a href="/ats/connectors/greenhousev3">Greenhouse (V3)</a></li>
    <li><img /><a href="/ats/connectors/teamtailor">Teamtailor</a></li>
    <li><img /><a href="/ats/connectors/teamtailorjobboards">Teamtailor Job Boards</a></li>
    <li><img /><a href="/ats/connectors/ashby">Ashby</a></li>
    <li><img /><a href="/ats/connectors/adpworkforcenow">ADP Workforce Now</a></li>
    <li><img /><a href="/ats/connectors/workable">Workable</a></li>
    <li><img /><a href="/ats/connectors/traffit">TRAFFIT</a></li>
    <li><img /><a href="/ats/connectors/jobylon">Jobylon</a></li>
    <li><img /><a href="/ats/connectors/ceipal">Ceipal</a></li>
    <li><img /><a href="/ats/connectors/recruitcrm">Recruit CRM</a></li>
    <li><img /><a href="/ats/connectors/jazzhr">JazzHR</a></li>
    <li><img /><a href="/ats/connectors/jobadder">JobAdder</a></li>
    <li><img /><a href="/ats/connectors/avionte">Avionté</a></li>
    <li><img /><a href="/ats/connectors/breezyhr">Breezy HR</a></li>
    <li><img /><a href="/ats/connectors/kula">Kula</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

## Setup

Whether additional setup is required depends on the connected tool. For many
tools, we are able to subscribe to webhooks automatically through the tool's
API. However, some require a one-time manual configuration by the end-customer
via the integration's Setup Flow. Until this step is completed, real-time
updates will not be available, and changes will arrive after the next scheduled
sync instead.

All configured webhook subscriptions (automatic and manual) are shown in an
integration's settings in the Kombo dashboard and can be managed from there.

## End-Customer Experience

For most integrations, the end-customer only needs to grant a permission to the
credentials to allow us to subscribe to webhooks.

<Frame>
  <img />
</Frame>

Kombo will also diligently only subscribe to webhook event types that are compliant
with the scope config. For example, if you disable candidates and only care about jobs, we
will not subscribe to any candidate events.

## Implementation Guide

By using our [Data changed webhook](./webhooks#data-changed), you will automatically receive updates
about changes we receive from upstream webhooks. That is in addition to any
changes from syncs or other sources. Learn more about how to fetch from Kombo in
our [Fetching Data](../getting-started/fetching-data) guide.

Set up the downstream event in the [webhook config](https://app.kombo.dev/configuration/webhooks) in the Kombo dashboard.

```mermaid theme={null}
sequenceDiagram
    participant ATS as End customer's ATS/HRIS
    participant Kombo as Kombo
    participant Customer as Kombo Customer

    ATS->>Kombo: Send upstream webhook event
    Kombo->>Kombo: Verify event

    Kombo-->>ATS: GET related data
    Kombo->>Kombo: Update Kombo DB


    Kombo->>Customer: Send downstream "data-changed"
    Customer->>Customer: Verify event
    Customer->>Kombo: GET changes via Kombo API
```

You can usually expect to receive events from the connected system within 10-20 seconds.
Most systems take a few seconds before they send the webhook to Kombo.

Kombo will retry the request to your system for up to 5 times with exponential
backoff.

## Troubleshooting

Check out the logs in the Kombo dashboard to see every webhook event that we receive.
The downstream request will also be logged there with any warnings or errors that
we encountered while processing or forwarding the event.

<Frame>
  <img />
</Frame>


# Webhooks
Source: https://docs.kombo.dev/ats/guides/webhooks

Kombo sends you webhooks so that you don't have to poll our API for changes.

<Note>
  Please be aware that this page covers downstream webhooks. These are webhooks
  that Kombo sends to your system for events like new integrations or finished
  syncs. If you try to understand webhooks that Kombo receives from the
  connected ATS/HRIS such as Personio or Recruitee, check out [this
  page](./upstream-webhooks).
</Note>

## Enable Webhooks

You can configure your Kombo webhooks in the dashboard directly in the
[webhooks tab](https://app.kombo.dev/configuration/webhooks). After creating the first
webhook, a random webhook secret will be generated and shown. You can learn
how to use it in [Validate the data](#validate-the-data).

<Frame>
  <img alt="1412" />
</Frame>

## Available webhooks

### Data changed

We send a `data-changed` webhook every time data changes in Kombo. This includes
changes from regular syncs as well as updates from upstream webhooks.
Read more about fetching data [here](../getting-started/fetching-data).

<Note>
  We trigger this webhook, when we receive a change. To speed up delivery of
  changes to Kombo, ensure that upstream webhooks are enabled for the
  integration. If upstream webhooks are not enabled or not supported,
  notifications are sent after the next scheduled sync (latency equals the sync
  frequency).
</Note>

You can use this webhook to keep your database up to date by fetching only
the updated data using the `updated_after` filter.

This webhook is useful to fetch data from Kombo into your system. Read more
[here](../getting-started/fetching-data).

We will only ever send you a `data-changed` webhook if there are changes to the data.

```json data-changed theme={null}
{
  "id": "FhghqjnCi9WuAoLT8Z75CFcs",
  "type": "data-changed",
  "data": {
    "integration_id": "bombohr:ats-dev",
    "integration_tool": "bombohr",
    "integration_category": "ATS",
    "changed_models": [
      {
        "name": "ats_applications"
      }
    ]
  }
}
```

We are debouncing `data-changed` with a 30-second window by default. This means
that you will at most receive one `data-changed` webhook every 30 seconds.

When the webhook is triggered for the first time, we send it out immediately.
After that, we will wait 30 seconds, during which we will collect all events and
send them as a single webhook, thereby starting another 30-second cooldown
window. We do not wait for syncs to finish before sending out the webhook;
instead, we may send you multiple webhooks during a single sync to ensure you
receive changes as soon as possible.

### Sync finished

<Warning>
  The `sync-finished` webhook is deprecated and replaced by the [data-changed
  webhook](#data-changed). It is still available for existing setups, but should
  not be implemented in new setups. Use `data-changed` instead for [fetching
  data updates](../getting-started/fetching-data).
</Warning>

The `sync-finished` webhook is sent every time a sync finishes, regardless of
the sync state. Possible values for `sync_state` are:

* `SUCCEEDED` The sync finished successfully.
* `PARTIALLY_FAILED` The sync succeeded but had non-fatal errors. Kombo will
  take care of it.
* `FAILED` There was a critical error during the sync and the sync did not
  finish. If this happens, we get an alert and will look into the issue to fix
  it ASAP.
* `TIMED_OUT` The sync timed out before completion. This happens rarely and will
  cause an immediate and automatic restart of the sync. Kombo will be notified
  and look into the issue ASAP.
* `CANCELLED` The sync was actively canceled by Kombo. This happens very rarely,
  has no negative side-effects, and if it does happen, we will schedule a new
  sync shortly after.
* `AUTHENTICATION_FAILED` The authentication of the connection is incorrect.
  Please check the Kombo dashboard for further steps.

This webhook is useful for informing customers about when the last sync ran or if
user intervention is required due to authentication issues. This should **not** be
used to trigger data refreshes. Use the [data-changed webhook](#data-changed) for that.

<Note>
  The `sync_started_at` field represents when Kombo started syncing data from
  the connected system, not when you should start fetching from Kombo. Do not
  use this field as your `updated_after` parameter when fetching data.
  Otherwise, you might risk missing data that was created/updated via webhooks
  before the sync started.
</Note>

```json sync-finished theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "sync-finished",
  "data": {
    "sync_id": "B89SCXXho7Yw8PGo8AKJxLn4",
    "sync_state": "SUCCEEDED",
    "sync_started_at": "2021-09-01T12:00:00.000Z",
    "sync_ended_at": "2021-09-01T12:30:00.000Z",
    "sync_duration_seconds": 1800,
    "integration_id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
    "integration_tool": "personio",
    "integration_category": "HRIS",
    "end_user": {
      "origin_id": "36123",
      "creator_email": "user@example.com",
      "organization_name": "Acme, Inc."
    },
    "log_url": "https://app.kombo.dev/env/production/logs/C3xUo6XAsB2sbKC7M1gyXaRX"
  }
}
```

### Integration created

The `integration-created` webhook is sent for every integration that is created.
Please react to this webhook event by adding the integration to your database
or by performing any other business logic that is required when an integration is
created.

```json integration-created theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "integration-created",
  "data": {
    "id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
    "tool": "personio",
    "category": "HRIS",
    "end_user": {
      "origin_id": "36123",
      "creator_email": "user@example.com",
      "organization_name": "Acme, Inc."
    }
  }
}
```

### Integration deleted

The `integration-deleted` webhook is sent when an integration is deleted.
Please react to this webhook event by removing the integration from your database
or by performing any other business logic that is required when an integration is
deleted.

```json integration-deleted theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "integration-deleted",
  "data": {
    "id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
    "tool": "personio",
    "category": "HRIS",
    "end_user": {
      "origin_id": "36123",
      "creator_email": "user@example.com",
      "organization_name": "Acme, Inc."
    },
    "deleted_at": "2022-11-02T10:50:10.242Z"
  }
}
```

### Connection flow failed

The `connection-flow-failed` webhook is sent whenever an error occurs during the
connection flow. These errors could, for example, originate from a user entering
incorrect credentials or from a mismatch between the required and supplied API
permissions.

This is not an alert-type webhook, but should instead be used to collect data
and get insights into user behavior. **The connection flow can still be
successfully completed after this webhook is sent.**

You can check whether the connection flow ended successfully by following the
link under `log_url`. Additionally, the log will display the exact errors your
customer ran into, which you can use to provide support if needed.

```json connection-flow-failed theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "connection-flow-failed",
  "data": {
    "integration_tool": "personio",
    "integration_category": "HRIS",
    "end_user": {
      "origin_id": "36123",
      "creator_email": "user@example.com",
      "organization_name": "Acme, Inc."
    },
    "log_url": "https://app.kombo.dev/env/production/logs/C3xUo6XAsB2sbKC7M1gyXaRX"
  }
}
```

### Assessment order received

The `assessment:order-received` webhook is sent every time an assessment is
ordered for a candidate from within an end-customer's tool.

```json assessment:order-received theme={null}
{
  "id": "Cbfk5sHtDxrSrJBRjsDtbaN9",
  "type": "assessment:order-received",
  "data": {
    "id": "B5KQKhAgTv6ZwzrfAbqbhipd",
    "integration_id": "workday:CBNMt7dSNCzBdnRTx87dev4E",
    "package_id": "typescript_test",
    "status": "OPEN",
    "candidate": {
      "remote_id": "12345",
      "email": "john.doe@gmail.com",
      "first_name": "John",
      "last_name": "Doe",
      "phone": "+1 123 456 7890"
    },
    "application": {
      "remote_id": "54321"
    },
    "job": {
      "remote_id": "67890",
      "name": "Engineering Manager",
      "location": {
        "city": "Berlin",
        "country": "DE",
        "raw": "Berlin, Germany",
        "state": "Berlin",
        "street_1": "Lohmühlenstraße 65",
        "street_2": null,
        "zip_code": "12435"
      },
      "hiring_team": [
        {
          "first_name": "Jane",
          "last_name": "Doe",
          "remote_id": "78901",
          "email": "jane.doe@gmail.com",
          "hiring_team_roles": ["RECRUITER"]
        }
      ]
    }
  }
}
```

### Integration state changed

The `integration-state-changed` webhook is sent when the status of the
integration changes. Use this to detect stale credentials and to reconnect your
customer.

Possible values for the `"state"` key include:

* `ACTIVE` The integration is active and working.
* `INVALID` The connection [requires reconnection](./connect/reconnection) in order to work again.
* `INACTIVE` The integration has been paused, either via the [dashboard or API](./integration-states#inactive). No syncs will run until it is re-enabled.

The payload also includes `qa_status` (`PENDING`, `PASSED`, or `FAILED`) and `setup_status` (`INCOMPLETE`, `FINAL_SYNC_PENDING`, or `COMPLETED`). Together these tell you whether the integration is fully ready to serve data — see [integration states](./integration-states) for details.

```json integration-state-changed theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "integration-state-changed",
  "data": {
    "integration_tool": "personio",
    "integration_category": "HRIS",
    "integration_id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
    "end_user": {
      "origin_id": "36123",
      "creator_email": "user@example.com",
      "organization_name": "Acme, Inc."
    },
    "state": "ACTIVE",
    "qa_status": "PASSED",
    "setup_status": "COMPLETED"
    "updated_at": "2021-09-01T12:00:00.000Z"
  }
}
```

### Issue status changed

The `issue-status-changed` webhook is sent when Kombo [raises or resolves an issue](../features/issues). Subscribe once; every customer-visible issue type uses this webhook. See [issue types](../features/issue-types) for the current list. We will add more types over time, so your handler should treat `issue.type` as an open set and not fail on unknown values.

`change` is `raised` when the issue first appears or comes back after being resolved, and `resolved` when the condition clears. This webhook is only sent when the issue is raised or resolved. Snoozing only hides the issue in the Kombo dashboard, so snoozing, a snooze expiring, or updates to the message or other fields do not trigger it.

```json issue-status-changed theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "issue-status-changed",
  "data": {
    "change": "raised",
    "issue": {
      "id": "8f3a1c2e4b5d6a7c8e9f0a1b",
      "type": "integration.authentication_failed",
      "title": "Authentication failed",
      "status": "OPEN",
      "markdown_message": "**Acme, Inc.**'s personio HRIS integration failed authentication. This is often invalid, expired, or revoked credentials, but it can also be temporary provider downtime.\n\nCheck the [logs](https://app.kombo.dev/env/production/integrations/personio:CBNMt7dSNCzBdnRTx87dev4E/logs) first. If the credentials look invalid, create a reconnection link from the [integration page](https://app.kombo.dev/env/production/integrations/personio:CBNMt7dSNCzBdnRTx87dev4E) so the customer can reconnect.",
      "first_observed_at": "2021-09-01T12:00:00.000Z",
      "resolved_at": null
    },
    "integration": {
      "id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
      "tool": "personio",
      "category": "HRIS",
      "end_user": {
        "origin_id": "36123",
        "creator_email": "user@example.com",
        "organization_name": "Acme, Inc."
      }
    }
  }
}
```

## Validate the data

Anyone could post data to your webhook URL. That's why we're signing each
request with a secret specific to your Kombo account. This secret is called the
**Kombo Webhook Secret** and you can find it [on the Kombo
dashboard](https://app.kombo.dev/configuration/webhooks).

Each valid webhook `POST` request from us will include the `X-Kombo-Signature`
header. To validate it, carefully follow these steps:

1. Decode the `X-Kombo-Signature` header from [`base64url`
   encoding](https://base64.guru/standards/base64url) (without padding) to raw
   bytes.
2. Compute the HMAC-SHA256 over the **raw** JSON request body (Kombo encodes
   this using two-space indentation) with your **Kombo Webhook Secret** as raw
   bytes.
3. Compare the decoded signature bytes to the computed HMAC bytes using a
   constant-time comparison function (like [Node.js's
   `timingSafeEqual`](https://nodejs.org/docs/latest-v22.x/api/crypto.html#cryptotimingsafeequala-b))
   to protect against timing attacks.

<Warning>
  If you're stuck trying to get the signatures to match, please verify that:

  1. You're using the Webhook Secret of the **correct Kombo environment** (e.g.,
     production or development).
  2. You're using the **raw JSON request body**. If your framework already parses
     the JSON body for you, make sure to re-encode it with two-space indentation
     (e.g., `JSON.stringify(body, null, 2)` in JavaScript).
  3. You're decoding the signature header from `base64url` (not standard `base64`)
     and comparing raw bytes (not re-encoding the computed HMAC for string
     comparison).
</Warning>

Here are some examples of how you could achieve this in a few different languages:

<CodeGroup>
  ```ts TypeScript theme={null}
  import { createHmac, timingSafeEqual } from 'node:crypto'

  const signatureHeader = req.headers['x-kombo-signature']

  // Get the raw UTF-8-encoded string body because this was used for signing
  const body = request.body

  // Or if you use a framework that parses the body for you, you can use this.
  // Note: This is not the same as JSON.stringify(request.body)
  const body = JSON.stringify(request.body, null, 2)

  const expected = createHmac('sha256', KOMBO_WEBHOOK_SECRET)
  .update(body, 'utf8')
  .digest()

  // Decode and compare in constant time
  const provided = Buffer.from(signatureHeader, 'base64url')
  const isValidRequest =
  provided.length === expected.length && timingSafeEqual(expected, provided)

  ```

  ```python Python theme={null}
  import base64
  import hmac
  import hashlib

  provided_signature = request.headers.get('X-Kombo-Signature')

  secret = KOMBO_WEBHOOK_SECRET.encode()
  expected = hmac.new(secret, request_body, hashlib.sha256).digest()

  # Decode the provided signature and compare in constant time
  try:
    provided = base64.urlsafe_b64decode(provided_signature + '==')
    is_valid_request = hmac.compare_digest(expected, provided)
  except Exception:
    is_valid_request = False

  return is_valid_request
  ```

  ```kotlin Kotlin theme={null}
  val providedSignature = request.getHeader("X-Kombo-Signature")
  // CharStreams is from com.google.guava:guava library
  val requestBodyAsString = request.reader.use { CharStreams.toString(it) }

  // Calculate the signature
  val algorithm = "HmacSHA256"
  val encoding = Charsets.UTF_8
  val secret = KOMBO_WEBHOOK_SECRET.toByteArray(encoding)
  val signingKey = SecretKeySpec(secret, algorithm)
  val mac = Mac.getInstance(algorithm)
  mac.init(signingKey)

  val expected = mac.doFinal(requestBodyAsString.toByteArray(encoding))

  // Decode and compare in constant time
  val isValidRequest = try {
      val provided = Base64.getUrlDecoder().decode(providedSignature)
      MessageDigest.isEqual(expected, provided)
  } catch (e: Exception) {
      false
  }

  return isValidRequest

  ```
</CodeGroup>

## Testing webhooks

The list of all created webhooks has two buttons on the right. One is for
deleting the webhook, the other is for sending a test request. This test request
will contain dummy data but will use the correct data schema.

Be careful when using this feature in production! It will send invalid data to
your webhook.

### Testing locally

For local development, you can use a service like [localtunnel](https://theboroer.github.io/localtunnel-www/)
or [ngrok](https://ngrok.com/). These tools allow you to expose a local port
through a public URL provided by them. The setup is very straightforward: Once
you've started a tunnel, simply add the provided URL as a webhook in the Kombo
dashboard. You can then send test requests to validate that your endpoint is
working properly.

## Retry behavior

If your webhook endpoint does not acknowledge the webhook (returns an error or
does not respond), Kombo will automatically retry the delivery. This ensures
reliable webhook delivery even when your endpoint is temporarily unavailable.

### Retry attempts

Kombo will retry failed webhook deliveries up to **5 times** before giving up.
Each retry uses exponential backoff with the following delays:

* After 1st failure: 1 second
* After 2nd failure: 2 seconds
* After 3rd failure: 4 seconds
* After 4th failure: 8 seconds
* After 5th failure: 16 seconds

### Error conditions that trigger retries

Kombo will retry webhook deliveries for the following error conditions:

* **Rate limit errors** (HTTP 429): Retries respect `Retry-After` headers when
  provided
* **Server errors** (HTTP 5xx): Temporary server errors that may resolve on retry
* **Connection errors**: Network timeouts, connection resets, DNS failures, and
  other transient network issues
* **Cloudflare errors** (HTTP 409 with Cloudflare 1018 error): Temporary
  Cloudflare blocking errors

### Error conditions that do not trigger retries

The following errors will **not** trigger retries, as they indicate permanent
failures:

* **Client errors** (HTTP 4xx, except 429): These typically indicate issues with
  the webhook configuration or request format
* **DNS not found** (ENOTFOUND): The webhook URL cannot be resolved

### Best practices

To ensure reliable webhook delivery:

1. **Respond quickly**: Return a 2xx status code as soon as you've received and
   validated the webhook, even if you process it asynchronously
2. **Handle idempotency**: Webhooks may be delivered multiple times due to
   retries, so ensure your webhook handler is idempotent
3. **Monitor webhook logs**: Check the Kombo dashboard for webhook delivery
   failures and retry attempts

## Automatic deactivation of webhooks

If we are unable to find your webhook endpoint for more than 7 days (HTTP status
code 404 or 410), we will automatically disable the webhook. You can always
re-enable it in the dashboard.


# Connection setup
Source: https://docs.kombo.dev/ats/implementation-guide/ai-screening/connection-setup



The first part of the implementation is the setup of the connection. Your customer needs to generate and share their API credentials so that we can make the necessary API calls for the integration.

<img alt="1376" />

There are [multiple ways of implementing this step](/ats/getting-started/create-integrations#ways-of-creating-integrations), but during your development and for the first customers we highly recommend, just using the Magic Link feature that we provide. This guide will therefore assume that you are using the magic links for setting up the connection.

1. Generate a link for your customer. You only have to go into the [dashboard](https://app.kombo.dev/integrations) and:
   * Click on New integration

     <img alt="Click on new integration.png" />

   * Click on "Let your customer create the integration" (during development, you can also use the first option).

     <img alt="Click on let your customer create.png" />

   * Click on "Continue".

     <img alt="Click on continue.png" />

   * Copy the link.

     <img alt="Copy link.png" />

2. Wait for your customer to generate and enter their API credentials. You can see the status of any sent-out connection link in the [Kombo dashboard](https://app.kombo.dev/pending-connections).

   <Note>
     🦉 Setting up the credentials for an integration can be tricky for your non-technical users. That's why we highly recommend sharing our [step-by-step connection guides](https://help.kombo.dev/hc/en-us/sections/14349683218961-Connection-Guides) with them or guiding them through the process on a short call.
   </Note>

3. Receive the `integration-created` [webhook](/ats/guides/webhooks#integration-created). We send this webhook every time one of your customers creates a new integration.

   ```json theme={null}
   {
     "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
     "type": "integration-created",
     "data": {
       "id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
       "tool": "personio",
       "category": "ATS",
       "end_user": {
         "origin_id": "12345",
         "creator_email": "user@example.com",
         "organization_name": "Acme, Inc."
       }
     }
   }
   ```

   The `end_user.origin_id` [is submitted by you](/ats/v1/post-connect-create-link#:~:text=HRIS%22%2C%0A%20%20%22integration_tool%22%3A%20%22personio%22%2C-,%22end_user_origin_id%22%3A%20%22123%22%2C,-%22language%22%3A%20%22en%22%0A%7D%27) when creating a connection link and should represent the ID of your customer in your database. You need to store this ID in your database so that you'll know which ATS belongs to which customer. For example, if you have two customers with the IDs "42" and "43", then your database could look as follows after the integrations have been created:

   | end\_user.origin\_id | kombo\_integration\_id                    |
   | -------------------- | ----------------------------------------- |
   | 42                   | `personio:8d1hpPsbjxUkoCoa1veLZGe5`       |
   | 43                   | `successfactors:B1hu5NGyhdjSq5X3hxEz4bAN` |

   <Note>
     ⚠️ **This ID is not for public display** and should only be accessible to your backend. The ID is not a secret as such but it's one of two things needed alongside the API key. There is no way to list all integration IDs via the API key so even in a case of accidental API key leak, the data would still be safe.
   </Note>

**Alerting for customer problems**

We will send you a `connection-flow-failed` [webhook](/ats/guides/webhooks#connection-flow-failed) every time a customer is running into an issue. You should set up some sort of alerting based on this webhook so that you can be fast to offer help to your customer, should they have an error when setting up an integration.

```json theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "connection-flow-failed",
  "data": {
    "integration_tool": "personio",
    "integration_category": "ATS",
    "end_user": {
      "origin_id": "123456",
      "creator_email": "user@example.com",
      "organization_name": "Acme, Inc."
    },
    "log_url": "https://app.kombo.dev/env/production/logs/C3xUo6XAsB2sbKC7M1gyXaRX"
  }
}
```

**Handling deleted integrations**

It is of course also possible to delete integrations. This can be done in two ways:

* via the [“delete integration”-endpoint](/ats/v1/delete-integrations-integration-id). If you are calling this endpoint you should also take care of deleting the `kombo_integration_id` from your database.
* via the `integration-deleted` [webhook](/ats/guides/webhooks#integration-deleted). This will be sent to you if someone goes into the Kombo dashboard and deletes an integration manually. Also then you'll have to remove the `kombo_integration_id` from your database.

  ```json theme={null}
  {
    "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
    "type": "integration-deleted",
    "data": {
      "id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
      "tool": "personio",
      "category": "ATS",
      "end_user": {
        "origin_id": "123456",
        "creator_email": "user@example.com",
        "organization_name": "Acme, Inc."
      },
      "deleted_at": "2022-11-02T10:50:10.242Z"
    }
  }
  ```


# Setup
Source: https://docs.kombo.dev/ats/implementation-guide/ai-screening/setup



Before we can get started with development, there's a bit of setup to do. Please follow the steps below carefully so that you won't have any issues down the line.

## Log into the dashboard

Log into the Kombo dashboard. You should have received an **invite via email** but if you didn't, **reach out** to your team members or to Kombo directly via Slack/Teams

<img alt="1376" />

## Integration configuration

Go to the [tools overview](https://app.kombo.dev/tools) and select / deselect all integrations that you want to offer. You can change this at any time.

<img alt="1376" />

## Scope configuration

Go to the [scopes overview](https://app.kombo.dev/scope-config) and click on "**New config**" or "**Edit**" an existing one.

<img alt="1376" />

Select the data models that you need and click on "**Save changes**".

<img alt="1376" />

<Note>
  🦉 These scopes are **just for development**. To understand more about this feature and how to use it to evoke a great first impression with customers, [read more here](/ats/features/scopes).
</Note>

## Set up a linked account for development

To call the API you always need to have a linked ATS account to pull and push data from. You can either [get yourself a sandbox via a free trial](/ats/getting-started/sandbox-integrations), or use our built-in mock integration to get started faster (recommended).

Go to the [integrations tab](https://app.kombo.dev/integrations) and click on "**Create a sandbox integration**".

<img alt="1376" />

Click "**Continue**" and "**Set up integration**".

<div>
  <img alt="First Image Description" />

  <img alt="Second Image Description" />

  <img alt="Third Image Description" />
</div>

**Click** on the tile that just appeared to get to the details page of the integration.

<img alt="1376" />

On this page, you can find all info related to the integration. For now, we will only need the integration ID though.

<img alt="Integration details 1.png" />

## Create Kombo API key

Go to the [Secrets tab](https://app.kombo.dev/secrets) and click on "**New API key**".

<img alt="1376" />

Name the API key and click "**Create API key**".

<img alt="Create API key.png" />

Copy the token and store it somewhere safe.

<img alt="Create API key.png" />

## Test your setup

🎉 You made it through the setup and have everything in place to get started developing 🎉

To verify you set up the sandbox integration and API key correctly, try the following HTTP request to the ["get integration details"-endpoint](/ats/v1/get-integrations-integration-id)

```bash theme={null}
curl --request GET \
  --url https://api.kombo.dev/v1/integrations/{integration_id} \
  --header 'Authorization: <api_key>'
```

You can also use any other endpoint like ["get jobs"](/ats/v1/get-jobs) or ["create application"](/ats/v1/post-jobs-job-id-applications). The Sandbox integration will return you some sample data for it.

<Tip>
  **Tip:** You can use our [official server-side SDKs](/libraries-and-sdks) to
  interact with the Kombo API in an ergonomic and type-safe manner. Check if
  your tech stack is already supported!
</Tip>

## Optional: set up Postman collection

To make development easier, we recommend setting up a Postman collection. It takes only one minute and can be done like this:

* **Copy** the link of our OpenAPI schema:

  ```bash theme={null}
  https://api.kombo.dev/openapi.json
  ```

* Open Postman, and click **Import**
  <img alt="1376" />

* **Paste** the URL and click **Import**

  <img alt="Postman URL.png" />

  <img alt="Postman Collection.png" />


# Connection setup
Source: https://docs.kombo.dev/ats/implementation-guide/connection-setup



The first part of the implementation is the setup of the connection. Your customer needs to generate and share their API credentials so that we can make the necessary API calls for the integration.

<img alt="1376" />

There are [multiple ways of implementing this step](/ats/getting-started/create-integrations#ways-of-creating-integrations), but during your development and for the first customers we highly recommend, just using the Magic Link feature that we provide. This guide will therefore assume that you are using the magic links for setting up the connection.

1. Generate a link for your customer. You only have to go into the [dashboard](https://app.kombo.dev/integrations) and:
   * Click on New integration

     <img alt="Click on new integration.png" />

   * Click on "Let your customer create the integration" (during development, you can also use the first option).

     <img alt="Click on let your customer create.png" />

   * Click on "Continue".

     <img alt="Click on continue.png" />

   * Copy the link.

     <img alt="Copy link.png" />

2. Wait for your customer to generate and enter their API credentials. You can see the status of any sent-out connection link in the [Kombo dashboard](https://app.kombo.dev/pending-connections).

   <Note>
     🦉 Setting up the credentials for an integration can be tricky for your non-technical users. That's why we highly recommend sharing our [step-by-step connection guides](https://help.kombo.dev/hc/en-us/sections/14349683218961-Connection-Guides) with them or guiding them through the process on a short call.
   </Note>

3. Receive the `integration-created` [webhook](/ats/guides/webhooks#integration-created). We send this webhook every time one of your customers creates a new integration.

   ```json theme={null}
   {
     "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
     "type": "integration-created",
     "data": {
       "id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
       "tool": "personio",
       "category": "HRIS",
       "end_user": {
         "origin_id": "36123",
         "creator_email": "user@example.com",
         "organization_name": "Acme, Inc."
       }
     }
   }
   ```

   The `end_user.origin_id` [is submitted by you](/ats/v1/post-connect-create-link#:~:text=HRIS%22%2C%0A%20%20%22integration_tool%22%3A%20%22personio%22%2C-,%22end_user_origin_id%22%3A%20%22123%22%2C,-%22language%22%3A%20%22en%22%0A%7D%27) when creating a connection link and should represent the ID of your customer in your database. You need to store this ID in your database so that you'll know which ATS belongs to which customer. For example, if you have two customers with the IDs "42" and "43", then your database could look as follows after the integrations have been created:

   | end\_user.origin\_id | kombo\_integration\_id                    |
   | -------------------- | ----------------------------------------- |
   | 42                   | `personio:8d1hpPsbjxUkoCoa1veLZGe5`       |
   | 43                   | `successfactors:B1hu5NGyhdjSq5X3hxEz4bAN` |

   <Note>
     ⚠️ **This ID is not for public display** and should only be accessible to your backend. The ID is not a secret as such but it's one of two things needed alongside the API key. There is no way to list all integration IDs via the API key so even in a case of accidental API key leak, the data would still be safe.
   </Note>

**Alerting for customer problems**

We will send you a `connection-flow-failed` [webhook](/ats/guides/webhooks#connection-flow-failed) every time a customer is running into an issue. You should set up some sort of alerting based on this webhook so that you can be fast to offer help to your customer, should they have an error when setting up an integration.

```json theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "connection-flow-failed",
  "data": {
    "integration_tool": "personio",
    "integration_category": "ATS",
    "end_user": {
      "origin_id": "123456",
      "creator_email": "user@example.com",
      "organization_name": "Acme, Inc."
    },
    "log_url": "https://app.kombo.dev/env/production/logs/C3xUo6XAsB2sbKC7M1gyXaRX"
  }
}
```

**Handling deleted integrations**

It is of course also possible to delete integrations. This can be done in two ways:

* via the ["delete integration"-endpoint](/ats/v1/delete-integrations-integration-id). If you are calling this endpoint you should also take care of deleting the `kombo_integration_id` from your database.
* via the `integration-deleted` [webhook](/ats/guides/webhooks#integration-deleted). This will be sent to you if someone goes into the Kombo dashboard and deletes an integration manually. Also then you'll have to remove the `kombo_integration_id` from your database.

  ```json theme={null}
  {
    "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
    "type": "integration-deleted",
    "data": {
      "id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
      "tool": "personio",
      "category": "ATS",
      "end_user": {
        "origin_id": "123456",
        "creator_email": "user@example.com",
        "organization_name": "Acme, Inc."
      },
      "deleted_at": "2022-11-02T10:50:10.242Z"
    }
  }
  ```


# Context
Source: https://docs.kombo.dev/ats/implementation-guide/context



Kombo offers a unified API for talent acquisition solutions. We allow our customers to build a single integration to Kombo and instantly launch all the ATS integrations in **[Kombo’s ever-growing portfolio](https://www.kombo.dev/categories/ats)** to their customers.

We do this by standardizing the data models exposed by the integrations we support and allowing you to interact with them using a set of clearly defined endpoints.

This way, reading jobs from an enterprise ATS solution like **[SAP SuccessFactors](https://www.kombo.dev/integrations/successfactors)** will look the same as reading jobs from a more SMB-focused tool like **[Personio](https://www.kombo.dev/integrations/personio)**. It’s the same set of data models and fields you can rely on.

This means that you have to **implement the logic for your integration only one single time** and offer over 50 ATS integrations to your customers (and add new ones) without adding one more line of code for a new tool

The integration can be divided into those four steps, which we will cover in detail later on

<img alt="1376" />


# Creating applications
Source: https://docs.kombo.dev/ats/implementation-guide/creating-applications



<img alt="1376" />

[Create application - Kombo](/ats/v1/post-jobs-job-id-applications)

## Create a candidate for the application

When using Kombo’s “Create Application” endpoint you don’t have to handle the logic of creating a candidate for the application. We already automatically handle it in the following manner:

* If there is no candidate in the system for a given application, we will automatically create a new candidate
* If there already is a candidate in the system that matches with the application, we will attach the application to the candidate

## Set the source of the application

When creating an application you want to let your customers know that this application is coming from you. Otherwise, they won’t know how many of their hires were because of your candidates and therefore how much value you created for them.

Our “Create Application” endpoint will automatically set the source of the candidate for you on every created application ([see more here](/ats/features/application-attribution))

<Info>
  🦉 Most ATS set the source on the candidate level (not the application level). If you are creating an application for a candidate that has existed in the system before, we won’t override the source.
</Info>

We will by default use the name of your environment (if your env is called “Example Customer (Prod)” the source will show up as “Example Customer”. If you want to change this name, please reach out to us.

Some ATS will require the user to configure the source in their ATS settings. In those cases, we will ask your customer to do so as part of connecting their ATS and provide additional help in our help center.

[How to capture the source of candidates in an ATS – Kombo](https://help.kombo.dev/hc/en-us/sections/17072757205265-How-to-capture-the-source-of-candidates-in-an-ATS)

## Upload attachments with the application

You can upload any number of attachments to an application via the `attachments` array in the request body. The first CV in the attachments will be treated as the resume of the candidate when the tool allows previewing a resume.

There are two ways to submit the document that will be uploaded:

* as a base64 string: you can encode the attachment and put it into the `attachments.[*].data` field. This will cause your requests and logs to be quite large, though.
* via a download URL (recommended): if you don’t want to work with large base64 strings, you can provide a download URL to the `attachments.[*].data_url` field.

Those two ways are mutually exclusive. You can’t submit both `data` and `data_url` at the same time.

We recommend that the summed up size of all attachments that are submitted with an application should be below 10 MB, as this is within the file size limits of most ATS.

<Tip>
  ♻️ **What happens if there is an invalid attachment submitted?**

  If the attachment is rejected by the ATS, we will retry creating the application without the attachment. If the request then succeeds, the application will be created without the attachment and you will receive a successful response that has one record per failed attachment in the `warnings` array

  ```json theme={null}
  {
    "status": "success",
    "data": ...,
    "warnings": [
      {
        "message": "string"
      }
    ]
  }
  ```
</Tip>

## Error Handling

Creating an application can fail for various reasons. The API returns structured errors with specific `code`s to help you handle each scenario appropriately:

```json theme={null}
{
  "status": "error",
  "error": {
    "code": "ATS.JOB_CLOSED",
    "title": "The requested job is closed.",
    "message": "The job with the remote id \"100\" is marked as \"archived\""
  }
}
```

For a complete list of error codes and detailed explanations see the [Error Handling guide](/guides/errors).

## Retry behavior

We have implemented retry logic on our side with each underlying tool (e.g Personio, SmartRecruiters, etc). That means we’ll retry errors with status code `429`, any `5xx` error and if we get no response at all from the tool.

Therefore, please **only retry requests with [certain error `code`s](/guides/errors#which-errors-can-be-safely-retried%3F) that are safe to retry.**

## Write answers to screening questions

If you want to submit the answer to a screening question to the ATS you have to first read the questions that are asked per job. You will get this info by having the “Read screening questions” scope enabled in your [scope config](https://app.kombo.dev/scope-config).

<img alt="Enable scopes.png" />

You will then get the questions along with possible answers delivered on each job:

```json theme={null}
{
  "status": "success",
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "id": "26vafvWSRmbhNcxJYqjCzuJg",
        "remote_id": "32",
        "name": "Backend Engineer",
        ...
        "screening_questions": [
          {
            "id": "26vafvWSRmbhNcxJYqjCzuJg",
            "remote_id": "48b4d36a-1d4b-4c50-ada7-9519078e65b4",
            "title": "Which is your primary programming language?",
            "description": "Please enter the language you are most comfortable with.",
            "format": {
              "display_type": "SINGLE_LINE",
              "max_length": null,
              "type": "TEXT"
            },
            "index": 0,
            "required": true
          }
        ]
      }
    ]
  }
}
```

### Screening Question Formats

Please find a description below of the type as well as an example of each:

<Accordion title="Screening questions formats and examples.">
  ```typescript theme={null}
  type ScreeningQuestionFormat =
    | {
        type: 'TEXT'
        display_type: 'SINGLE_LINE' | 'MULTI_LINE' | null
        max_length: number | null
      }
    | {
        type: 'NUMBER'
        display_type: 'SLIDER' | 'FIELD' | null
        min: number | null
        max: number | null
      }
    | {
        type: 'FILE'
      }
    | {
        type: 'SINGLE_SELECT'
        options: {
          id: string
          remote_id: string | null
          name: string
        }[]
        display_type: 'DROPDOWN' | 'RADIO' | null
      }
    | {
        type: 'BOOLEAN'
      }
    | {
        type: 'DATE'
      }
    | {
        type: 'MULTI_SELECT'
        options: {
          id: string
          remote_id: string | null
          name: string
        }[]
      }
    | {
        type: 'INFORMATION'
      }
    | {
        type: 'UNKNOWN'
        raw_question?: any
      }

  const examples: ScreeningQuestionFormat[] = [
    {
      type: 'TEXT',
      display_type: 'SINGLE_LINE',
      max_length: 100,
    },
    {
      type: 'NUMBER',
      display_type: 'SLIDER',
      min: 0,
      max: 10,
    },
    {
      type: 'FILE',
    },
    {
      type: 'SINGLE_SELECT',
      options: [
        {
          id: 'kombo-id-of-question-for-answer',
          remote_id: 'remote-id-of-question',
          name: 'What is your favorite color?',
        },
      ],
      display_type: 'DROPDOWN',
    },
    {
      type: 'BOOLEAN',
    },
    {
      type: 'DATE',
    },
    {
      options: [
        {
          id: 'kombo-id-of-question-for-answer',
          remote_id: 'remote-id-of-question',
          name: 'What is your favorite color?',
        },
      ],
      type: 'MULTI_SELECT',
    },
    {
      type: 'INFORMATION',
    },
    {
      type: 'UNKNOWN',
      // Can be anything
      raw_question: {},
    },
  ]
  ```
</Accordion>

When creating the application you can pass them by providing a record for each question in the `screening_question_answers` array, like so:

```json theme={null}
{
  ...
  "screening_question_answers": [
    {
      // For a text question
      "question_id": "26vafvWSRmbhNcxJYqjCzuJg",
      "answer": "TypeScript"
    },
    {
      // For a single-select question
      "question_id" :"WA6SZ7R7YSo2C3WDLE5zmAJ",
      "answer": "3WA6SZ7R7YSo2C3WDLE5zmAJ", // ID of the answer-option
    },
    {
      // For a multi-select question
      "question_id" :"WA6SZ7R7YSo2C3WDLE5zmAJ",
      "answer": [
        "3WA6SZ7R7YSo2C3WDLE5zmAJ", // IDs of the answer-options
        "21KvMGS9Yhsbbsxfwqyb5dkF"
      ]
    }
  ]
}
```

Be aware that some ATS have **required screening questions** (`screening_questions[*].required == true`) and force you to submit an answer if you want to create an application. We let you know about some of the workarounds [in our guide on customer-specific edge cases](#handling-required-screening-questions).

## Handle ATS-specific limitations

Some ATS don’t support certain features such as screening questions. You get this information via the [coverage grid](https://app.kombo.dev/coverage/ats) or the [“get tools” endpoint](/ats/v1/get-tools-category) that will show you the supported data models, write actions and features via the `coverage` object:

```json theme={null}
{
  "status": "success",
  "data": {
    "tools": [
      {
        "id": "workday",
        "label": "Workday",
        "assets": {
          "logo_url": "https://storage.googleapis.com/kombo-assets/integrations/workday/logo.svg",
          "icon_url": "https://storage.googleapis.com/kombo-assets/integrations/workday/icon.svg",
          "icon_black_url": "https://storage.googleapis.com/kombo-assets/integrations/workday/icon-black.svg"
        },
        "coverage": {
          "read_models": [
            {
              "id": "ats_jobs",
              "label": "Jobs"
            },
            {
              "id": "ats_applications",
              "label": "Applications"
            },
            {
              "id": "ats_candidates",
              "label": "Candidates"
            }
          ],
          "write_actions": [
            {
              "id": "ats_create_candidate",
              "label": "Create candidate"
            }
          ],
          "features": [
            {
              "id": "automatic_source_writing",
              "label": "Automatic Source Writing"
            },
            {
              "id": "ats_sync_only_created_applications",
              "label": "Sync Only Created Applications"
            },
            {
              "id": "ats_create_candidate_full_attachments_retry",
              "label": "Create Candidate Full Attachment Retry"
            }
          ]
        }
      }
    ]
  }
}
```

You can build logic both in your frontend and your backend based on this endpoint.

## Required fields

Before you go live with your first customer, there are a few things to look out for to make the connection go as smoothly as possible.

### Handling required screening questions

As mentioned in the [“screening questions” section when creating applications](#write-answers-to-screening-questions), some ATS force you to submit the answer to a given question and will reject any applications that don’t have answers attached.

This won’t be a problem with a lot of questions but some will have the `required: true` boolean set, so watch out for those.

```json theme={null}
{
  "status": "success",
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "id": "26vafvWSRmbhNcxJYqjCzuJg",
        "remote_id": "32",
        "name": "Backend Engineer",
        ...
        "screening_questions": [
          {
            "id": "26vafvWSRmbhNcxJYqjCzuJg",
            "remote_id": "48b4d36a-1d4b-4c50-ada7-9519078e65b4",
            "title": "Which is your primary programming language?",
            ...
            "required": true
          }
        ]
      }
    ]
  }
}
```

Here are our suggestions to handle this:

* **Collect the answers:** You can implement a frontend component that dynamically renders a form based on the Kombo API response. The candidate can then submit the actual answers to screening questions and you can submit them to the ATS.

  While this would sure be the cleanest solution, some of our customers don’t want to implement this because it violates their idea of a one-click-apply solution or takes too much engineering capacity.

* **Ask the customer to remove questions:** if you don’t want to collect the answers to screening questions, you could ask your customer to remove these questions.

* **Clearly submit non-data:** For most fields (except for dropdowns, numbers, and booleans) you can “auto-fill” some data that will make it clear to your customer that this is not an actual response from the candidate. For example, submitting an empty string or “-” for text fields, submitting a date that is very clearly in the past, etc.

  <Warning>
    ✋ Be wary with this approach: your customer explicitly sets those questions to be required and might not appreciate you working around their requirement.
  </Warning>

* **Implement customer-specific logic:** A less scalable way is to implement custom logic for each customer that either hard-codes data points or dynamically maps them based on other data of the candidate. This approach is sometimes the most pragmatic solution if you have a low number of customers that require screening questions, however, it’s not very scalable with a large number of customers in production.
  * **Agree on preset answers:** When onboarding a customer you can share the problem of required screening questions with them and agree together on a number of fixed answers for all/the most common screening questions.

## SuccessFactors

### Application Templates & Screening Questions

#### Before connecting:

In SuccessFactors, customers can define **"Job Application Templates"** associated with their job requisitions. These templates include custom fields that may vary based on the requisition's location. Applicants are required to complete these custom fields as **screening questions** upon submitting their applications. Kombo has the ability to process the templates, and to surface these fields to you as screening questions that you can then answer to successfully submit candidates to SuccessFactors successfully.

<Note>
  It is advisable to verify with your customer whether they utilize Job
  Application Templates and whether their templates include defined custom
  fields. If it turns out that the Job Application Templates are utilised,
  please follow the steps below after the connection has been established.
</Note>

#### After connecting:

Once the connection to the customer's system is established and the initial sync has finished, please follow these steps:

1. **Export Job Application Templates from SuccessFactors:** For detailed instructions, refer to our help center article:
   * [How to export SuccessFactors Job Application Templates](https://help.kombo.dev/hc/en-us/articles/36147518625809-SAP-SuccessFactors-How-to-export-a-job-application-template)

2. **Upload Templates to the Kombo Dashboard:** After the initial synchronization, navigate to the settings page of the integration and upload each template to its corresponding slot. Note: You likely only have to upload the templates for the jobs that you'll need coverage for.

3. **Process the newly returned Screening Questions:** We will utilize the templates to generate a list of fields as they are defined within the templates. We will then turn these fields into screening questions. This ensures that applications and candidates can be submitted successfully to SuccessFactors.

<Frame>
  <img alt="image" />
</Frame>


# Moving and Rejecting Candidates
Source: https://docs.kombo.dev/ats/implementation-guide/moving-and-rejecting-candidates



You can take automated action in the ATS by moving an application to a stage or rejecting it. These actions work on **any application that Kombo has synced** — regardless of whether it was originally created through Kombo or already existed in the ATS before the customer connected.

### Moving Application Stage

To move an application, you need the **application ID** and the **stage ID** to move it to.

<Info>
  Always get stage IDs from the [`stages` property on jobs](/ats/v1/get-jobs),
  not from the deprecated `/application-stages` endpoint. Many ATS systems have
  job-specific stages. Using global stage IDs will often result in "Stage not
  found" errors.
</Info>

* Enable the `Set Application Stage` scope in your [scope configuration](https://app.kombo.dev/scope-config).

Use the [Move Application Stage endpoint](/ats/v1/put-applications-application-id-stage) with the target stage:

```json theme={null}
{
  "stage_id": "3PJ8PZhZZa1eEdd2DtPNtVup"
}
```

If you're implementing screening, you'll typically save the target stage ID during the [screening trigger stage setup](/ats/implementation-guide/reading-applicants#set-screening-trigger-stage).

### Reject Applications

Use the [Reject Application endpoint](/ats/v1/post-applications-application-id-reject) to reject an application.

* Enable the `Reject Applications` scope in your [scope configuration](https://app.kombo.dev/scope-config).

To get possible rejection reasons, use the [Get Rejection Reasons endpoint](/ats/v1/get-rejection-reasons). Then pass the reason and an optional note:

```json theme={null}
{
  "rejection_reason_id": "3PJ8PZhZZa1eEdd2DtPNtVup",
  "note": "Candidate was a great culture fit but didn't bring the hard skills we need."
}
```

<Warning>
  Rejecting an application may trigger automated workflows in your customer's
  ATS (e.g., sending a rejection email to the candidate). Make sure your
  customer is aware of this before enabling automated rejections.
</Warning>


# Reading Applications
Source: https://docs.kombo.dev/ats/implementation-guide/reading-applicants



Reading Applications allows you to retrieve all applications from an ATS.

## Reading All Applications

In order to ensure you read all applications from your customer's ATS, you must configure the `Only Sync Created Applications` toggle to off in your dashboard.

<img alt="1378" />

This can be done [here](https://app.kombo.dev/configuration/writing-candidates) in your Kombo Dashboard.

Kombo uses multiple approaches (e.g., syncs and upstream webhooks) to ingest data from the ATS. Whenever we detect a change in the ATS—for example, a new candidate is created—you will receive a `data-changed` webhook allowing you to fetch any new data from Kombo.
More information on fetching data can be found in [Fetching Data](/ats/getting-started/fetching-data).

<img alt="1377" />

Once the first sync finishes, and whenever new data becomes available, you will receive a `data-changed` webhook.
Then, using the [GET Applications endpoint](/ats/v1/get-applications), applications can be read from the ATS into your system.

## Set Screening Trigger stage

You will want to identify the trigger stage(s) for your screening.
On the [GET Jobs endpoint](/ats/v1/get-jobs), you will see the stages object.

```json theme={null}
{
  "status": "success",
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "id": "26vafvWSRmbhNcxJYqjCzuJg",
        "remote_id": "32",
        "name": "Backend Engineer",
        ...,
        "stages": [
          {
            "id": "3PJ8PZhZZa1eEdd2DtPNtVup",
            "remote_id": "32",
            "name": "Initial Screening",
            "index": 0
          },
          {
            "id": "HWUTwvyx2wLoSUHphiWVrp28",
            "remote_id": "38",
            "name": "Interview",
            "index": 1
          },
        ],
      }
    ]
  }
}
```

You will have to identify the stage at which screening should occur.
It is possible to use the index, `stages.id`, or stage name to identify the stage(s) to trigger screening. You may also want to involve your customer in identifying the trigger stage. We recommend using the `stages.id`.

<Note>
  If you plan on moving an application we would recommend that you also identify
  the `stages.id` for the next stage in the application process and store this
  in your database. As you will need this in order to move the application to
  the next stage.
</Note>

### Understanding Stage Ordering

Each stage on the [GET Jobs endpoint](/ats/v1/get-jobs) includes an `index` field that represents its position in the hiring pipeline. The `stages` array is sorted by `index` in ascending order.

<Warning>
  The `index` field can be `null` when the underlying ATS does not expose stage
  ordering. Stages with a `null` index are sorted last. Always check for `null`
  before relying on `index` for ordering logic.
</Warning>

In many ATS systems, each job can have a **custom hiring process** — a different configuration of stages per job. Always get stage IDs and their order from the `stages` property on each specific job, not from the deprecated `/application-stages` endpoint.

### Tracking Stages

You will have to keep track of applications during the application process in order to check whether the stage of the application has changed to the trigger stage.
To see whether the stage of an application has changed, you have to implement some tracking logic on your end by calling the [GET Applications endpoint](/ats/v1/get-applications) with the `updated_after` filter and then comparing the stage of each candidate with the stage you currently have in your system.

When you fetch the applications via the [GET Applications endpoint](/ats/v1/get-applications), you will get the `current_stage_id` and `current_stage` properties for each application. The `current_stage` is an expanded version of the `current_stage_id` that includes the stage `name` and `index`:

```json theme={null}
{
  "status": "success",
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "id": "26vafvWSRmbhNcxJYqjCzuJg",
        "remote_id": "32",
        ...
        "current_stage_id": "5J7L4b48wBfffYwek9Az9pkM",
        ...
        "current_stage": {
          "id": "5J7L4b48wBfffYwek9Az9pkM",
          "remote_id": "32",
          "name": "Initial Screening",
          "index": 0
        },
      }
    ]
  }
}
```

## Get Attachments

As a screening company you may want to read candidates' CVs. This can be done using the [GET Application Attachments endpoint](/ats/v1/get-applications-application-id-attachments).

<Note>
  For every application you must make a request to retrieve the attachment
</Note>

* This endpoint requires the permission `Read document attachments` to be enabled in your [scope configuration](https://app.kombo.dev/scope-config).

You will need to provide the `application_id` for each application you want to get the attachments for.

```
curl --request GET \
  --url https://api.kombo.dev/v1/ats/applications/{123abc}/attachments \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Integration-Id: <x-integration-id>'
```

## Screening Questions

Once you read in applications you can get the screening questions and answers from the screening\_question\_answers object on the get applications endpoint response.

```
"screening_question_answers": [
          {
            "answer": {
              "choice": "TypeScript"
            },
            "question": {
              "remote_id": "48b4d36a-1d4b-4c50-ada7-9519078e65b4",
              "title": "Which is your primary programming language",
              "type": "SINGLE_SELECT"
            }
          }
        ],
```


# Reading jobs
Source: https://docs.kombo.dev/ats/implementation-guide/reading-jobs



We are not syncing the data from your customer’s ATS in real-time but on a periodic basis (if you are curious, we describe the reasoning for this [here](/ats/guides/sync)).

<img alt="1376" />

When your customer first connects their ATS, we immediately start syncing the data.

To prevent returning incomplete data while it's still running, you will not get any data until the *first sync* completes.
If you send a request before that, the API responds with an [error `code`](/guides/errors) like `INTEGRATION.SETUP_SYNC_PENDING`:

```json theme={null}
{
  "status": "error",
  "error": {
    "code": "INTEGRATION.SETUP_SYNC_PENDING",

    "title": "The integration's setup sync is still running.",
    "message": "The first sync of this integration didn't finish successfully yet! You can keep polling this until you get a successful response or react to our webhooks."
  }
}
```

| Code                                                                              | When it appears                              | What to do                                                                  |
| --------------------------------------------------------------------------------- | -------------------------------------------- | --------------------------------------------------------------------------- |
| [`INTEGRATION.SETUP_SYNC_PENDING`](/guides/errors#integration-setup-sync-pending) | Initial sync is still running.               | Keep polling or listen to data-changed.                                     |
| [`INTEGRATION.SETUP_INCOMPLETE`](/guides/errors#integration-setup-incomplete)     | Some steps have not been completed yet.      | Please finish the setup. Then keep polling or listen to data-changed.       |
| [`INTEGRATION.QA_FAILED`](/guides/errors#integration-qa-failed)                   | Incomplete data triggered Quality Assurance. | Wait for Kombo support to fix this. Keep polling or listen to data-changed. |

If you receive one of these error `code`s keep requesting the endpoint until you get a successful response.
Alternatively listen to our [`data-changed` webhook](/ats/guides/webhooks#data-changed).

```json theme={null}
{
  "id": "FhghqjnCi9WuAoLT8Z75CFcs",
  "type": "data-changed",
  "data": {
    "integration_id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
    "integration_tool": "personio",
    "integration_category": "ATS",
    "changed_models": [{ "name": "ats_jobs" }]
  }
}
```

<Note>
  🦉 The first syncing of data could **take a few seconds up to multiple hours**, depending on your scope config, the system itself (some are heavily rate-limited) and how much data is in the system of your customer.

  The UX for your customer should therefore be designed around some delay/waiting time.
</Note>

Once the first sync is finished, you must [pull the data](/ats/getting-started/querying-api) from the Kombo API and store it in your system so that you can show it to your customer without having to call the API again.

[Get jobs - Kombo](/ats/v1/get-jobs)

When querying data from the Kombo API, you should consider the following things:

* we recommend setting the `page_size` query param to the maximum batching (250 elements) to minimize number of API calls and maximize API response size.
  * Our API is optimized to serve a few calls with large payloads at comparatively low latencies. That makes our API perfect for batch-requesting large amounts of data in a few seconds.
* unless you want to get jobs that are not currently open, you should set the `statuses` filter to `OPEN`
  The possible options here are `OPEN`, `CLOSED`, `DRAFT`, `ARCHIVED`
* make sure to implement **[pagination](/ats/getting-started/querying-api#pagination)**, by using the `next` key in our API response and passing it in the `cursor` query param
* <a />
  if you are searching for only specific jobs, you can use any of our filters to
  search for them more easily using the endpoint-specific filters, such as
  `remote_ids`, `job_codes`, `name_contains`, `post_url` . Here it is important
  to once again batch requests. Instead of sending 20 individual requests
  containing one ID each, send one request with comma-separated IDs.
* the `job_code` field on jobs corresponds to the human-readable code that HR
  teams assign in the ATS. In many systems, this is referred to as the
  "Requisition Code" or "Requisition ID". The `remote_id` field, by contrast,
  is the ATS system's internal identifier and is typically not visible to
  recruiters.

A request to the “get jobs” endpoint could therefore look like this:

```bash theme={null}
curl --request GET \
  --url 'https://api.kombo.dev/v1/ats/jobs?page_size=250&statuses=OPEN&cursor=eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0' \
  --header 'Authorization: <authorization>' \
  --header 'X-Integration-Id: join:HWUTwvyx2wLoSUHphiWVrp28'
```

## **Getting updates on the data**

To get updates on the data, we discourage re-reading the entire dataset every time you want to update something. We have implemented change tracking for you so that you can just process the records that have changed.

The change-tracking of Kombo (which you can learn more about [here](/ats/getting-started/fetching-data)) centers around the `updated_after` query parameter, which you can use in the following way:

1. Store the timestamp at which you start ingesting the data from the first fetch in your own database. This field should probably be called something like this:

| customer\_id           | kombo\_integration\_id              | last\_fetched\_from\_kombo\_at |
| ---------------------- | ----------------------------------- | ------------------------------ |
| `<end_user.origin_id>` | `personio:8d1hpPsbjxUkoCoa1veLZGe5` | `1970-01-01T00:00:00.000Z`     |
| `<end_user.origin_id>` | `hibob:B1hu5NGyhdjSq5X3hxEz4bAN`    | `1970-01-01T01:13:24.000Z`     |

2. Whenever Kombo detects a change, we send you a `data-changed` [webhook](/ats/guides/webhooks#data-changed) that looks like this:

   ```json theme={null}
   {
     "id": "FhghqjnCi9WuAoLT8Z75CFcs",
     "type": "data-changed",
     "data": {
       "integration_id": "personio:8d1hpPsbjxUkoCoa1veLZGe5",
       "integration_tool": "personio",
       "integration_category": "ATS",
       "changed_models": [{ "name": "ats_jobs" }]
     }
   }
   ```

3. You should make a lookup in your database, finding the `last_fetched_from_kombo_at` for this specific integration and then pass it again in the `updated_after` query param of the get endpoint, like this:

   ```bash theme={null}
   curl --request GET \
     --url 'https://api.kombo.dev/v1/ats/jobs?page_size=200&statuses=OPEN&cursor=eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0&updated_after=1970-01-01T00:00:00.000Z&included_deleted=true' \
     --header 'Authorization: <authorization>' \
     --header 'X-Integration-Id: join:HWUTwvyx2wLoSUHphiWVrp28'
   ```

   Please be aware that when updating jobs, you want to set the param `include_deleted` to `true` so that you can be notified of jobs that were deleted. You can learn more about how to handle those jobs [here](#reacting-to-deleted-closed-jobs).

4. We will return all records that have been altered in one of the following ways:
   * property changed (i.e. `status` property of a job)
   * relation property changed (`description` of a `screening_question` related to a job)

5. If you want to see **which** property of a record has changed, you have to compare the current data to the data you have stored in your own database. Kombo does not provide you with a “previous” value for the data points.

## **Handling failing syncs**

It is possible that a sync fails, and if that happens, you will still be able to access the data based on the latest successful sync. Once the sync succeeds again, you will be able to get all updates that have happened since the last time.

When a sync fails, the `sync-finished` webhook has a `data.sync_state` property that is not `"SUCCEEDED"`:

```json theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "sync-finished",
  "data": {
    "sync_id": "B89SCXXho7Yw8PGo8AKJxLn4",
    "sync_state": "AUTHENTICATION_FAILED",
    "sync_started_at": "2021-09-01T12:00:00.000Z",
    "sync_ended_at": "2021-09-01T12:30:00.000Z",
    "sync_duration_seconds": 1800,
    "integration_id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
    "integration_tool": "personio",
    "integration_category": "ATS",
    "log_url": "https://app.kombo.dev/env/production/logs/C3xUo6XAsB2sbKC7M1gyXaRX"
  }
}
```

If you receive these values it means the **sync went through** and you’ll get updates of the data

| `sync_state`       | Explanation                        | How to fix                 |
| ------------------ | ---------------------------------- | -------------------------- |
| `SUCCEEDED`        | Everything went fine               |                            |
| `PARTIALLY_FAILED` | Succeeded but had non-fatal errors | Kombo will take care of it |

These values mean the sync failed and the **problem is only fixable by Kombo**

| `sync_state` | Explanation                                                             | How to fix                                                                                                                             |
| ------------ | ----------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `CANCELLED`  | The sync was actively canceled by Kombo                                 | This happens very rarely, has no negative side-effects, and if it does happen, we will schedule a new sync shortly after               |
| `FAILED`     | There was a critical error during the sync and the sync did not finish. | If this happens, we get an alert and will look into the issue to fix it ASAP                                                           |
| `TIMED_OUT`  | The sync timed out before completion                                    | This happens rarely and will cause an immediate and automatic restart of the sync. Kombo will be notified and look into the issue ASAP |

These values mean the sync failed and the **problem is only fixable by you**/your customers

| `sync_state`            | Explanation                                                                                                                | How to fix                                                                                                                      |
| ----------------------- | -------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `AUTHENTICATION_FAILED` | The sync couldn’t complete because the API credentials are invalid or don’t allow requesting all data points in your scope | This can only be fixed by your customer adding additional permissions to the credentials or updating the credentials altogether |

## Let your customer choose which jobs to expose to you

In a lot of cases, your customer won’t want you to supply candidates for all jobs in their ATS but only for some jobs. Unfortunately, that means you have to implement some additional logic after you have synced all jobs from the ATS.

<Info>
  🦉 How to solve this is really dependent on the way your product works. You and your team will have to decide what’s best for you - we can just share the solutions we have seen with other customers so far.
</Info>

**Your customer manually creates jobs in your back-office**

The customer can just create a new job record in your UI. In that case, there must be a corresponding job in the ATS of your customer so that you can create applications for it.

<Warning>
  Caution: With this approach, you’ll have to [match the jobs in your database
  with those in the ATS](#match-jobs-in-your-database-to-ats-jobs)
</Warning>

**Your customer sends you the job via email**

This is the low-tech approach of sharing the necessary jobs. Your customer will have to copy the job post URL, title, job code, or job ID from their system and share them with you. You can then get those jobs via the [query param filters of the get jobs endpoint.](#query-param-filters)

**You have an import UI for your customer**

Here, you have a dedicated settings page that lists all jobs from the customers ATS. Your customer can then go ahead and select the ones you should generate applications for.

**Receiving the jobs via a multi-poster**

Some of your customers (usually the larger ones) will use multiposters to distribute jobs to different job boards. This is an easy solution for your customer to choose specific jobs and “send” them to you. The only thing to be aware of is that you need to somehow [match the job you receive from the multiposter to the job in the ATS](#multiposters).

## Match jobs in your database to ATS jobs

In order to [create applications for a job](#creating-applications) you will always need to have the ID of your job in your database.

| id                         | title                       | customer\_id           | kombo\_job\_id             |
| -------------------------- | --------------------------- | ---------------------- | -------------------------- |
| `3WA6SZ7R7YSo2C3WDLE5zmAJ` | Senior integration engineer | `<end_user.origin_id>` | `21KvMGS9Yhsbbsxfwqyb5dkF` |
| `FhsTj1impXjFGzdG6QZuDnaW` | Customer success manager    | `<end_user.origin_id>` | `WA6SZ7R7YSo2C3WDLE5zmAJ`  |

This is not a problem if you just fetch all jobs via Kombo and then display them to customers or applicants. But in a lot of cases, you will have to match jobs that got into your database with existing records or records you get from a multiposter.

### Manually created jobs

If you have some jobs in your system before the customer connects their ATS, you’ll have to find the jobs in the ATS that correspond to the ones you have.

Ideally, you’ll use a unique identifier such as the ID/job code or perhaps even the URL.

In cases where you don’t have those data points, you can use the job title to find the most likely match in the ATS. If you have to use this approach, someone needs to check whether the job was linked correctly (either you or your customer).

We recommend showing your customer a dropdown list of jobs that you fetched from the ATS. The customer can then just search for the right one and click on it.

### Multiposters

If your customers are multiposting jobs to your platform you have to match the incoming jobs in a similar way. We strongly recommend requiring multiposters to share the job code or some other unique identifier about the job with you so that you can easily identify the job.

If you don’t have a unique identifier you could try to match the job based on it’s title but then you must have a human verifying the correctness of the link.

## **Reacting to deleted/closed jobs**

A common way to take jobs offline in an ATS is to close or archive them. In this case we will set the job status to `ARCHIVED` or `CLOSED`.

Some ATS's allow the complete deletion of jobs, in which case we will stop receiving that job on the ATS API. When that happens we set the `remote_deleted_at` timestamp for that record to let you know that this entry does not exist anymore. We will, however, not update the job status to be `CLOSED`. After 14 days we will completely remove the record from our system.

By default, we will exclude deleted jobs from our API response, so that you don’t ingest any deleted records into your system. To get notified about deleted entries you can set the query param `?include_deleted=true`. If you don’t do this, your applications will most likely fail because it’s not possible to apply for a deleted job.

```bash theme={null}
curl --request GET \
  --url 'https://api.kombo.dev/v1/ats/jobs?include_deleted=true' \
  --header 'Authorization: <authorization>' \
  --header 'X-Integration-Id: join:HWUTwvyx2wLoSUHphiWVrp28'
```

Once you find that a job has been deleted, archived or closed, you should stop creating new applications for it and ideally communicate in the UI of your back-office that this job is no longer active because it has been deactivated in the ATS.


# Screening overview
Source: https://docs.kombo.dev/ats/implementation-guide/screening-overview



As an AI Screening company, you are going to screen your customer’s candidates to in order to determine if they are suitable for the job.
When to screen the candidates is up to you as a company, we have seen inline screening of candidates but also pre-determined trigger stages for the candidates.
How you want to let your customer know that a candidate has been selected is a decision you make and Kombo will help you implement. If you want to reject customers, add notes, add tags etc..

<img alt="1377" />

### What is Screening?

The general flow we see a lot of our customers implement, goes as follows

1. Reading Applications from your customers ATS
2. Performing the screening on candidates within your platform, either top-of-funnel or at an identified trigger stage
3. Writing the results of the application back into the ATS
4. Moving Candidates to the next stage in the process or rejecting candidates within the process


# Screening questions
Source: https://docs.kombo.dev/ats/implementation-guide/screening-questions



## Overview

Screening questions help recruiters quickly assess whether an applicant meets the minimum criteria for a position, and serve as a critical filter for low quality applications. By integrating screening questions into your application flow, you can:

* **Improve the quality of candidate submissions** by ensuring only qualified applicants move forward.
* **Boost overall job board revenue** by enhancing employer satisfaction and encouraging repeat postings.

### Why are screening questions important?

Screening questions play a **crucial** role in the talent acquisition space in providing additional information to the recruiter about an applicant. They are utilized to increase quality of applications. Many jobs will require screening questions to filter applicants. To ensure that your application is received and reviewed, it may be necessary to implement screening questions.

### Screening Question Object

<Tabs>
  <Tab title="TEXT">
    ```json theme={null}
    {
      "id": "26vafvWSRmbhNcxJYqjCzuJg",
      "remote_id": "48b4d36a-1d4b-4c50-ada7-9519078e65b4",
      "title": "Which is your primary programming language?",
      "description": "Please enter the language you are most comfortable with.",
      "format": {
        "display_type": "SINGLE_LINE",
        "max_length": 100,
        "type": "TEXT"
      },
      "index": 0,
      "required": true
    }
    ```

    #### Format Attributes

    * **display\_type**: `SINGLE_LINE` | `MULTI_LINE` | `EMAIL` | `URL` | null
      * Specifies how the text input should be displayed
    * **max\_length**: Maximum characters allowed (null for unlimited)
  </Tab>

  <Tab title="NUMBER">
    ```json theme={null}
    {
      "id": "7bKxnPd4LCdq86GDp2JkR8js",
      "title": "How many years of experience do you have?",
      "description": "Please indicate your total years of relevant experience.",
      "format": {
        "display_type": "SLIDER",
        "min": 0,
        "max": 20,
        "type": "NUMBER"
      },
      "index": 1,
      "required": true
    }
    ```

    #### Format Attributes

    * **display\_type**: `SLIDER` | `FIELD` | null
      * Controls how the number input is presented
    * **min**: Minimum allowed value (null for no minimum)
    * **max**: Maximum allowed value (null for no maximum)
  </Tab>

  <Tab title="FILE">
    ```json theme={null}
    {
      "id": "9cLynQe5MDer97HEq3KlS9kt",
      "title": "Please upload your portfolio",
      "description": "PDF or ZIP files only, maximum size 10MB",
      "format": {
        "type": "FILE",
        "accepted_mime_types": ["application/pdf", "application/zip"],
        "max_file_size_bytes": 10485760
      },
      "index": 2,
      "required": false
    }
    ```

    #### Format Attributes

    * **accepted\_mime\_types**: Array of allowed MIME types
    * **max\_file\_size\_bytes**: Maximum file size in bytes
  </Tab>

  <Tab title="SINGLE_SELECT">
    ```json theme={null}
    {
      "id": "3mNzpRf6NEfs08IFq4LmT0lu",
      "title": "What is your preferred work location?",
      "description": "Please select your preferred office location",
      "format": {
        "type": "SINGLE_SELECT",
        "display_type": "DROPDOWN",
        "options": [
          {
            "id": "loc_nyc",
            "remote_id": "NYC123",
            "name": "New York"
          },
          {
            "id": "loc_sf",
            "remote_id": "SF456",
            "name": "San Francisco"
          }
        ]
      },
      "index": 3,
      "required": true
    }
    ```

    #### Format Attributes

    * **display\_type**: `DROPDOWN` | `RADIO` | null
      * Controls how the options are displayed
    * **options**: Array of selection options:
      * **id**: Unique Kombo ID for the option
      * **name**: Display text
      * **remote\_id**: ATS-specific ID (optional)
  </Tab>

  <Tab title="BOOLEAN">
    ```json theme={null}
    {
      "id": "4pQzqSg7OFgt19JGr5MnU1mv",
      "title": "Are you willing to relocate?",
      "description": "Please indicate your willingness to relocate for this position",
      "format": {
        "type": "BOOLEAN"
      },
      "index": 4,
      "required": true,
      "precondition_question_id": "3mNzpRf6NEfs08IFq4LmT0lu",
      "precondition_options": ["loc_nyc", "loc_sf"]
    }
    ```

    #### Format Attributes

    No additional attributes required for boolean questions. Represents a simple yes/no or true/false input.
  </Tab>

  <Tab title="DATE">
    ```json theme={null}
    {
      "id": "5rRArTh8PGhu20KHs6NoV2nw",
      "title": "What is your expected start date?",
      "description": "When would you be available to start?",
      "format": {
        "type": "DATE"
      },
      "index": 5,
      "required": true
    }
    ```

    #### Format Attributes

    No additional attributes required for date questions. Accepts standard date input.
  </Tab>

  <Tab title="MULTI_SELECT">
    ```json theme={null}
    {
      "id": "6sSBsUi9QHiv31LIt7OpW3ox",
      "title": "Which programming languages are you proficient in?",
      "description": "Select all that apply",
      "format": {
        "type": "MULTI_SELECT",
        "options": [
          {
            "id": "lang_js",
            "remote_id": "JS123",
            "name": "JavaScript"
          },
          {
            "id": "lang_py",
            "remote_id": "PY456",
            "name": "Python"
          }
        ]
      },
      "index": 6,
      "required": false
    }
    ```

    #### Format Attributes

    * **options**: Array of selection options:
      * **id**: Unique Kombo ID for the option
      * **name**: Display text
      * **remote\_id**: ATS-specific ID (optional)
  </Tab>

  <Tab title="INFORMATION">
    ```json theme={null}
    {
      "id": "7tTCtVj0RIjw42MJu8PqX4py",
      "title": "Important Information",
      "description": "This position requires occasional weekend work and on-call rotations.",
      "format": {
        "type": "INFORMATION"
      },
      "index": 7,
      "required": false
    }
    ```

    #### Format Attributes

    No additional attributes required. Used for displaying information only, no input expected.
  </Tab>
</Tabs>

#### Common Attributes

* **id `string`**:
  The globally unique ID of this object generated by Kombo.

* **remote\_id `string | null`**:
  The raw ID of the object in the remote system.

* **title `string | null`**:
  The question that you need to display.

* **description `string | null`**:
  Additional information provided alongside the title.

* **index `integer | null`**:
  Specifies the order in which the question should be displayed.

* **required `boolean | null`**:
  Indicates whether the question is mandatory.

* **precondition\_question\_id `string | null`**:
  The Kombo ID of another screening question that acts as a precondition.

* **precondition\_options `array`**:
  Array of valid responses that trigger the display of this question.

## How to Implement Screening Questions with Kombo

There are 4 main steps to implement screening questions:

1. [Fetching Screening Questions](#1-fetching-screening-questions)
2. [Displaying Screening Questions in Your UI](#2-displaying-screening-questions-in-your-ui)
3. [Capturing and Validating Answers](#3-capturing-and-validating-answers)
4. [Submitting Screening Question Answers](#4-submitting-screening-question-answers)

Additionally, we recommend [considering our advanced features + edge cases](#5-consider-advanced-features-edge-cases).

### 1. Fetching Screening Questions

Before you can display any screening questions in your UI or submit answers, you will need to ensure that a job with screening questions has been created and published in your customer's ATS.

You can then start fetching this info by having the "screening questions" scope enabled in your [scope config](https://app.kombo.dev/scope-config).

<Frame>
  <img alt="image.png" />
</Frame>

Screening questions are included as part of the job data, and can be fetched from the [GET jobs](/ats/v1/get-jobs) endpoint.

#### Sample API Request

```bash theme={null}
curl --request GET \
  --url https://api.kombo.dev/v1/ats/jobs \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'X-Integration-Id: <INTEGRATION_ID>'
```

#### Example Response Snippet

```json Example Response Snippet [expandable] theme={null}
{
  "status": "success",
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "id": "26vafvWSRmbhNcxJYqjCzuJg",
        "remote_id": "32",
        "name": "Backend Engineer",
        ...
        "screening_questions": [
          {
            "id": "26vafvWSRmbhNcxJYqjCzuJg",
            "remote_id": "48b4d36a-1d4b-4c50-ada7-9519078e65b4",
            "title": "Which is your primary programming language?",
            "description": "Please enter the language you are most comfortable with.",
            "format": {
              "display_type": "SINGLE_LINE",
              "max_length": null,
              "type": "TEXT"
            },
            "index": 0,
            "required": true
          }
        ]
      }
    ]
  }
}
```

> Note: Each job's `screening_questions` field can contain one or more questions. The order of these questions (defined by the `index` field) is recommended for display but not mandatory.

### 2. Displaying Screening Questions in Your UI

<Frame>
  <img alt="image.png" />
</Frame>

#### Guidelines

* **Render a Field per Question:**

  Display a corresponding input element within your job application form for each screening question in the `screening_questions` array. Depending on your product's goal, you might consider only displaying required screening questions to minimize the candidate's input.

* **Match Field Type to Question Format:**

  The type of input you display should correspond to the `format.type` and `format.display_type` provided. For example:

  | **Type**                           | **Recommended Format**                              |
  | ---------------------------------- | --------------------------------------------------- |
  | **`TEXT / SINGLE_LINE`**           | Text input                                          |
  | **`TEXT / MULTI_LINE`**            | Text area                                           |
  | **`NUMBER`**                       | Numeric input field or slider                       |
  | **`SINGLE_SELECT / MULTI_SELECT`** | Radio buttons, dropdown menus, or checkboxes        |
  | **`BOOLEAN`**                      | Toggle, checkbox, yes/no dropdown, or radio buttons |
  | **`DATE`**                         | Date picker or input field with format validation   |
  | **`FILE`**                         | File upload control                                 |
  | **`INFORMATION`**                  | Display a static text                               |
  | **`UNKNOWN`**                      | Handle custom logic as needed                       |

* **Indicate Required Fields:**

  Clearly mark questions that are mandatory. For instance, add an asterisk “\*” next to the question title when the `required` field is `true`.

* **Display the description:**

  Show the `description` below the question when present.
  It is often a short sentence but can be a long block.
  It may include HTML for formatting and Kombo returns it unchanged, so render HTML appropriately in your UI.

* **Follow the Recommended Order:**

  It's recommended (though not required) to display the screening questions in the order they are provided in the API response to preserve any intentional flow.

#### Sample HTML Snippet

Below is an example snippet for displaying a single-line text question and a multi-select question:

```html Example HTML Snippet [expandable] theme={null}
<form id="application-form">
  <!-- Text Question -->
  <div class="question">
    <label for="question-1">
      Which is your primary programming language?
      <span class="required">*</span>
    </label>
    <input
      type="text"
      id="question-1"
      name="screening_question_answers[26vafvWSRmbhNcxJYqjCzuJg]"
      placeholder="Type your answer here"
    />
  </div>

  <!-- Multi-select Question -->
  <div class="question">
    <label for="question-2">
      Which frameworks are you experienced with? <span class="required">*</span>
    </label>
    <div id="question-2">
      <label>
        <input
          type="checkbox"
          name="screening_question_answers[WA6SZ7R7YSo2C3WDLE5zmAJ][]"
          value="option1"
        />
        React
      </label>
      <label>
        <input
          type="checkbox"
          name="screening_question_answers[WA6SZ7R7YSo2C3WDLE5zmAJ][]"
          value="option2"
        />
        Angular
      </label>
      <label>
        <input
          type="checkbox"
          name="screening_question_answers[WA6SZ7R7YSo2C3WDLE5zmAJ][]"
          value="option3"
        />
        Vue
      </label>
    </div>
  </div>
</form>
```

> Tip: Adapt these examples to match your styling guidelines and frontend framework. Use real data from the API to populate questions dynamically.

### 3. Capturing and Validating Answers

#### Data Collection

* **Gather Answers:**

  Ensure that each candidate's response is collected in a way that corresponds to the question's expected format. For example, if a question is a multi-select, capture the answer as an array of option IDs. If the question is a text input, capture the answer as a string.

* **Implement Data Validation:**

  Validate user input on the client side:

  * Check that required fields are not left empty.
  * Ensure that input types match the expected format (e.g., numeric inputs for `NUMBER` questions).
  * Enforce constraints like `max_length` for text fields.

#### Example JavaScript Validation

```jsx theme={null}
document
  .getElementById('application-form')
  .addEventListener('submit', function (event) {
    const textInput = document.getElementById('question-1')
    if (!textInput.value.trim()) {
      alert('Please answer all required questions.')
      event.preventDefault()
      return
    }
    // Additional validations can be implemented here.
  })
```

### 4. Submitting Screening Question Answers

Once all candidate responses are captured and validated, include them in the payload when creating an application using Kombo's [create application](/ats/v1/post-jobs-job-id-applications) endpoint.

#### Sample Screening Questions Array

```json Sample Screening Questions Array [expandable] theme={null}
{
  ...
  "screening_question_answers": [
    {
      // For a text question
      "question_id": "26vafvWSRmbhNcxJYqjCzuJg",
      "answer": "TypeScript and a little bit of SQL"
    },
    {
      // For a single-select question
      "question_id" :"WA6SZ7R7YSo2C3WDLE5zmAJ",
      "answer": "3WA6SZ7R7YSo2C3WDLE5zmAJ", // ID of the answer-option
    },
    {
      // For a multi-select question
      "question_id" :"WA6SZ7R7YSo2C3WDLE5zmAJ",
      "answer": [
        "3WA6SZ7R7YSo2C3WDLE5zmAJ", // IDs of the answer-options
        "21KvMGS9Yhsbbsxfwqyb5dkF"
      ]
    }
  ]
}
```

#### Sample API Request

```bash Sample API Request [expandable] theme={null}
curl --request POST \
  --url https://api.kombo.dev/v1/ats/jobs/{job_id}/applications \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Content-Type: application/json' \
  --header 'X-Integration-Id: <INTEGRATION_ID>' \
  --data '{
  "candidate": {
    "first_name": "Frank",
    "last_name": "Doe",
    "company": "Acme Inc.",
    "title": "Head of Integrations",
    "email_address": "frank.doe@example.com",
    "phone_number": "+1-541-754-3010",
    "gender": "MALE",
    "salary_expectations": {
      "amount": 100000,
      "period": "YEAR"
    },
    "availability_date": "2021-01-01",
    "location": {
      "city": "New York",
      "country": "US"
    }
  },
  "stage_id": "8x3YKRDcuRnwShdh96ShBNn1",
  "attachments": [
    {
      "name": "Frank Doe CV.txt",
      "data": "SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=",
      "type": "CV",
      "content_type": "text/plain"
    }
  ],
  "screening_question_answers": [
    {
      "question_id": "3phFBNXRweGnDmsU9o2vdPuQ",
      "answer": "Yes"
    },
    {
      "question_id": "EYJjhMQT3LtVKXnTbnRT8s6U",
      "answer": [
        "GUzE666zfyjeoCJX6A8n7wh6",
        "5WPHzzKAv8cx97KtHRUV96U8",
        "7yZfKGzWigXxxRTygqAfHvyE"
      ]
    }
  ]
}'
```

> Error Handling:
>
> Implement robust error handling in your integration. For instance:
>
> * **400 Errors:** Likely indicate validation issues. Alert the candidate or log the error for review.
> * **500 Errors:** Signal server-side issues. In these cases, prompt users to try again later and contact Kombo support if the issue persists.

### 5. Consider Advanced Features + Edge Cases

While less common, there are some edge cases and additional features that you should consider.

#### Auto-answering required screening questions

<Note>
  Please reach out to Kombo support if you would like to use this feature – and
  it is not already enabled for you.
</Note>

If, by design, your product does not support screening questions, we provide you with the option to automatically answer these questions. This is necessary as some tools will validate and reject applications that do not have answers to the required questions.

When a candidate applies for a job, we will automatically answer any required screening questions that were not answered with default values. These default values are based on the question type and are as follows:

| **Type**            | **Answer**                                                                                           |
| ------------------- | ---------------------------------------------------------------------------------------------------- |
| **`TEXT`**          | **`-`**                                                                                              |
| **`NUMBER`**        | **`0`** (unless min and/or max are described, in which case we take the minimum number in the range) |
| **`BOOLEAN`**       | true                                                                                                 |
| **`SINGLE_SELECT`** | The first option                                                                                     |
| **`MULTI_SELECT`**  | The first option                                                                                     |
| **`DATE`**          | The current date                                                                                     |
| **`FILE`**          | An empty file                                                                                        |

#### Handling ATS-specific logic

Some ATS will include a score or disqualification value to a question. If these values can be read via API, we will ensure that the submitted answer does not disqualify the created candidate. Kombo will never try to manipulate or maximize a score.

#### Display type

The **`display_type`** for screening questions contain information about the display and validation. For example a screening question of type **`TEXT`** can have an these **`display_type`** properties: **`SINGLE_LINE`**, **`MULTI_LINE`**, **`EMAIL`** and **`URL`**. **`EMAIL`** and **`URL`** have additional validation rules.

#### Conditional screening questions

A conditional screening question is a question that should only appear based on the answer to another question. You will want to implement logic that only displays the conditional screening question to the applicant if this precondition is met. Answers to conditional screening questions may be required, although this requirement is only true if the precondition is met.

*An example of this could be:*

**Question 1:** Do you have a valid driver's license?

* **Yes**
* **No**

**Question 2:** How many years of driving experience do you have?

* **Less than 1 year**
* **1-2 years**

For this example, you would only want to show the second question if the applicant answered **Yes** to the first question.

<Note>
  Use Kombo's sandbox integration in your development environment to test
  conditional screening questions and build your user interface.
</Note>

Kombo would return these questions on the [GET jobs](/ats/v1/get-jobs) endpoint as shown below. On the second question, the value of `precondition_question_id` is the `id` of the first question, and `precondition_options` includes the **`id`** of the **Yes** option of the first question.

```bash Example Screening Questions With Preconditions [expandable] theme={null}
"screening_questions": [
  {
    "id": "26vafvWSRmbhNcxJYqjCzuJg",
    "remote_id": "48b4d36a-1d4b-4c50-ada7-9519078e65b4",
    "title": "Do you have a valid driver's license?",
    "description": "Please state if you have a valid driver's license.",
    "format": {
      "display_type": "DROPDOWN",
      "type": "SINGLE_SELECT",
      "options": [
        {
          "id": "5KMj443ZBfzBkqFhDuvdoZJP",
          "remote_id": "59c5d36a-1d4b-4c50-ada7-9519078e65b4",
          "name": "Yes"
        },
        {
          "id": "H5benHrFr66wh9wU3RQegRRN",
          "remote_id": "61d6d36a-1d4b-4c50-ada7-9519078e65b4",
          "name": "No"
        }
      ]
    },
    "index": 0,
    "required": true,
    "precondition_question_id": null,
    "precondition_options": null
  },
  {
    "id": "9SmkUABUZnQdoPGeK83CdGnH",
    "remote_id": "21b4d36a-1d4b-4c50-ada7-9519078e65b4",
    "title": "How many years of driving experience do you have?",
    "description": "Please state how many years of driving experience you have.",
    "format": {
      "display_type": "DROPDOWN",
      "type": "SINGLE_SELECT",
      "options": [
        {
          "id": "AFN58qWqutLt4ZMZgykD483W",
          "remote_id": "11c5d36a-1d4b-4c50-ada7-9519078e65b4",
          "name": "Less than 1 year"
        },
        {
          "id": "6MHzLUCEaNmccbf6bP18466J",
          "remote_id": "66d6d36a-1d4b-4c50-ada7-9519078e65b4",
          "name": "1-2 years"
        }
      ]
    },
    "index": 1,
    "required": true,
    "precondition_question_id": "26vafvWSRmbhNcxJYqjCzuJg",
    "precondition_options": ["5KMj443ZBfzBkqFhDuvdoZJP"]
  }
],
```


# Setup
Source: https://docs.kombo.dev/ats/implementation-guide/setup



Before we can get started with development, there’s a bit of setup to do. Please follow the steps below carefully so that you won’t have any issues down the line.

## Log into the dashboard

Log into the Kombo dashboard. You should have received an **invite via email** but if you didn’t, **reach out** to your team members or to Kombo directly via Slack/Teams

<img alt="1376" />

## Integration configuration

Go to the [tools overview](https://app.kombo.dev/tools) and select / deselect all integrations that you want to offer. You can change this at any time.

<img alt="1376" />

## Scope configuration

Go to the [scopes overview](https://app.kombo.dev/scope-config) and click on “**New config**” or “**Edit**” an existing one.

<img alt="1376" />

Select the data models that you need and click on “**Save changes**”.

<img alt="1376" />

<Note>
  🦉 These scopes are **just for development**. To understand more about this feature and how to use it to evoke a great first impression with customers, [read more here](/ats/features/scopes).
</Note>

## Set up a linked account for development

To call the API you always need to have a linked ATS account to pull and push data from. You can either [get yourself a sandbox via a free trial](/ats/getting-started/sandbox-integrations), or use our built-in mock integration to get started faster (recommended).

Go to the [integrations tab](https://app.kombo.dev/integrations) and click on “**Create a sandbox integration**”.

<img alt="1376" />

Click “**Continue**” and “**Set up integration**”.

<div>
  <img alt="First Image Description" />

  <img alt="Second Image Description" />

  <img alt="Third Image Description" />
</div>

**Click** on the tile that just appeared to get to the details page of the integration.

<img alt="1376" />

On this page, you can find all info related to the integration. For now, we will only need the integration ID though.

<img alt="Integration details 1.png" />

## Create Kombo API key

Go to the [Secrets tab](https://app.kombo.dev/secrets) and click on “**New API key**”.

<img alt="1376" />

Name the API key and click “**Create API key**”.

<img alt="Create API key.png" />

Copy the token and store it somewhere safe.

<img alt="Create API key.png" />

## Test your setup

🎉 You made it through the setup and have everything in place to get started developing 🎉

To verify you set up the sandbox integration and API key correctly, try the following HTTP request to the [“get integration details”-endpoint](/ats/v1/get-integrations-integration-id)

```bash theme={null}
curl --request GET \
  --url https://api.kombo.dev/v1/integrations/{integration_id} \
  --header 'Authorization: <api_key>'
```

You can also use any other endpoint like [“get jobs”](/ats/v1/get-jobs) or [“create application”](/ats/v1/post-jobs-job-id-applications). The Sandbox integration will return you some sample data for it.

<Tip>
  **Tip:** You can use our [official server-side SDKs](/libraries-and-sdks) to
  interact with the Kombo API in an ergonomic and type-safe manner. Check if
  your tech stack is already supported!
</Tip>

## Optional: set up Postman collection

To make development easier, we recommend setting up a Postman collection. It takes only one minute and can be done like this:

* **Copy** the link of our OpenAPI schema:

  ```bash theme={null}
  https://api.kombo.dev/openapi.json
  ```

* Open Postman, and click **Import**
  <img alt="1376" />

* **Paste** the URL and click **Import**

  <img alt="Postman URL.png" />

  <img alt="Postman Collection.png" />


# Connection setup
Source: https://docs.kombo.dev/ats/implementation-guide/talent-acquisition/connection-setup



The first part of the implementation is the setup of the connection. Your customer needs to generate and share their API credentials so that we can make the necessary API calls for the integration.

<img alt="1376" />

There are [multiple ways of implementing this step](/ats/getting-started/create-integrations#ways-of-creating-integrations), but during your development and for the first customers we highly recommend, just using the Magic Link feature that we provide. This guide will therefore assume that you are using the magic links for setting up the connection.

1. Generate a link for your customer. You only have to go into the [dashboard](https://app.kombo.dev/integrations) and:
   * Click on New integration

     <img alt="Click on new integration.png" />

   * Click on "Let your customer create the integration" (during development, you can also use the first option).

     <img alt="Click on let your customer create.png" />

   * Click on "Continue".

     <img alt="Click on continue.png" />

   * Copy the link.

     <img alt="Copy link.png" />

2. Wait for your customer to generate and enter their API credentials. You can see the status of any sent-out connection link in the [Kombo dashboard](https://app.kombo.dev/pending-connections).

   <Note>
     🦉 Setting up the credentials for an integration can be tricky for your non-technical users. That's why we highly recommend sharing our [step-by-step connection guides](https://help.kombo.dev/hc/en-us/sections/14349683218961-Connection-Guides) with them or guiding them through the process on a short call.
   </Note>

3. Receive the `integration-created` [webhook](/ats/guides/webhooks#integration-created). We send this webhook every time one of your customers creates a new integration.

   ```json theme={null}
   {
     "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
     "type": "integration-created",
     "data": {
       "id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
       "tool": "personio",
       "category": "HRIS",
       "end_user": {
         "origin_id": "36123",
         "creator_email": "user@example.com",
         "organization_name": "Acme, Inc."
       }
     }
   }
   ```

   The `end_user.origin_id` [is submitted by you](/ats/v1/post-connect-create-link#:~:text=HRIS%22%2C%0A%20%20%22integration_tool%22%3A%20%22personio%22%2C-,%22end_user_origin_id%22%3A%20%22123%22%2C,-%22language%22%3A%20%22en%22%0A%7D%27) when creating a connection link and should represent the ID of your customer in your database. You need to store this ID in your database so that you'll know which ATS belongs to which customer. For example, if you have two customers with the IDs "42" and "43", then your database could look as follows after the integrations have been created:

   | end\_user.origin\_id | kombo\_integration\_id                    |
   | -------------------- | ----------------------------------------- |
   | 42                   | `personio:8d1hpPsbjxUkoCoa1veLZGe5`       |
   | 43                   | `successfactors:B1hu5NGyhdjSq5X3hxEz4bAN` |

   <Note>
     ⚠️ **This ID is not for public display** and should only be accessible to your backend. The ID is not a secret as such but it's one of two things needed alongside the API key. There is no way to list all integration IDs via the API key so even in a case of accidental API key leak, the data would still be safe.
   </Note>

**Alerting for customer problems**

We will send you a `connection-flow-failed` [webhook](/ats/guides/webhooks#connection-flow-failed) every time a customer is running into an issue. You should set up some sort of alerting based on this webhook so that you can be fast to offer help to your customer, should they have an error when setting up an integration.

```json theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "connection-flow-failed",
  "data": {
    "integration_tool": "personio",
    "integration_category": "ATS",
    "end_user": {
      "origin_id": "123456",
      "creator_email": "user@example.com",
      "organization_name": "Acme, Inc."
    },
    "log_url": "https://app.kombo.dev/env/production/logs/C3xUo6XAsB2sbKC7M1gyXaRX"
  }
}
```

**Handling deleted integrations**

It is of course also possible to delete integrations. This can be done in two ways:

* via the ["delete integration"-endpoint](/ats/v1/delete-integrations-integration-id). If you are calling this endpoint you should also take care of deleting the `kombo_integration_id` from your database.
* via the `integration-deleted` [webhook](/ats/guides/webhooks#integration-deleted). This will be sent to you if someone goes into the Kombo dashboard and deletes an integration manually. Also then you'll have to remove the `kombo_integration_id` from your database.

  ```json theme={null}
  {
    "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
    "type": "integration-deleted",
    "data": {
      "id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
      "tool": "personio",
      "category": "ATS",
      "end_user": {
        "origin_id": "123456",
        "creator_email": "user@example.com",
        "organization_name": "Acme, Inc."
      },
      "deleted_at": "2022-11-02T10:50:10.242Z"
    }
  }
  ```


# Setup
Source: https://docs.kombo.dev/ats/implementation-guide/talent-acquisition/setup



Before we can get started with development, there's a bit of setup to do. Please follow the steps below carefully so that you won't have any issues down the line.

## Log into the dashboard

Log into the Kombo dashboard. You should have received an **invite via email** but if you didn't, **reach out** to your team members or to Kombo directly via Slack/Teams

<img alt="1376" />

## Integration configuration

Go to the [tools overview](https://app.kombo.dev/tools) and select / deselect all integrations that you want to offer. You can change this at any time.

<img alt="1376" />

## Scope configuration

Go to the [scopes overview](https://app.kombo.dev/scope-config) and click on "**New config**" or "**Edit**" an existing one.

<img alt="1376" />

Select the data models that you need and click on "**Save changes**".

<img alt="1376" />

<Note>
  🦉 These scopes are **just for development**. To understand more about this feature and how to use it to evoke a great first impression with customers, [read more here](/ats/features/scopes).
</Note>

## Set up a linked account for development

To call the API you always need to have a linked ATS account to pull and push data from. You can either [get yourself a sandbox via a free trial](/ats/getting-started/sandbox-integrations), or use our built-in mock integration to get started faster (recommended).

Go to the [integrations tab](https://app.kombo.dev/integrations) and click on "**Create a sandbox integration**".

<img alt="1376" />

Click "**Continue**" and "**Set up integration**".

<div>
  <img alt="First Image Description" />

  <img alt="Second Image Description" />

  <img alt="Third Image Description" />
</div>

**Click** on the tile that just appeared to get to the details page of the integration.

<img alt="1376" />

On this page, you can find all info related to the integration. For now, we will only need the integration ID though.

<img alt="Integration details 1.png" />

## Create Kombo API key

Go to the [Secrets tab](https://app.kombo.dev/secrets) and click on "**New API key**".

<img alt="1376" />

Name the API key and click "**Create API key**".

<img alt="Create API key.png" />

Copy the token and store it somewhere safe.

<img alt="Create API key.png" />

## Test your setup

🎉 You made it through the setup and have everything in place to get started developing 🎉

To verify you set up the sandbox integration and API key correctly, try the following HTTP request to the ["get integration details"-endpoint](/ats/v1/get-integrations-integration-id)

```bash theme={null}
curl --request GET \
  --url https://api.kombo.dev/v1/integrations/{integration_id} \
  --header 'Authorization: <api_key>'
```

You can also use any other endpoint like ["get jobs"](/ats/v1/get-jobs) or ["create application"](/ats/v1/post-jobs-job-id-applications). The Sandbox integration will return you some sample data for it.

<Tip>
  **Tip:** You can use our [official server-side SDKs](/libraries-and-sdks) to
  interact with the Kombo API in an ergonomic and type-safe manner. Check if
  your tech stack is already supported!
</Tip>

## Optional: set up Postman collection

To make development easier, we recommend setting up a Postman collection. It takes only one minute and can be done like this:

* **Copy** the link of our OpenAPI schema:

  ```bash theme={null}
  https://api.kombo.dev/openapi.json
  ```

* Open Postman, and click **Import**
  <img alt="1376" />

* **Paste** the URL and click **Import**

  <img alt="Postman URL.png" />

  <img alt="Postman Collection.png" />


# Tracking created applications
Source: https://docs.kombo.dev/ats/implementation-guide/tracking-created-applications



<img alt="1376" />

Everything explained about reading data in the “Reading jobs section” also applies to reading applications.

[Go back to “reading Jobs”](reading-jobs)

## Be aware of which applications are tracked

To minimize the amount of sensitive data synced, by default we will only sync and refresh data about applications that were created by you (that is, via's Kombo [Create application endpoint](/ats/v1/post-jobs-job-id-applications)).

<Note>
  🔭 That means, when connecting a new customer, you will initially receive an empty array for the candidates and applications (until you create an application or candidate through the Kombo API).
</Note>

You can find more info in the [Application tracking](/ats/features/application-status-tracking#syncing-only-created-candidates) feature page.

## Sync mode configuration

Next to syncing only created applications, you can also choose to sync all
applications or an additional model for syncing less candidate and application
data: [Upstream filtering](/ats/features/upstream-filtering).

In upstream filtering, we can filter down the data to only get recent data for a
specific timeframe or cutoff date.

## Hiring signals

To be able to see which of your submitted applications end up getting hired/rejected/etc. we provide you an `outcome` field on each application. The value of this field is calculated by us, based on the specifics of each ATS.

The possible values are `HIRED`, `DECLINED` or `PENDING`

You can also use the `outcomes` query param to filter for only applications of a certain type.

```bash theme={null}
curl --request GET \
  --url 'https://api.kombo.dev/v1/ats/applications?outcomes=HIRED%2CDECLINED' \
  --header 'Authorization: <authorization>' \
  --header 'X-Integration-Id: join:HWUTwvyx2wLoSUHphiWVrp28'
```

```json theme={null}
{
  "status": "success",
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "id": "26vafvWSRmbhNcxJYqjCzuJg",
        "remote_id": "32",
        "outcomes": "HIRED",
        ...
        ]
      }
    ]
  }
}
```

## Application stage changes

If you want to keep track of updates during the application process you can check whether the stage of the application has changed.

First, please note that in many ATS, each job can have a **custom hiring process** (i.e. can have a custom configuration of application stages). You can find the stages for each job on the `stages` property when calling the “Get jobs” endpoint.

```json theme={null}
{
  "status": "success",
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "id": "26vafvWSRmbhNcxJYqjCzuJg",
        "remote_id": "32",
        "name": "Backend Engineer",
        ...,
        "stages": [
          {
            "id": "3PJ8PZhZZa1eEdd2DtPNtVup",
            "remote_id": "32",
            "name": "Initial Screening",
            "index": 0
          },
          {
            "id": "HWUTwvyx2wLoSUHphiWVrp28",
            "remote_id": "38",
            "name": "Interview",
            "index": 0
          },
        ],
      }
    ]
  }
}
```

Then, when you fetch the applications via the “get applications” endpoint, you will get the `current_stage_id` and `current_stage` properties for each application. the `current_stage` is just an expanded version of the `current_stage_id` so you can use either of them.

```json theme={null}
{
  "status": "success",
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "id": "26vafvWSRmbhNcxJYqjCzuJg",
        "remote_id": "32",
        ...
        "current_stage_id": "5J7L4b48wBfffYwek9Az9pkM",
        ...
        "current_stage": {
          "id": "5J7L4b48wBfffYwek9Az9pkM",
          "remote_id": "32",
          "name": "Initial Screening"
        },
      }
    ]
  }
}
```

To see whether the stage of an application has changed, you have to implement some tracking logic on your end by calling the “get applications” endpoint with the `updated_after` filter and then comparing the stage of each candidate with the stage you currently have in your system.

## ATS-specific limitations

Some tools don’t support reading applications or hiring outcomes at all due to technical limitations. For best practices on how to handle this, [see this section](/ats/implementation-guide/creating-applications#handle-ats-specific-limitations).


# Writing application results
Source: https://docs.kombo.dev/ats/implementation-guide/writing-application-results



Once the screening has been completed on your platform, you can write the results of the screening back into the ATS.

There are multiple aways to write back results into the ATS. We recommend looking at the [coverage grid](https://app.kombo.dev/coverage/ats?model=action:ats_add_note_to_application,action:ats_add_result_link_to_application,action:ats_add_application_attachment,action:ats_add_candidate_tag) to see what is covered for the tools you will write back to.

Below are common methods for writing back into the ATS, these all need to be enabled on your [scope configuration](https://app.kombo.dev/scope-config) to utilize them with your customer.

* [Add notes to application](/ats/v1/post-applications-application-id-notes): Utilized for adding a note for the recruiter with result information.
* [Add tag to candidate](/ats/v1/post-candidates-candidate-id-tags): Add a tag at the candidate level to allow the recruiter to move this candidate forward.
* [Add attachment to applicant](/ats/v1/post-applications-application-id-attachments): Add a PDF to the applicant / candidate to share screening results.
* [Add result link to applicant](/ats/v1/post-applications-application-id-result-links): Add a url to the applicant to link back to your platform to show results.


# Important Changes
Source: https://docs.kombo.dev/ats/important-changes

Significant platform changes that may affect your integration.

<Update label="2026-07-21" description="Timesheet retention outside the sync window">
  ## Timesheets that age out of the sync window are no longer marked as deleted

  Kombo only keeps a rolling window of timesheets up to date during sync (default: the last **2 months**, configurable via the **"Historical timesheet months to sync"** setting). Previously, timesheets that fell outside that window were marked as deleted on the next full sync.

  **What changed:** Kombo now only deletion-tracks timesheets **inside** that window. Timesheets that age out of the window are **kept** and are not marked with `remote_deleted_at` just because they were not re-fetched. Within the window, timesheets that disappear from the remote HRIS are still marked as deleted as usual.

  ### Who is affected

  Anyone relying on timesheets outside the window receiving a `remote_deleted_at` value (or disappearing from default list responses) simply because they aged out of the re-fetch window.

  ### What you should do

  * Treat aging out of the window as **retention**, not deletion — do not expect those rows to be marked deleted.
  * If you need history beyond what you've kept up to date, configure a larger window upfront or archive timesheets on your side.
  * Contact Kombo support if you need the window changed for your environment (the setting is read-only in the dashboard).

  See the [Time & Attendance guide](/hris/features/time-and-attendance) and the [GET timesheets](/hris/v1/get-timesheets) endpoint for details.
</Update>

<Update label="2026-05-19" description="New HTTP status code for integration setup errors">
  ## Integration setup errors now return HTTP status code 409 instead of 503

  From **Tuesday, May 19, 2026**, the following [Kombo error codes](/guides/errors) will start returning **HTTP `409 Conflict`** instead of **HTTP `503 Service Unavailable`**:

  | Error code                                                                        | Meaning                                                      |
  | --------------------------------------------------------------------------------- | ------------------------------------------------------------ |
  | [`INTEGRATION.SETUP_INCOMPLETE`](/guides/errors#integration-setup_incomplete)     | The integration setup hasn't been finished yet.              |
  | [`INTEGRATION.SETUP_SYNC_PENDING`](/guides/errors#integration-setup_sync_pending) | The initial sync after connection is still running.          |
  | [`INTEGRATION.QA_FAILED`](/guides/errors#integration-qa_failed)                   | The integration's setup data didn't pass our quality checks. |

  We're making these changes in accordance with [our error handling best practices](/guides/errors#error-format) that we announced with the release of structured error codes in August 2025:

  Error handling logic on top of the Kombo API should, if available, **always make use of the `error.code` field** in the response, and **only** fall back to the HTTP status code if the `error.code` is not present (which should rarely happen).

  We're changing these specific codes because `409 Conflict` ([RFC 7231](https://www.rfc-editor.org/rfc/rfc7231#section-6.5.8)) matches the actual error state better. The `error.code` values themselves are **not changing**.

  ### What you should do

  Start by checking whether your implementation currently branches on the HTTP status code (`503` specifically, or `5xx` in general) when handling any of the three error codes above.

  * **If it doesn't, you're all set** and don't need to take any action.
  * **If it does**, please update that logic to rely on the `error.code` field instead of the HTTP status code, so it keeps behaving correctly once these errors start returning `409`.

  While you're at it, you may want to consider adding explicit handling for [`INTEGRATION.SETUP_INCOMPLETE`](/guides/errors#integration-setup_incomplete), [`INTEGRATION.SETUP_SYNC_PENDING`](/guides/errors#integration-setup_sync_pending), and [`INTEGRATION.QA_FAILED`](/guides/errors#integration-qa_failed) if you don't have it yet:

  * `INTEGRATION.SETUP_INCOMPLETE` and `INTEGRATION.QA_FAILED` should be surfaced to the affected end-customer or admin user because they usually require manual intervention.
  * `INTEGRATION.SETUP_SYNC_PENDING` resolves once the initial sync finishes, but initial syncs can take hours in some cases. We recommend relying on [webhooks](guides/webhooks) instead of retrying silently or polling aggressively.
</Update>

<Update label="2026-03-20" description="Concurrency limiting enforced">
  ## Action concurrency limiting is now enforced

  Kombo now enforces concurrency limits on action endpoints. Previously,
  concurrent requests were measured but not rejected. Now, when more than 30
  action requests are in flight simultaneously for a single integration,
  additional requests are rejected with HTTP `429` and the error code
  `PLATFORM.CONCURRENCY_LIMIT_EXCEEDED`.

  **Who is affected:** Customers sending many parallel action requests (e.g.,
  bulk-creating candidates or moving applications) may start receiving `429`
  responses they were not receiving before. Model read endpoints are not affected
  (e.g. `GET /ats/candidates`)

  **What to do:**

  * Handle the new `PLATFORM.CONCURRENCY_LIMIT_EXCEEDED` error code in your
    retry logic.
  * Use exponential backoff starting at \~1s.
  * Optionally, check the `Concurrency-Remaining` response header to throttle
    proactively.

  See the full [Concurrency Limiting](guides/concurrency-limiting) guide for
  details.
</Update>


# Introduction
Source: https://docs.kombo.dev/ats/introduction

Learn how to get started with Kombo's unified ATS API.

Kombo's unified ATS API allows reading data from and
writing data to [dozens of ATS systems](https://www.kombo.dev/categories/ats)
through a single standardized interface.

Here are some resources to get you started:

<CardGroup>
  <Card title="Explore the API reference" icon="magnifying-glass" href="/ats/v1/get-applications">
    Explore what data you can read and write through our unified endpoints.
  </Card>

  <Card title="Set up your first integration" icon="link" href="/ats/getting-started">
    Understand how you can connect your first integration in a few minutes.
  </Card>

  <Card title="Official SDKs" icon="code" href="/libraries-and-sdks">
    Use our official SDKs for ergonomic and type-safe API interactions.
  </Card>
</CardGroup>


# Remove tag from candidate
Source: https://docs.kombo.dev/ats/v1/delete-candidates-candidate-id-tags

DELETE /ats/candidates/{candidate_id}/tags
Remove a tag from a candidate based on its name.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/ats/connectors/workday">Workday</a></li>
    <li><img /><a href="/ats/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/ats/connectors/smartrecruiters">SmartRecruiters</a></li>
    <li><img /><a href="/ats/connectors/lever">Lever</a></li>
    <li><img /><a href="/ats/connectors/recruitee">Tellent Recruitee</a></li>
    <li><img /><a href="/ats/connectors/greenhouse">Greenhouse (V1)</a></li>
    <li><img /><a href="/ats/connectors/greenhousev3">Greenhouse (V3)</a></li>
    <li><img /><a href="/ats/connectors/teamtailor">Teamtailor</a></li>
    <li><img /><a href="/ats/connectors/onlyfy">Onlyfy</a></li>
    <li><img /><a href="/ats/connectors/workable">Workable</a></li>
    <li><img /><a href="/ats/connectors/welcometothejungle">Welcome to the Jungle</a></li>
    <li><img /><a href="/ats/connectors/erecruiter">eRecruiter</a></li>
    <li><img /><a href="/ats/connectors/zohorecruit">Zoho Recruit</a></li>
    <li><img /><a href="/ats/connectors/odoo">Odoo</a></li>
    <li><img /><a href="/ats/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/ats/connectors/trackerrms">TrackerRMS</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

This will also succeed if the tag does not exist on the candidate.

<Note>
  This endpoint requires the permission **Manage tags** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "tag": {
    "name": "Excellent Fit"
  }
}
```


# Delete integration
Source: https://docs.kombo.dev/ats/v1/delete-integrations-integration-id

DELETE /integrations/{integration_id}
Delete the specified integration.

**⚠️ This can not be undone!**


# Get application stages
Source: https://docs.kombo.dev/ats/v1/get-application-stages

GET /ats/application-stages
Get all application stages available in the ATS.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/ats/connectors/workday">Workday</a></li>
    <li><img /><a href="/ats/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/ats/connectors/smartrecruiters">SmartRecruiters</a></li>
    <li><img /><a href="/ats/connectors/factorial">Factorial</a></li>
    <li><img /><a href="/ats/connectors/oraclerecruiting">Oracle Recruiting Cloud</a></li>
    <li><img /><a href="/ats/connectors/lever">Lever</a></li>
    <li><img /><a href="/ats/connectors/icims">iCIMS</a></li>
    <li><img /><a href="/ats/connectors/cornerstonetalentlink">Cornerstone TalentLink</a></li>
    <li><img /><a href="/ats/connectors/recruitee">Tellent Recruitee</a></li>
    <li><img /><a href="/ats/connectors/recruiterflow">RecruiterFlow</a></li>
    <li><img /><a href="/ats/connectors/greenhouse">Greenhouse (V1)</a></li>
    <li><img /><a href="/ats/connectors/greenhousev3">Greenhouse (V3)</a></li>
    <li><img /><a href="/ats/connectors/teamtailor">Teamtailor</a></li>
    <li><img /><a href="/ats/connectors/ashby">Ashby</a></li>
    <li><img /><a href="/ats/connectors/talentsoft">CEGID TalentSoft FrontOffice</a></li>
    <li><img /><a href="/ats/connectors/talentsoftcustomer">CEGID TalentSoft Customer</a></li>
    <li><img /><a href="/ats/connectors/onlyfy">Onlyfy</a></li>
    <li><img /><a href="/ats/connectors/personio">Personio</a></li>
    <li><img /><a href="/ats/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/ats/connectors/ukgready">UKG Ready</a></li>
    <li><img /><a href="/ats/connectors/adpworkforcenow">ADP Workforce Now</a></li>
    <li><img /><a href="/ats/connectors/taleo">Oracle Taleo</a></li>
    <li><img /><a href="/ats/connectors/afas">AFAS Software</a></li>
    <li><img /><a href="/ats/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/ats/connectors/bullhorn4salesforce">Bullhorn for Salesforce</a></li>
    <li><img /><a href="/ats/connectors/bullhorn">Bullhorn</a></li>
    <li><img /><a href="/ats/connectors/bullhornlogin">Bullhorn Login</a></li>
    <li><img /><a href="/ats/connectors/workable">Workable</a></li>
    <li><img /><a href="/ats/connectors/jobvite">Jobvite</a></li>
    <li><img /><a href="/ats/connectors/fountain">Fountain</a></li>
    <li><img /><a href="/ats/connectors/softgarden">Softgarden</a></li>
    <li><img /><a href="/ats/connectors/pinpoint">Pinpoint</a></li>
    <li><img /><a href="/ats/connectors/welcometothejungle">Welcome to the Jungle</a></li>
    <li><img /><a href="/ats/connectors/dvinci">d.vinci</a></li>
    <li><img /><a href="/ats/connectors/dvinciadmin">d.vinci admin</a></li>
    <li><img /><a href="/ats/connectors/join">JOIN</a></li>
    <li><img /><a href="/ats/connectors/sagehr">Sage HR</a></li>
    <li><img /><a href="/ats/connectors/traffit">TRAFFIT</a></li>
    <li><img /><a href="/ats/connectors/erecruiter">eRecruiter</a></li>
    <li><img /><a href="/ats/connectors/abacusumantis">Abacus Umantis</a></li>
    <li><img /><a href="/ats/connectors/umantis">Haufe Umantis</a></li>
    <li><img /><a href="/ats/connectors/jobylon">Jobylon</a></li>
    <li><img /><a href="/ats/connectors/taleez">Taleez</a></li>
    <li><img /><a href="/ats/connectors/hrworks">HR WORKS</a></li>
    <li><img /><a href="/ats/connectors/otys">OTYS</a></li>
    <li><img /><a href="/ats/connectors/zohorecruit">Zoho Recruit</a></li>
    <li><img /><a href="/ats/connectors/ceipal">Ceipal</a></li>
    <li><img /><a href="/ats/connectors/eploy">Eploy</a></li>
    <li><img /><a href="/ats/connectors/careerplug">CareerPlug</a></li>
    <li><img /><a href="/ats/connectors/eightfold">Eightfold</a></li>
    <li><img /><a href="/ats/connectors/paradox">Paradox</a></li>
    <li><img /><a href="/ats/connectors/recruhr">RECRU</a></li>
    <li><img /><a href="/ats/connectors/recruitcrm">Recruit CRM</a></li>
    <li><img /><a href="/ats/connectors/jazzhr">JazzHR</a></li>
    <li><img /><a href="/ats/connectors/bite">BITE</a></li>
    <li><img /><a href="/ats/connectors/homerun">Homerun</a></li>
    <li><img /><a href="/ats/connectors/carerix">Carerix</a></li>
    <li><img /><a href="/ats/connectors/carerixgraphql">Carerix (GraphQL)</a></li>
    <li><img /><a href="/ats/connectors/inrecruiting">InRecruiting by Zucchetti</a></li>
    <li><img /><a href="/ats/connectors/jobadder">JobAdder</a></li>
    <li><img /><a href="/ats/connectors/hr4you">HR4YOU</a></li>
    <li><img /><a href="/ats/connectors/cornerstoneondemand">Cornerstone OnDemand</a></li>
    <li><img /><a href="/ats/connectors/zvooverecruit">Zvoove Recruit</a></li>
    <li><img /><a href="/ats/connectors/odoo">Odoo</a></li>
    <li><img /><a href="/ats/connectors/comeet">Spark Hire Recruit</a></li>
    <li><img /><a href="/ats/connectors/gem">Gem</a></li>
    <li><img /><a href="/ats/connectors/laura">Laura</a></li>
    <li><img /><a href="/ats/connectors/covetorest">Coveto (REST API)</a></li>
    <li><img /><a href="/ats/connectors/mercury">Mercury</a></li>
    <li><img /><a href="/ats/connectors/crelate">Crelate</a></li>
    <li><img /><a href="/ats/connectors/manatal">Manatal</a></li>
    <li><img /><a href="/ats/connectors/avionte">Avionté</a></li>
    <li><img /><a href="/ats/connectors/asymbl">Asymbl</a></li>
    <li><img /><a href="/ats/connectors/breezyhr">Breezy HR</a></li>
    <li><img /><a href="/ats/connectors/flatchr">Flatchr</a></li>
    <li><img /><a href="/ats/connectors/dayforce">Dayforce</a></li>
    <li><img /><a href="/ats/connectors/digitalrecruiters">Digital Recruiters</a></li>
    <li><img /><a href="/ats/connectors/applicantstack">ApplicantStack</a></li>
    <li><img /><a href="/ats/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/ats/connectors/spott">Spott</a></li>
    <li><img /><a href="/ats/connectors/logicmelon">Logic Melon</a></li>
    <li><img /><a href="/ats/connectors/loxo">Loxo</a></li>
    <li><img /><a href="/ats/connectors/kula">Kula</a></li>
    <li><img /><a href="/ats/connectors/trackerrms">TrackerRMS</a></li>
    <li><img /><a href="/ats/connectors/databites">Databites</a></li>
    <li><img /><a href="/ats/connectors/talent360">Talent360</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

<Warning>
  **This endpoint is deprecated!**

  Get all application stages available in the ATS. This is deprecated because most ATS systems have separate sets of stages for each job. We'd recommend using the `stages` property from the [GET Jobs endpoint](/ats/v1/get-jobs) instead.

  **Important**: Using global stages can cause "Stage not found" errors when moving applications, especially with systems like Workable that have job-specific stages.

  [Moving Applications Guide](/ats/implementation-guide/moving-and-rejecting-candidates).
</Warning>

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Get applications
Source: https://docs.kombo.dev/ats/v1/get-applications

GET /ats/applications
Retrieve all applications.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/ats/connectors/workday">Workday</a></li>
    <li><img /><a href="/ats/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/ats/connectors/smartrecruiters">SmartRecruiters</a></li>
    <li><img /><a href="/ats/connectors/factorial">Factorial</a></li>
    <li><img /><a href="/ats/connectors/oraclerecruiting">Oracle Recruiting Cloud</a></li>
    <li><img /><a href="/ats/connectors/lever">Lever</a></li>
    <li><img /><a href="/ats/connectors/icims">iCIMS</a></li>
    <li><img /><a href="/ats/connectors/cornerstonetalentlink">Cornerstone TalentLink</a></li>
    <li><img /><a href="/ats/connectors/recruitee">Tellent Recruitee</a></li>
    <li><img /><a href="/ats/connectors/recruiterflow">RecruiterFlow</a></li>
    <li><img /><a href="/ats/connectors/greenhouse">Greenhouse (V1)</a></li>
    <li><img /><a href="/ats/connectors/greenhousev3">Greenhouse (V3)</a></li>
    <li><img /><a href="/ats/connectors/teamtailor">Teamtailor</a></li>
    <li><img /><a href="/ats/connectors/ashby">Ashby</a></li>
    <li><img /><a href="/ats/connectors/talentsoft">CEGID TalentSoft FrontOffice</a></li>
    <li><img /><a href="/ats/connectors/talentsoftcustomer">CEGID TalentSoft Customer</a></li>
    <li><img /><a href="/ats/connectors/talention">Talention</a></li>
    <li><img /><a href="/ats/connectors/onlyfy">Onlyfy</a></li>
    <li><img /><a href="/ats/connectors/personio">Personio</a></li>
    <li><img /><a href="/ats/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/ats/connectors/ukgready">UKG Ready</a></li>
    <li><img /><a href="/ats/connectors/adpworkforcenow">ADP Workforce Now</a></li>
    <li><img /><a href="/ats/connectors/taleo">Oracle Taleo</a></li>
    <li><img /><a href="/ats/connectors/afas">AFAS Software</a></li>
    <li><img /><a href="/ats/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/ats/connectors/bullhorn4salesforce">Bullhorn for Salesforce</a></li>
    <li><img /><a href="/ats/connectors/bullhorn">Bullhorn</a></li>
    <li><img /><a href="/ats/connectors/bullhornlogin">Bullhorn Login</a></li>
    <li><img /><a href="/ats/connectors/workable">Workable</a></li>
    <li><img /><a href="/ats/connectors/jobvite">Jobvite</a></li>
    <li><img /><a href="/ats/connectors/fountain">Fountain</a></li>
    <li><img /><a href="/ats/connectors/softgarden">Softgarden</a></li>
    <li><img /><a href="/ats/connectors/pinpoint">Pinpoint</a></li>
    <li><img /><a href="/ats/connectors/welcometothejungle">Welcome to the Jungle</a></li>
    <li><img /><a href="/ats/connectors/dvinci">d.vinci</a></li>
    <li><img /><a href="/ats/connectors/dvinciadmin">d.vinci admin</a></li>
    <li><img /><a href="/ats/connectors/join">JOIN</a></li>
    <li><img /><a href="/ats/connectors/sagehr">Sage HR</a></li>
    <li><img /><a href="/ats/connectors/traffit">TRAFFIT</a></li>
    <li><img /><a href="/ats/connectors/erecruiter">eRecruiter</a></li>
    <li><img /><a href="/ats/connectors/abacusumantis">Abacus Umantis</a></li>
    <li><img /><a href="/ats/connectors/umantis">Haufe Umantis</a></li>
    <li><img /><a href="/ats/connectors/jobylon">Jobylon</a></li>
    <li><img /><a href="/ats/connectors/taleez">Taleez</a></li>
    <li><img /><a href="/ats/connectors/hrworks">HR WORKS</a></li>
    <li><img /><a href="/ats/connectors/otys">OTYS</a></li>
    <li><img /><a href="/ats/connectors/zohorecruit">Zoho Recruit</a></li>
    <li><img /><a href="/ats/connectors/ceipal">Ceipal</a></li>
    <li><img /><a href="/ats/connectors/eploy">Eploy</a></li>
    <li><img /><a href="/ats/connectors/jobdiva">JobDiva</a></li>
    <li><img /><a href="/ats/connectors/careerplug">CareerPlug</a></li>
    <li><img /><a href="/ats/connectors/eightfold">Eightfold</a></li>
    <li><img /><a href="/ats/connectors/paycor">Paycor</a></li>
    <li><img /><a href="/ats/connectors/avature">Avature</a></li>
    <li><img /><a href="/ats/connectors/apploi">Apploi</a></li>
    <li><img /><a href="/ats/connectors/phenom">Phenom</a></li>
    <li><img /><a href="/ats/connectors/paradox">Paradox</a></li>
    <li><img /><a href="/ats/connectors/recruhr">RECRU</a></li>
    <li><img /><a href="/ats/connectors/recruitcrm">Recruit CRM</a></li>
    <li><img /><a href="/ats/connectors/jazzhr">JazzHR</a></li>
    <li><img /><a href="/ats/connectors/bite">BITE</a></li>
    <li><img /><a href="/ats/connectors/homerun">Homerun</a></li>
    <li><img /><a href="/ats/connectors/carerix">Carerix</a></li>
    <li><img /><a href="/ats/connectors/carerixgraphql">Carerix (GraphQL)</a></li>
    <li><img /><a href="/ats/connectors/inrecruiting">InRecruiting by Zucchetti</a></li>
    <li><img /><a href="/ats/connectors/jobadder">JobAdder</a></li>
    <li><img /><a href="/ats/connectors/connexys">Connexys By Bullhorn</a></li>
    <li><img /><a href="/ats/connectors/hr4you">HR4YOU</a></li>
    <li><img /><a href="/ats/connectors/cornerstoneondemand">Cornerstone OnDemand</a></li>
    <li><img /><a href="/ats/connectors/zvooverecruit">Zvoove Recruit</a></li>
    <li><img /><a href="/ats/connectors/odoo">Odoo</a></li>
    <li><img /><a href="/ats/connectors/comeet">Spark Hire Recruit</a></li>
    <li><img /><a href="/ats/connectors/compleetpersy">Compleet (Persy API)</a></li>
    <li><img /><a href="/ats/connectors/compleet">Compleet (only PersoProfiler)</a></li>
    <li><img /><a href="/ats/connectors/gem">Gem</a></li>
    <li><img /><a href="/ats/connectors/laura">Laura</a></li>
    <li><img /><a href="/ats/connectors/covetorest">Coveto (REST API)</a></li>
    <li><img /><a href="/ats/connectors/coveto">Coveto (legacy SOAP API)</a></li>
    <li><img /><a href="/ats/connectors/mercury">Mercury</a></li>
    <li><img /><a href="/ats/connectors/crelate">Crelate</a></li>
    <li><img /><a href="/ats/connectors/manatal">Manatal</a></li>
    <li><img /><a href="/ats/connectors/avionte">Avionté</a></li>
    <li><img /><a href="/ats/connectors/asymbl">Asymbl</a></li>
    <li><img /><a href="/ats/connectors/breezyhr">Breezy HR</a></li>
    <li><img /><a href="/ats/connectors/flatchr">Flatchr</a></li>
    <li><img /><a href="/ats/connectors/dayforce">Dayforce</a></li>
    <li><img /><a href="/ats/connectors/digitalrecruiters">Digital Recruiters</a></li>
    <li><img /><a href="/ats/connectors/applicantstack">ApplicantStack</a></li>
    <li><img /><a href="/ats/connectors/reachmee">ReachMee</a></li>
    <li><img /><a href="/ats/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/ats/connectors/spott">Spott</a></li>
    <li><img /><a href="/ats/connectors/logicmelon">Logic Melon</a></li>
    <li><img /><a href="/ats/connectors/loxo">Loxo</a></li>
    <li><img /><a href="/ats/connectors/kula">Kula</a></li>
    <li><img /><a href="/ats/connectors/trackerrms">TrackerRMS</a></li>
    <li><img /><a href="/ats/connectors/databites">Databites</a></li>
    <li><img /><a href="/ats/connectors/talent360">Talent360</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Visit our in-depth guides to learn more about:

* 💡 [Being aware of which applications are tracked](/ats/features/implementation-guide/tracking-created-applications#be-aware-of-which-applications-are-tracked)
* 🚦 [Hiring signals](/ats/features/implementation-guide/tracking-created-applications#hiring-signals)
* 📈 [Application stage changes](/ats/features/implementation-guide/tracking-created-applications#application-stage-changes)
* ❓ [ATS-specific limitations](/ats/features/implementation-guide/tracking-created-applications#ats-specific-limitations)

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Get application attachments
Source: https://docs.kombo.dev/ats/v1/get-applications-application-id-attachments

GET /ats/applications/{application_id}/attachments
Get attachments from a candidate or application.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/ats/connectors/workday">Workday</a></li>
    <li><img /><a href="/ats/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/ats/connectors/smartrecruiters">SmartRecruiters</a></li>
    <li><img /><a href="/ats/connectors/oraclerecruiting">Oracle Recruiting Cloud</a></li>
    <li><img /><a href="/ats/connectors/lever">Lever</a></li>
    <li><img /><a href="/ats/connectors/cornerstonetalentlink">Cornerstone TalentLink</a></li>
    <li><img /><a href="/ats/connectors/recruitee">Tellent Recruitee</a></li>
    <li><img /><a href="/ats/connectors/greenhouse">Greenhouse (V1)</a></li>
    <li><img /><a href="/ats/connectors/greenhousev3">Greenhouse (V3)</a></li>
    <li><img /><a href="/ats/connectors/teamtailor">Teamtailor</a></li>
    <li><img /><a href="/ats/connectors/ashby">Ashby</a></li>
    <li><img /><a href="/ats/connectors/talentsoftcustomer">CEGID TalentSoft Customer</a></li>
    <li><img /><a href="/ats/connectors/onlyfy">Onlyfy</a></li>
    <li><img /><a href="/ats/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/ats/connectors/taleo">Oracle Taleo</a></li>
    <li><img /><a href="/ats/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/ats/connectors/bullhorn">Bullhorn</a></li>
    <li><img /><a href="/ats/connectors/workable">Workable</a></li>
    <li><img /><a href="/ats/connectors/jobvite">Jobvite</a></li>
    <li><img /><a href="/ats/connectors/fountain">Fountain</a></li>
    <li><img /><a href="/ats/connectors/pinpoint">Pinpoint</a></li>
    <li><img /><a href="/ats/connectors/welcometothejungle">Welcome to the Jungle</a></li>
    <li><img /><a href="/ats/connectors/dvinciadmin">d.vinci admin</a></li>
    <li><img /><a href="/ats/connectors/join">JOIN</a></li>
    <li><img /><a href="/ats/connectors/abacusumantis">Abacus Umantis</a></li>
    <li><img /><a href="/ats/connectors/umantis">Haufe Umantis</a></li>
    <li><img /><a href="/ats/connectors/jobylon">Jobylon</a></li>
    <li><img /><a href="/ats/connectors/otys">OTYS</a></li>
    <li><img /><a href="/ats/connectors/zohorecruit">Zoho Recruit</a></li>
    <li><img /><a href="/ats/connectors/ceipal">Ceipal</a></li>
    <li><img /><a href="/ats/connectors/eploy">Eploy</a></li>
    <li><img /><a href="/ats/connectors/jobdiva">JobDiva</a></li>
    <li><img /><a href="/ats/connectors/recruitcrm">Recruit CRM</a></li>
    <li><img /><a href="/ats/connectors/carerixgraphql">Carerix (GraphQL)</a></li>
    <li><img /><a href="/ats/connectors/jobadder">JobAdder</a></li>
    <li><img /><a href="/ats/connectors/zvooverecruit">Zvoove Recruit</a></li>
    <li><img /><a href="/ats/connectors/odoo">Odoo</a></li>
    <li><img /><a href="/ats/connectors/comeet">Spark Hire Recruit</a></li>
    <li><img /><a href="/ats/connectors/gem">Gem</a></li>
    <li><img /><a href="/ats/connectors/covetorest">Coveto (REST API)</a></li>
    <li><img /><a href="/ats/connectors/manatal">Manatal</a></li>
    <li><img /><a href="/ats/connectors/breezyhr">Breezy HR</a></li>
    <li><img /><a href="/ats/connectors/reachmee">ReachMee</a></li>
    <li><img /><a href="/ats/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/ats/connectors/logicmelon">Logic Melon</a></li>
    <li><img /><a href="/ats/connectors/kula">Kula</a></li>
    <li><img /><a href="/ats/connectors/trackerrms">TrackerRMS</a></li>
    <li><img /><a href="/ats/connectors/talent360">Talent360</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Get attachments from an application. If the ATS stores the attachments on the candidate, it will get the attachments from the corresponding candidate instead.

<Note>
  This endpoint requires the permission **Read document attachments** to be enabled in [your scope config](/scopes).
</Note>


# Get candidates
Source: https://docs.kombo.dev/ats/v1/get-candidates

GET /ats/candidates
Retrieve all candidates.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/ats/connectors/workday">Workday</a></li>
    <li><img /><a href="/ats/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/ats/connectors/smartrecruiters">SmartRecruiters</a></li>
    <li><img /><a href="/ats/connectors/factorial">Factorial</a></li>
    <li><img /><a href="/ats/connectors/oraclerecruiting">Oracle Recruiting Cloud</a></li>
    <li><img /><a href="/ats/connectors/lever">Lever</a></li>
    <li><img /><a href="/ats/connectors/icims">iCIMS</a></li>
    <li><img /><a href="/ats/connectors/cornerstonetalentlink">Cornerstone TalentLink</a></li>
    <li><img /><a href="/ats/connectors/recruitee">Tellent Recruitee</a></li>
    <li><img /><a href="/ats/connectors/recruiterflow">RecruiterFlow</a></li>
    <li><img /><a href="/ats/connectors/greenhouse">Greenhouse (V1)</a></li>
    <li><img /><a href="/ats/connectors/greenhousev3">Greenhouse (V3)</a></li>
    <li><img /><a href="/ats/connectors/teamtailor">Teamtailor</a></li>
    <li><img /><a href="/ats/connectors/ashby">Ashby</a></li>
    <li><img /><a href="/ats/connectors/talentsoft">CEGID TalentSoft FrontOffice</a></li>
    <li><img /><a href="/ats/connectors/talentsoftcustomer">CEGID TalentSoft Customer</a></li>
    <li><img /><a href="/ats/connectors/talention">Talention</a></li>
    <li><img /><a href="/ats/connectors/onlyfy">Onlyfy</a></li>
    <li><img /><a href="/ats/connectors/personio">Personio</a></li>
    <li><img /><a href="/ats/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/ats/connectors/ukgready">UKG Ready</a></li>
    <li><img /><a href="/ats/connectors/adpworkforcenow">ADP Workforce Now</a></li>
    <li><img /><a href="/ats/connectors/taleo">Oracle Taleo</a></li>
    <li><img /><a href="/ats/connectors/afas">AFAS Software</a></li>
    <li><img /><a href="/ats/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/ats/connectors/bullhorn4salesforce">Bullhorn for Salesforce</a></li>
    <li><img /><a href="/ats/connectors/bullhorn">Bullhorn</a></li>
    <li><img /><a href="/ats/connectors/bullhornlogin">Bullhorn Login</a></li>
    <li><img /><a href="/ats/connectors/workable">Workable</a></li>
    <li><img /><a href="/ats/connectors/jobvite">Jobvite</a></li>
    <li><img /><a href="/ats/connectors/fountain">Fountain</a></li>
    <li><img /><a href="/ats/connectors/pinpoint">Pinpoint</a></li>
    <li><img /><a href="/ats/connectors/welcometothejungle">Welcome to the Jungle</a></li>
    <li><img /><a href="/ats/connectors/dvinciadmin">d.vinci admin</a></li>
    <li><img /><a href="/ats/connectors/join">JOIN</a></li>
    <li><img /><a href="/ats/connectors/sagehr">Sage HR</a></li>
    <li><img /><a href="/ats/connectors/traffit">TRAFFIT</a></li>
    <li><img /><a href="/ats/connectors/erecruiter">eRecruiter</a></li>
    <li><img /><a href="/ats/connectors/abacusumantis">Abacus Umantis</a></li>
    <li><img /><a href="/ats/connectors/umantis">Haufe Umantis</a></li>
    <li><img /><a href="/ats/connectors/jobylon">Jobylon</a></li>
    <li><img /><a href="/ats/connectors/taleez">Taleez</a></li>
    <li><img /><a href="/ats/connectors/hrworks">HR WORKS</a></li>
    <li><img /><a href="/ats/connectors/otys">OTYS</a></li>
    <li><img /><a href="/ats/connectors/zohorecruit">Zoho Recruit</a></li>
    <li><img /><a href="/ats/connectors/ceipal">Ceipal</a></li>
    <li><img /><a href="/ats/connectors/eploy">Eploy</a></li>
    <li><img /><a href="/ats/connectors/jobdiva">JobDiva</a></li>
    <li><img /><a href="/ats/connectors/careerplug">CareerPlug</a></li>
    <li><img /><a href="/ats/connectors/eightfold">Eightfold</a></li>
    <li><img /><a href="/ats/connectors/paycor">Paycor</a></li>
    <li><img /><a href="/ats/connectors/avature">Avature</a></li>
    <li><img /><a href="/ats/connectors/apploi">Apploi</a></li>
    <li><img /><a href="/ats/connectors/phenom">Phenom</a></li>
    <li><img /><a href="/ats/connectors/paradox">Paradox</a></li>
    <li><img /><a href="/ats/connectors/recruhr">RECRU</a></li>
    <li><img /><a href="/ats/connectors/recruitcrm">Recruit CRM</a></li>
    <li><img /><a href="/ats/connectors/jazzhr">JazzHR</a></li>
    <li><img /><a href="/ats/connectors/bite">BITE</a></li>
    <li><img /><a href="/ats/connectors/homerun">Homerun</a></li>
    <li><img /><a href="/ats/connectors/carerix">Carerix</a></li>
    <li><img /><a href="/ats/connectors/carerixgraphql">Carerix (GraphQL)</a></li>
    <li><img /><a href="/ats/connectors/inrecruiting">InRecruiting by Zucchetti</a></li>
    <li><img /><a href="/ats/connectors/jobadder">JobAdder</a></li>
    <li><img /><a href="/ats/connectors/connexys">Connexys By Bullhorn</a></li>
    <li><img /><a href="/ats/connectors/hr4you">HR4YOU</a></li>
    <li><img /><a href="/ats/connectors/cornerstoneondemand">Cornerstone OnDemand</a></li>
    <li><img /><a href="/ats/connectors/zvooverecruit">Zvoove Recruit</a></li>
    <li><img /><a href="/ats/connectors/odoo">Odoo</a></li>
    <li><img /><a href="/ats/connectors/comeet">Spark Hire Recruit</a></li>
    <li><img /><a href="/ats/connectors/compleetpersy">Compleet (Persy API)</a></li>
    <li><img /><a href="/ats/connectors/compleet">Compleet (only PersoProfiler)</a></li>
    <li><img /><a href="/ats/connectors/gem">Gem</a></li>
    <li><img /><a href="/ats/connectors/laura">Laura</a></li>
    <li><img /><a href="/ats/connectors/covetorest">Coveto (REST API)</a></li>
    <li><img /><a href="/ats/connectors/coveto">Coveto (legacy SOAP API)</a></li>
    <li><img /><a href="/ats/connectors/mercury">Mercury</a></li>
    <li><img /><a href="/ats/connectors/crelate">Crelate</a></li>
    <li><img /><a href="/ats/connectors/manatal">Manatal</a></li>
    <li><img /><a href="/ats/connectors/avionte">Avionté</a></li>
    <li><img /><a href="/ats/connectors/asymbl">Asymbl</a></li>
    <li><img /><a href="/ats/connectors/breezyhr">Breezy HR</a></li>
    <li><img /><a href="/ats/connectors/flatchr">Flatchr</a></li>
    <li><img /><a href="/ats/connectors/dayforce">Dayforce</a></li>
    <li><img /><a href="/ats/connectors/digitalrecruiters">Digital Recruiters</a></li>
    <li><img /><a href="/ats/connectors/applicantstack">ApplicantStack</a></li>
    <li><img /><a href="/ats/connectors/reachmee">ReachMee</a></li>
    <li><img /><a href="/ats/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/ats/connectors/spott">Spott</a></li>
    <li><img /><a href="/ats/connectors/logicmelon">Logic Melon</a></li>
    <li><img /><a href="/ats/connectors/loxo">Loxo</a></li>
    <li><img /><a href="/ats/connectors/kula">Kula</a></li>
    <li><img /><a href="/ats/connectors/trackerrms">TrackerRMS</a></li>
    <li><img /><a href="/ats/connectors/databites">Databites</a></li>
    <li><img /><a href="/ats/connectors/talent360">Talent360</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Get candidate attachments
Source: https://docs.kombo.dev/ats/v1/get-candidates-candidate-id-attachments

GET /ats/candidates/{candidate_id}/attachments
Get attachments from a candidate, including all attachments of all of their applications.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/ats/connectors/workday">Workday</a></li>
    <li><img /><a href="/ats/connectors/smartrecruiters">SmartRecruiters</a></li>
    <li><img /><a href="/ats/connectors/oraclerecruiting">Oracle Recruiting Cloud</a></li>
    <li><img /><a href="/ats/connectors/lever">Lever</a></li>
    <li><img /><a href="/ats/connectors/icims">iCIMS</a></li>
    <li><img /><a href="/ats/connectors/cornerstonetalentlink">Cornerstone TalentLink</a></li>
    <li><img /><a href="/ats/connectors/greenhouse">Greenhouse (V1)</a></li>
    <li><img /><a href="/ats/connectors/greenhousev3">Greenhouse (V3)</a></li>
    <li><img /><a href="/ats/connectors/teamtailor">Teamtailor</a></li>
    <li><img /><a href="/ats/connectors/ashby">Ashby</a></li>
    <li><img /><a href="/ats/connectors/talentsoftcustomer">CEGID TalentSoft Customer</a></li>
    <li><img /><a href="/ats/connectors/onlyfy">Onlyfy</a></li>
    <li><img /><a href="/ats/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/ats/connectors/ukgready">UKG Ready</a></li>
    <li><img /><a href="/ats/connectors/taleo">Oracle Taleo</a></li>
    <li><img /><a href="/ats/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/ats/connectors/bullhorn4salesforce">Bullhorn for Salesforce</a></li>
    <li><img /><a href="/ats/connectors/bullhorn">Bullhorn</a></li>
    <li><img /><a href="/ats/connectors/workable">Workable</a></li>
    <li><img /><a href="/ats/connectors/jobvite">Jobvite</a></li>
    <li><img /><a href="/ats/connectors/pinpoint">Pinpoint</a></li>
    <li><img /><a href="/ats/connectors/welcometothejungle">Welcome to the Jungle</a></li>
    <li><img /><a href="/ats/connectors/join">JOIN</a></li>
    <li><img /><a href="/ats/connectors/zohorecruit">Zoho Recruit</a></li>
    <li><img /><a href="/ats/connectors/ceipal">Ceipal</a></li>
    <li><img /><a href="/ats/connectors/eploy">Eploy</a></li>
    <li><img /><a href="/ats/connectors/jobdiva">JobDiva</a></li>
    <li><img /><a href="/ats/connectors/eightfold">Eightfold</a></li>
    <li><img /><a href="/ats/connectors/carerixgraphql">Carerix (GraphQL)</a></li>
    <li><img /><a href="/ats/connectors/jobadder">JobAdder</a></li>
    <li><img /><a href="/ats/connectors/odoo">Odoo</a></li>
    <li><img /><a href="/ats/connectors/compleetpersy">Compleet (Persy API)</a></li>
    <li><img /><a href="/ats/connectors/gem">Gem</a></li>
    <li><img /><a href="/ats/connectors/covetorest">Coveto (REST API)</a></li>
    <li><img /><a href="/ats/connectors/mercury">Mercury</a></li>
    <li><img /><a href="/ats/connectors/crelate">Crelate</a></li>
    <li><img /><a href="/ats/connectors/manatal">Manatal</a></li>
    <li><img /><a href="/ats/connectors/avionte">Avionté</a></li>
    <li><img /><a href="/ats/connectors/asymbl">Asymbl</a></li>
    <li><img /><a href="/ats/connectors/flatchr">Flatchr</a></li>
    <li><img /><a href="/ats/connectors/applicantstack">ApplicantStack</a></li>
    <li><img /><a href="/ats/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/ats/connectors/loxo">Loxo</a></li>
    <li><img /><a href="/ats/connectors/kula">Kula</a></li>
    <li><img /><a href="/ats/connectors/trackerrms">TrackerRMS</a></li>
    <li><img /><a href="/ats/connectors/talent360">Talent360</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

<Note>
  This endpoint requires the permission **Read document attachments** to be enabled in [your scope config](/scopes).
</Note>


# Check API key
Source: https://docs.kombo.dev/ats/v1/get-check-api-key

GET /check-api-key
Check whether your API key is working properly.



# Get integration by token
Source: https://docs.kombo.dev/ats/v1/get-connect-integration-by-token-token

GET /connect/integration-by-token/{token}
Use this endpoint with the token you get from the connection flow to retrieve information about the created integration.

It works in a similar way as the OAuth2 code flow to securely retrieve information and connect the integration to your user.

> Check out [our full guide](/connect/embedded-flow) for more details about implementing the connection flow into your app.

This endpoint is used to ensure users can't trick your system connecting their
account in your system to another customers integration. You don't get the integration ID
from the `showKomboConnect(link)` function but only the short lived token used
for this endpoint so that users can't send you arbitrary data that you would put
into your system.


# Get integration details
Source: https://docs.kombo.dev/ats/v1/get-integrations-integration-id

GET /integrations/{integration_id}
Get the specified integration with everything you need to display it to your customer.



# Get custom fields with current mappings
Source: https://docs.kombo.dev/ats/v1/get-integrations-integration-id-custom-fields

GET /integrations/{integration_id}/custom-fields
Get all custom fields available on the specified integration.

\**This includes the mapping to the corresponding integration field if applicable*


# Get integration fields
Source: https://docs.kombo.dev/ats/v1/get-integrations-integration-id-integration-fields

GET /integrations/{integration_id}/integration-fields
Get all fields available on the specified integration.

**This includes the mapping to your custom fields**


# Get interviews
Source: https://docs.kombo.dev/ats/v1/get-interviews

GET /ats/interviews
Retrieve all interviews.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/ats/connectors/workday">Workday</a></li>
    <li><img /><a href="/ats/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/ats/connectors/smartrecruiters">SmartRecruiters</a></li>
    <li><img /><a href="/ats/connectors/lever">Lever</a></li>
    <li><img /><a href="/ats/connectors/recruitee">Tellent Recruitee</a></li>
    <li><img /><a href="/ats/connectors/greenhouse">Greenhouse (V1)</a></li>
    <li><img /><a href="/ats/connectors/greenhousev3">Greenhouse (V3)</a></li>
    <li><img /><a href="/ats/connectors/ashby">Ashby</a></li>
    <li><img /><a href="/ats/connectors/workable">Workable</a></li>
    <li><img /><a href="/ats/connectors/pinpoint">Pinpoint</a></li>
    <li><img /><a href="/ats/connectors/zohorecruit">Zoho Recruit</a></li>
    <li><img /><a href="/ats/connectors/jobadder">JobAdder</a></li>
    <li><img /><a href="/ats/connectors/gem">Gem</a></li>
    <li><img /><a href="/ats/connectors/crelate">Crelate</a></li>
    <li><img /><a href="/ats/connectors/breezyhr">Breezy HR</a></li>
    <li><img /><a href="/ats/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/ats/connectors/kula">Kula</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Get jobs
Source: https://docs.kombo.dev/ats/v1/get-jobs

GET /ats/jobs
Retrieve all jobs.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/ats/connectors/workday">Workday</a></li>
    <li><img /><a href="/ats/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/ats/connectors/smartrecruiters">SmartRecruiters</a></li>
    <li><img /><a href="/ats/connectors/factorial">Factorial</a></li>
    <li><img /><a href="/ats/connectors/oraclerecruiting">Oracle Recruiting Cloud</a></li>
    <li><img /><a href="/ats/connectors/lever">Lever</a></li>
    <li><img /><a href="/ats/connectors/icims">iCIMS</a></li>
    <li><img /><a href="/ats/connectors/cornerstonetalentlink">Cornerstone TalentLink</a></li>
    <li><img /><a href="/ats/connectors/recruitee">Tellent Recruitee</a></li>
    <li><img /><a href="/ats/connectors/recruiterflow">RecruiterFlow</a></li>
    <li><img /><a href="/ats/connectors/greenhouse">Greenhouse (V1)</a></li>
    <li><img /><a href="/ats/connectors/greenhousev3">Greenhouse (V3)</a></li>
    <li><img /><a href="/ats/connectors/greenhousejobboard">Greenhouse Job Board</a></li>
    <li><img /><a href="/ats/connectors/teamtailor">Teamtailor</a></li>
    <li><img /><a href="/ats/connectors/teamtailorjobboards">Teamtailor Job Boards</a></li>
    <li><img /><a href="/ats/connectors/ashby">Ashby</a></li>
    <li><img /><a href="/ats/connectors/talentsoft">CEGID TalentSoft FrontOffice</a></li>
    <li><img /><a href="/ats/connectors/talentsoftcustomer">CEGID TalentSoft Customer</a></li>
    <li><img /><a href="/ats/connectors/concludis">concludis</a></li>
    <li><img /><a href="/ats/connectors/perbilityhelix">Perbility Helix</a></li>
    <li><img /><a href="/ats/connectors/talention">Talention</a></li>
    <li><img /><a href="/ats/connectors/piloga">P\&I Loga</a></li>
    <li><img /><a href="/ats/connectors/onlyfy">Onlyfy</a></li>
    <li><img /><a href="/ats/connectors/personio">Personio</a></li>
    <li><img /><a href="/ats/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/ats/connectors/ukgready">UKG Ready</a></li>
    <li><img /><a href="/ats/connectors/adpworkforcenow">ADP Workforce Now</a></li>
    <li><img /><a href="/ats/connectors/taleo">Oracle Taleo</a></li>
    <li><img /><a href="/ats/connectors/rexx">rexx systems</a></li>
    <li><img /><a href="/ats/connectors/afas">AFAS Software</a></li>
    <li><img /><a href="/ats/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/ats/connectors/bullhorn4salesforce">Bullhorn for Salesforce</a></li>
    <li><img /><a href="/ats/connectors/bullhorn">Bullhorn</a></li>
    <li><img /><a href="/ats/connectors/bullhornlogin">Bullhorn Login</a></li>
    <li><img /><a href="/ats/connectors/workable">Workable</a></li>
    <li><img /><a href="/ats/connectors/jobvite">Jobvite</a></li>
    <li><img /><a href="/ats/connectors/fountain">Fountain</a></li>
    <li><img /><a href="/ats/connectors/softgarden">Softgarden</a></li>
    <li><img /><a href="/ats/connectors/softgardenpartner">Softgarden Partner</a></li>
    <li><img /><a href="/ats/connectors/pinpoint">Pinpoint</a></li>
    <li><img /><a href="/ats/connectors/welcometothejungle">Welcome to the Jungle</a></li>
    <li><img /><a href="/ats/connectors/dvinci">d.vinci</a></li>
    <li><img /><a href="/ats/connectors/dvinciadmin">d.vinci admin</a></li>
    <li><img /><a href="/ats/connectors/join">JOIN</a></li>
    <li><img /><a href="/ats/connectors/sagehr">Sage HR</a></li>
    <li><img /><a href="/ats/connectors/traffit">TRAFFIT</a></li>
    <li><img /><a href="/ats/connectors/erecruiter">eRecruiter</a></li>
    <li><img /><a href="/ats/connectors/abacusumantis">Abacus Umantis</a></li>
    <li><img /><a href="/ats/connectors/umantis">Haufe Umantis</a></li>
    <li><img /><a href="/ats/connectors/jobylon">Jobylon</a></li>
    <li><img /><a href="/ats/connectors/taleez">Taleez</a></li>
    <li><img /><a href="/ats/connectors/hrworks">HR WORKS</a></li>
    <li><img /><a href="/ats/connectors/otys">OTYS</a></li>
    <li><img /><a href="/ats/connectors/zohorecruit">Zoho Recruit</a></li>
    <li><img /><a href="/ats/connectors/ceipal">Ceipal</a></li>
    <li><img /><a href="/ats/connectors/eploy">Eploy</a></li>
    <li><img /><a href="/ats/connectors/jobdiva">JobDiva</a></li>
    <li><img /><a href="/ats/connectors/careerplug">CareerPlug</a></li>
    <li><img /><a href="/ats/connectors/perview">Perview</a></li>
    <li><img /><a href="/ats/connectors/eightfold">Eightfold</a></li>
    <li><img /><a href="/ats/connectors/paylocity">Paylocity</a></li>
    <li><img /><a href="/ats/connectors/paycor">Paycor</a></li>
    <li><img /><a href="/ats/connectors/avature">Avature</a></li>
    <li><img /><a href="/ats/connectors/apploi">Apploi</a></li>
    <li><img /><a href="/ats/connectors/phenom">Phenom</a></li>
    <li><img /><a href="/ats/connectors/paradox">Paradox</a></li>
    <li><img /><a href="/ats/connectors/heyrecruit">Heyrecruit</a></li>
    <li><img /><a href="/ats/connectors/recruhr">RECRU</a></li>
    <li><img /><a href="/ats/connectors/recruitcrm">Recruit CRM</a></li>
    <li><img /><a href="/ats/connectors/jazzhr">JazzHR</a></li>
    <li><img /><a href="/ats/connectors/bite">BITE</a></li>
    <li><img /><a href="/ats/connectors/brassring">Brass Ring</a></li>
    <li><img /><a href="/ats/connectors/homerun">Homerun</a></li>
    <li><img /><a href="/ats/connectors/mysolution">Mysolution</a></li>
    <li><img /><a href="/ats/connectors/carerix">Carerix</a></li>
    <li><img /><a href="/ats/connectors/carerixgraphql">Carerix (GraphQL)</a></li>
    <li><img /><a href="/ats/connectors/hroffice">HR Office</a></li>
    <li><img /><a href="/ats/connectors/talentclue">Talent Clue</a></li>
    <li><img /><a href="/ats/connectors/inrecruiting">InRecruiting by Zucchetti</a></li>
    <li><img /><a href="/ats/connectors/jobadder">JobAdder</a></li>
    <li><img /><a href="/ats/connectors/ubeeo">Ubeeo</a></li>
    <li><img /><a href="/ats/connectors/connexys">Connexys By Bullhorn</a></li>
    <li><img /><a href="/ats/connectors/hr4you">HR4YOU</a></li>
    <li><img /><a href="/ats/connectors/cornerstoneondemand">Cornerstone OnDemand</a></li>
    <li><img /><a href="/ats/connectors/zvooverecruit">Zvoove Recruit</a></li>
    <li><img /><a href="/ats/connectors/odoo">Odoo</a></li>
    <li><img /><a href="/ats/connectors/comeet">Spark Hire Recruit</a></li>
    <li><img /><a href="/ats/connectors/compleetpitcher">Compleet (Pitcher API)</a></li>
    <li><img /><a href="/ats/connectors/compleetpersy">Compleet (Persy API)</a></li>
    <li><img /><a href="/ats/connectors/compleet">Compleet (only PersoProfiler)</a></li>
    <li><img /><a href="/ats/connectors/gem">Gem</a></li>
    <li><img /><a href="/ats/connectors/laura">Laura</a></li>
    <li><img /><a href="/ats/connectors/covetorest">Coveto (REST API)</a></li>
    <li><img /><a href="/ats/connectors/coveto">Coveto (legacy SOAP API)</a></li>
    <li><img /><a href="/ats/connectors/mercury">Mercury</a></li>
    <li><img /><a href="/ats/connectors/crelate">Crelate</a></li>
    <li><img /><a href="/ats/connectors/manatal">Manatal</a></li>
    <li><img /><a href="/ats/connectors/avionte">Avionté</a></li>
    <li><img /><a href="/ats/connectors/mhmhr">MHM HR</a></li>
    <li><img /><a href="/ats/connectors/asymbl">Asymbl</a></li>
    <li><img /><a href="/ats/connectors/breezyhr">Breezy HR</a></li>
    <li><img /><a href="/ats/connectors/flatchr">Flatchr</a></li>
    <li><img /><a href="/ats/connectors/dayforce">Dayforce</a></li>
    <li><img /><a href="/ats/connectors/digitalrecruiters">Digital Recruiters</a></li>
    <li><img /><a href="/ats/connectors/applicantstack">ApplicantStack</a></li>
    <li><img /><a href="/ats/connectors/reachmee">ReachMee</a></li>
    <li><img /><a href="/ats/connectors/talentadore">TalentAdore</a></li>
    <li><img /><a href="/ats/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/ats/connectors/guidecom">GuideCom</a></li>
    <li><img /><a href="/ats/connectors/spott">Spott</a></li>
    <li><img /><a href="/ats/connectors/logicmelon">Logic Melon</a></li>
    <li><img /><a href="/ats/connectors/loxo">Loxo</a></li>
    <li><img /><a href="/ats/connectors/kula">Kula</a></li>
    <li><img /><a href="/ats/connectors/trackerrms">TrackerRMS</a></li>
    <li><img /><a href="/ats/connectors/databites">Databites</a></li>
    <li><img /><a href="/ats/connectors/talent360">Talent360</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Visit our in-depth guides to learn more about:

* 🔄 [Getting updates of the data](/ats/features/implementation-guide/reading-jobs#getting-updates-of-the-data)
* ❗ [Handling failing syncs](/ats/features/implementation-guide/reading-jobs#handling-failing-syncs)
* 🔍 [Letting your customer choose which jobs to expose](/ats/features/implementation-guide/reading-jobs#let-your-customer-choose-which-jobs-to-expose-to-you)
* 🔗 [Matching jobs in your database to ATS jobs](/ats/features/implementation-guide/reading-jobs#match-jobs-in-your-database-to-ats-jobs)
* 🗑️ [Reacting to deleted/closed jobs](/ats/features/implementation-guide/reading-jobs#reacting-to-deleted-closed-jobs)

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Get notes
Source: https://docs.kombo.dev/ats/v1/get-notes

GET /ats/notes
Retrieve all notes.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/ats/connectors/lever">Lever</a></li>
    <li><img /><a href="/ats/connectors/greenhousev3">Greenhouse (V3)</a></li>
    <li><img /><a href="/ats/connectors/ashby">Ashby</a></li>
    <li><img /><a href="/ats/connectors/sandbox">Kombo Sandbox</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Get offers
Source: https://docs.kombo.dev/ats/v1/get-offers

GET /ats/offers
Retrieve all offers.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/ats/connectors/workday">Workday</a></li>
    <li><img /><a href="/ats/connectors/smartrecruiters">SmartRecruiters</a></li>
    <li><img /><a href="/ats/connectors/oraclerecruiting">Oracle Recruiting Cloud</a></li>
    <li><img /><a href="/ats/connectors/lever">Lever</a></li>
    <li><img /><a href="/ats/connectors/recruitee">Tellent Recruitee</a></li>
    <li><img /><a href="/ats/connectors/greenhouse">Greenhouse (V1)</a></li>
    <li><img /><a href="/ats/connectors/greenhousev3">Greenhouse (V3)</a></li>
    <li><img /><a href="/ats/connectors/teamtailor">Teamtailor</a></li>
    <li><img /><a href="/ats/connectors/ashby">Ashby</a></li>
    <li><img /><a href="/ats/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/ats/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/ats/connectors/kula">Kula</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Get Job Postings
Source: https://docs.kombo.dev/ats/v1/get-postings

Retrieve all job postings.

<Note>
  Listing all job postings as a top-level endpoint is not available yet. You can
  retrieve all postings for each job using the [GET Jobs
  endpoint](/ats/v1/get-jobs).
</Note>

*Please reach out to Kombo if you think it makes more sense to have a top-level job postings endpoint.*


# Get rejection reasons
Source: https://docs.kombo.dev/ats/v1/get-rejection-reasons

GET /ats/rejection-reasons
Retrieve all rejection reasons.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/ats/connectors/workday">Workday</a></li>
    <li><img /><a href="/ats/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/ats/connectors/smartrecruiters">SmartRecruiters</a></li>
    <li><img /><a href="/ats/connectors/factorial">Factorial</a></li>
    <li><img /><a href="/ats/connectors/oraclerecruiting">Oracle Recruiting Cloud</a></li>
    <li><img /><a href="/ats/connectors/lever">Lever</a></li>
    <li><img /><a href="/ats/connectors/recruitee">Tellent Recruitee</a></li>
    <li><img /><a href="/ats/connectors/recruiterflow">RecruiterFlow</a></li>
    <li><img /><a href="/ats/connectors/greenhouse">Greenhouse (V1)</a></li>
    <li><img /><a href="/ats/connectors/greenhousev3">Greenhouse (V3)</a></li>
    <li><img /><a href="/ats/connectors/teamtailor">Teamtailor</a></li>
    <li><img /><a href="/ats/connectors/ashby">Ashby</a></li>
    <li><img /><a href="/ats/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/ats/connectors/ukgready">UKG Ready</a></li>
    <li><img /><a href="/ats/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/ats/connectors/bullhorn">Bullhorn</a></li>
    <li><img /><a href="/ats/connectors/workable">Workable</a></li>
    <li><img /><a href="/ats/connectors/jobvite">Jobvite</a></li>
    <li><img /><a href="/ats/connectors/abacusumantis">Abacus Umantis</a></li>
    <li><img /><a href="/ats/connectors/umantis">Haufe Umantis</a></li>
    <li><img /><a href="/ats/connectors/zohorecruit">Zoho Recruit</a></li>
    <li><img /><a href="/ats/connectors/eploy">Eploy</a></li>
    <li><img /><a href="/ats/connectors/carerixgraphql">Carerix (GraphQL)</a></li>
    <li><img /><a href="/ats/connectors/odoo">Odoo</a></li>
    <li><img /><a href="/ats/connectors/mercury">Mercury</a></li>
    <li><img /><a href="/ats/connectors/manatal">Manatal</a></li>
    <li><img /><a href="/ats/connectors/avionte">Avionté</a></li>
    <li><img /><a href="/ats/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/ats/connectors/trackerrms">TrackerRMS</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Get all rejection reasons available in the system. The Kombo ID is required in the associated [reject application action](/ats/v1/post-applications-application-id-reject).

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Get roles
Source: https://docs.kombo.dev/ats/v1/get-roles

GET /ats/roles
Retrieve all roles.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/ats/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/ats/connectors/smartrecruiters">SmartRecruiters</a></li>
    <li><img /><a href="/ats/connectors/oraclerecruiting">Oracle Recruiting Cloud</a></li>
    <li><img /><a href="/ats/connectors/lever">Lever</a></li>
    <li><img /><a href="/ats/connectors/icims">iCIMS</a></li>
    <li><img /><a href="/ats/connectors/cornerstonetalentlink">Cornerstone TalentLink</a></li>
    <li><img /><a href="/ats/connectors/recruiterflow">RecruiterFlow</a></li>
    <li><img /><a href="/ats/connectors/greenhouse">Greenhouse (V1)</a></li>
    <li><img /><a href="/ats/connectors/greenhousev3">Greenhouse (V3)</a></li>
    <li><img /><a href="/ats/connectors/teamtailor">Teamtailor</a></li>
    <li><img /><a href="/ats/connectors/ashby">Ashby</a></li>
    <li><img /><a href="/ats/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/ats/connectors/ukgready">UKG Ready</a></li>
    <li><img /><a href="/ats/connectors/adpworkforcenow">ADP Workforce Now</a></li>
    <li><img /><a href="/ats/connectors/taleo">Oracle Taleo</a></li>
    <li><img /><a href="/ats/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/ats/connectors/bullhorn">Bullhorn</a></li>
    <li><img /><a href="/ats/connectors/workable">Workable</a></li>
    <li><img /><a href="/ats/connectors/jobvite">Jobvite</a></li>
    <li><img /><a href="/ats/connectors/fountain">Fountain</a></li>
    <li><img /><a href="/ats/connectors/pinpoint">Pinpoint</a></li>
    <li><img /><a href="/ats/connectors/zohorecruit">Zoho Recruit</a></li>
    <li><img /><a href="/ats/connectors/jobdiva">JobDiva</a></li>
    <li><img /><a href="/ats/connectors/careerplug">CareerPlug</a></li>
    <li><img /><a href="/ats/connectors/paycor">Paycor</a></li>
    <li><img /><a href="/ats/connectors/phenom">Phenom</a></li>
    <li><img /><a href="/ats/connectors/recruitcrm">Recruit CRM</a></li>
    <li><img /><a href="/ats/connectors/jazzhr">JazzHR</a></li>
    <li><img /><a href="/ats/connectors/carerixgraphql">Carerix (GraphQL)</a></li>
    <li><img /><a href="/ats/connectors/cornerstoneondemand">Cornerstone OnDemand</a></li>
    <li><img /><a href="/ats/connectors/mercury">Mercury</a></li>
    <li><img /><a href="/ats/connectors/crelate">Crelate</a></li>
    <li><img /><a href="/ats/connectors/breezyhr">Breezy HR</a></li>
    <li><img /><a href="/ats/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/ats/connectors/kula">Kula</a></li>
    <li><img /><a href="/ats/connectors/trackerrms">TrackerRMS</a></li>
    <li><img /><a href="/ats/connectors/talent360">Talent360</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Visit our in-depth guide about [roles](/ats/features/roles) to learn more.

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Get tags
Source: https://docs.kombo.dev/ats/v1/get-tags

GET /ats/tags
Retrieve all tags.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/ats/connectors/workday">Workday</a></li>
    <li><img /><a href="/ats/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/ats/connectors/smartrecruiters">SmartRecruiters</a></li>
    <li><img /><a href="/ats/connectors/lever">Lever</a></li>
    <li><img /><a href="/ats/connectors/recruitee">Tellent Recruitee</a></li>
    <li><img /><a href="/ats/connectors/recruiterflow">RecruiterFlow</a></li>
    <li><img /><a href="/ats/connectors/greenhouse">Greenhouse (V1)</a></li>
    <li><img /><a href="/ats/connectors/greenhousev3">Greenhouse (V3)</a></li>
    <li><img /><a href="/ats/connectors/teamtailor">Teamtailor</a></li>
    <li><img /><a href="/ats/connectors/ashby">Ashby</a></li>
    <li><img /><a href="/ats/connectors/onlyfy">Onlyfy</a></li>
    <li><img /><a href="/ats/connectors/workable">Workable</a></li>
    <li><img /><a href="/ats/connectors/pinpoint">Pinpoint</a></li>
    <li><img /><a href="/ats/connectors/welcometothejungle">Welcome to the Jungle</a></li>
    <li><img /><a href="/ats/connectors/join">JOIN</a></li>
    <li><img /><a href="/ats/connectors/traffit">TRAFFIT</a></li>
    <li><img /><a href="/ats/connectors/zohorecruit">Zoho Recruit</a></li>
    <li><img /><a href="/ats/connectors/eightfold">Eightfold</a></li>
    <li><img /><a href="/ats/connectors/recruhr">RECRU</a></li>
    <li><img /><a href="/ats/connectors/odoo">Odoo</a></li>
    <li><img /><a href="/ats/connectors/avionte">Avionté</a></li>
    <li><img /><a href="/ats/connectors/breezyhr">Breezy HR</a></li>
    <li><img /><a href="/ats/connectors/flatchr">Flatchr</a></li>
    <li><img /><a href="/ats/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/ats/connectors/loxo">Loxo</a></li>
    <li><img /><a href="/ats/connectors/kula">Kula</a></li>
    <li><img /><a href="/ats/connectors/trackerrms">TrackerRMS</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Get tools
Source: https://docs.kombo.dev/ats/v1/get-tools-category

GET /tools/{category}
Get a list of the tools (i.e., integrations) enabled in your environment.

This can (in combination with the `integration_tool` parameter of [the "Create Link" endpoint](/v1/post-create-link)) be used to, for example, display a custom list or grid of available integrations to your end users instead of exposing Kombo Connect's standard tool selector.


# Get users
Source: https://docs.kombo.dev/ats/v1/get-users

GET /ats/users
Retrieve all users.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/ats/connectors/workday">Workday</a></li>
    <li><img /><a href="/ats/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/ats/connectors/smartrecruiters">SmartRecruiters</a></li>
    <li><img /><a href="/ats/connectors/oraclerecruiting">Oracle Recruiting Cloud</a></li>
    <li><img /><a href="/ats/connectors/lever">Lever</a></li>
    <li><img /><a href="/ats/connectors/icims">iCIMS</a></li>
    <li><img /><a href="/ats/connectors/cornerstonetalentlink">Cornerstone TalentLink</a></li>
    <li><img /><a href="/ats/connectors/recruitee">Tellent Recruitee</a></li>
    <li><img /><a href="/ats/connectors/recruiterflow">RecruiterFlow</a></li>
    <li><img /><a href="/ats/connectors/greenhouse">Greenhouse (V1)</a></li>
    <li><img /><a href="/ats/connectors/greenhousev3">Greenhouse (V3)</a></li>
    <li><img /><a href="/ats/connectors/teamtailor">Teamtailor</a></li>
    <li><img /><a href="/ats/connectors/ashby">Ashby</a></li>
    <li><img /><a href="/ats/connectors/talentsoft">CEGID TalentSoft FrontOffice</a></li>
    <li><img /><a href="/ats/connectors/talention">Talention</a></li>
    <li><img /><a href="/ats/connectors/onlyfy">Onlyfy</a></li>
    <li><img /><a href="/ats/connectors/personio">Personio</a></li>
    <li><img /><a href="/ats/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/ats/connectors/ukgready">UKG Ready</a></li>
    <li><img /><a href="/ats/connectors/adpworkforcenow">ADP Workforce Now</a></li>
    <li><img /><a href="/ats/connectors/taleo">Oracle Taleo</a></li>
    <li><img /><a href="/ats/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/ats/connectors/bullhorn">Bullhorn</a></li>
    <li><img /><a href="/ats/connectors/bullhornlogin">Bullhorn Login</a></li>
    <li><img /><a href="/ats/connectors/workable">Workable</a></li>
    <li><img /><a href="/ats/connectors/jobvite">Jobvite</a></li>
    <li><img /><a href="/ats/connectors/fountain">Fountain</a></li>
    <li><img /><a href="/ats/connectors/softgarden">Softgarden</a></li>
    <li><img /><a href="/ats/connectors/pinpoint">Pinpoint</a></li>
    <li><img /><a href="/ats/connectors/dvinci">d.vinci</a></li>
    <li><img /><a href="/ats/connectors/dvinciadmin">d.vinci admin</a></li>
    <li><img /><a href="/ats/connectors/join">JOIN</a></li>
    <li><img /><a href="/ats/connectors/traffit">TRAFFIT</a></li>
    <li><img /><a href="/ats/connectors/abacusumantis">Abacus Umantis</a></li>
    <li><img /><a href="/ats/connectors/umantis">Haufe Umantis</a></li>
    <li><img /><a href="/ats/connectors/jobylon">Jobylon</a></li>
    <li><img /><a href="/ats/connectors/hrworks">HR WORKS</a></li>
    <li><img /><a href="/ats/connectors/otys">OTYS</a></li>
    <li><img /><a href="/ats/connectors/zohorecruit">Zoho Recruit</a></li>
    <li><img /><a href="/ats/connectors/ceipal">Ceipal</a></li>
    <li><img /><a href="/ats/connectors/eploy">Eploy</a></li>
    <li><img /><a href="/ats/connectors/jobdiva">JobDiva</a></li>
    <li><img /><a href="/ats/connectors/careerplug">CareerPlug</a></li>
    <li><img /><a href="/ats/connectors/eightfold">Eightfold</a></li>
    <li><img /><a href="/ats/connectors/paycor">Paycor</a></li>
    <li><img /><a href="/ats/connectors/phenom">Phenom</a></li>
    <li><img /><a href="/ats/connectors/recruhr">RECRU</a></li>
    <li><img /><a href="/ats/connectors/recruitcrm">Recruit CRM</a></li>
    <li><img /><a href="/ats/connectors/jazzhr">JazzHR</a></li>
    <li><img /><a href="/ats/connectors/carerix">Carerix</a></li>
    <li><img /><a href="/ats/connectors/carerixgraphql">Carerix (GraphQL)</a></li>
    <li><img /><a href="/ats/connectors/inrecruiting">InRecruiting by Zucchetti</a></li>
    <li><img /><a href="/ats/connectors/jobadder">JobAdder</a></li>
    <li><img /><a href="/ats/connectors/ubeeo">Ubeeo</a></li>
    <li><img /><a href="/ats/connectors/connexys">Connexys By Bullhorn</a></li>
    <li><img /><a href="/ats/connectors/hr4you">HR4YOU</a></li>
    <li><img /><a href="/ats/connectors/cornerstoneondemand">Cornerstone OnDemand</a></li>
    <li><img /><a href="/ats/connectors/gem">Gem</a></li>
    <li><img /><a href="/ats/connectors/mercury">Mercury</a></li>
    <li><img /><a href="/ats/connectors/crelate">Crelate</a></li>
    <li><img /><a href="/ats/connectors/manatal">Manatal</a></li>
    <li><img /><a href="/ats/connectors/avionte">Avionté</a></li>
    <li><img /><a href="/ats/connectors/asymbl">Asymbl</a></li>
    <li><img /><a href="/ats/connectors/breezyhr">Breezy HR</a></li>
    <li><img /><a href="/ats/connectors/digitalrecruiters">Digital Recruiters</a></li>
    <li><img /><a href="/ats/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/ats/connectors/spott">Spott</a></li>
    <li><img /><a href="/ats/connectors/loxo">Loxo</a></li>
    <li><img /><a href="/ats/connectors/kula">Kula</a></li>
    <li><img /><a href="/ats/connectors/trackerrms">TrackerRMS</a></li>
    <li><img /><a href="/ats/connectors/talent360">Talent360</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Update interview
Source: https://docs.kombo.dev/ats/v1/patch-applications-application-id-interviews

PATCH /ats/applications/{application_id}/interviews
Update interview

<Warning>**Closed Beta Feature:** This endpoint is currently in closed beta. We're testing it with selected customers before its public release. If you're interested in learning more or getting early access, please reach out.</Warning>


# Updates an integration fields passthrough setting
Source: https://docs.kombo.dev/ats/v1/patch-integrations-integration-id-integration-fields-integration-field-id

PATCH /integrations/{integration_id}/integration-fields/{integration_field_id}
When enabled, the integration field will be passed as part of the `integration_fields` array on the specific model endpoint. Providing false will disable the passthrough for the specified field.



# Add attachment to application
Source: https://docs.kombo.dev/ats/v1/post-applications-application-id-attachments

POST /ats/applications/{application_id}/attachments
Uploads an attachment file for the specified applicant.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/ats/connectors/workday">Workday</a></li>
    <li><img /><a href="/ats/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/ats/connectors/smartrecruiters">SmartRecruiters</a></li>
    <li><img /><a href="/ats/connectors/factorial">Factorial</a></li>
    <li><img /><a href="/ats/connectors/oraclerecruiting">Oracle Recruiting Cloud</a></li>
    <li><img /><a href="/ats/connectors/lever">Lever</a></li>
    <li><img /><a href="/ats/connectors/icims">iCIMS</a></li>
    <li><img /><a href="/ats/connectors/cornerstonetalentlink">Cornerstone TalentLink</a></li>
    <li><img /><a href="/ats/connectors/recruitee">Tellent Recruitee</a></li>
    <li><img /><a href="/ats/connectors/recruiterflow">RecruiterFlow</a></li>
    <li><img /><a href="/ats/connectors/greenhouse">Greenhouse (V1)</a></li>
    <li><img /><a href="/ats/connectors/greenhousev3">Greenhouse (V3)</a></li>
    <li><img /><a href="/ats/connectors/teamtailor">Teamtailor</a></li>
    <li><img /><a href="/ats/connectors/ashby">Ashby</a></li>
    <li><img /><a href="/ats/connectors/onlyfy">Onlyfy</a></li>
    <li><img /><a href="/ats/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/ats/connectors/ukgready">UKG Ready</a></li>
    <li><img /><a href="/ats/connectors/adpworkforcenow">ADP Workforce Now</a></li>
    <li><img /><a href="/ats/connectors/afas">AFAS Software</a></li>
    <li><img /><a href="/ats/connectors/bullhorn4salesforce">Bullhorn for Salesforce</a></li>
    <li><img /><a href="/ats/connectors/bullhorn">Bullhorn</a></li>
    <li><img /><a href="/ats/connectors/bullhornlogin">Bullhorn Login</a></li>
    <li><img /><a href="/ats/connectors/workable">Workable</a></li>
    <li><img /><a href="/ats/connectors/jobvite">Jobvite</a></li>
    <li><img /><a href="/ats/connectors/fountain">Fountain</a></li>
    <li><img /><a href="/ats/connectors/welcometothejungle">Welcome to the Jungle</a></li>
    <li><img /><a href="/ats/connectors/dvinci">d.vinci</a></li>
    <li><img /><a href="/ats/connectors/dvinciadmin">d.vinci admin</a></li>
    <li><img /><a href="/ats/connectors/traffit">TRAFFIT</a></li>
    <li><img /><a href="/ats/connectors/erecruiter">eRecruiter</a></li>
    <li><img /><a href="/ats/connectors/abacusumantis">Abacus Umantis</a></li>
    <li><img /><a href="/ats/connectors/umantis">Haufe Umantis</a></li>
    <li><img /><a href="/ats/connectors/taleez">Taleez</a></li>
    <li><img /><a href="/ats/connectors/hrworks">HR WORKS</a></li>
    <li><img /><a href="/ats/connectors/otys">OTYS</a></li>
    <li><img /><a href="/ats/connectors/zohorecruit">Zoho Recruit</a></li>
    <li><img /><a href="/ats/connectors/jobdiva">JobDiva</a></li>
    <li><img /><a href="/ats/connectors/paradox">Paradox</a></li>
    <li><img /><a href="/ats/connectors/recruitcrm">Recruit CRM</a></li>
    <li><img /><a href="/ats/connectors/jazzhr">JazzHR</a></li>
    <li><img /><a href="/ats/connectors/bite">BITE</a></li>
    <li><img /><a href="/ats/connectors/homerun">Homerun</a></li>
    <li><img /><a href="/ats/connectors/carerix">Carerix</a></li>
    <li><img /><a href="/ats/connectors/carerixgraphql">Carerix (GraphQL)</a></li>
    <li><img /><a href="/ats/connectors/inrecruiting">InRecruiting by Zucchetti</a></li>
    <li><img /><a href="/ats/connectors/jobadder">JobAdder</a></li>
    <li><img /><a href="/ats/connectors/hr4you">HR4YOU</a></li>
    <li><img /><a href="/ats/connectors/odoo">Odoo</a></li>
    <li><img /><a href="/ats/connectors/covetorest">Coveto (REST API)</a></li>
    <li><img /><a href="/ats/connectors/mercury">Mercury</a></li>
    <li><img /><a href="/ats/connectors/crelate">Crelate</a></li>
    <li><img /><a href="/ats/connectors/manatal">Manatal</a></li>
    <li><img /><a href="/ats/connectors/avionte">Avionté</a></li>
    <li><img /><a href="/ats/connectors/asymbl">Asymbl</a></li>
    <li><img /><a href="/ats/connectors/breezyhr">Breezy HR</a></li>
    <li><img /><a href="/ats/connectors/reachmee">ReachMee</a></li>
    <li><img /><a href="/ats/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/ats/connectors/loxo">Loxo</a></li>
    <li><img /><a href="/ats/connectors/trackerrms">TrackerRMS</a></li>
    <li><img /><a href="/ats/connectors/talent360">Talent360</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

<Warning>
  If adding an attachment to an application is not supported by the integration, the attachment will be [added to the candidate](/ats/v1/post-candidates-candidate-id-attachments) instead.
</Warning>

<Note>
  This endpoint requires the permission **Add attachments** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "application_id": "GRKdd9dibYKKCrmGRSMJf3wu",
  "attachment": {
    "name": "Frank Doe CV.txt",
    "data": "SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=",
    "type": "CV",
    "content_type": "text/plain"
  },
  "remote_fields": {}
}
```


# Create interview
Source: https://docs.kombo.dev/ats/v1/post-applications-application-id-interviews

POST /ats/applications/{application_id}/interviews
Create interview

<Warning>**Closed Beta Feature:** This endpoint is currently in closed beta. We're testing it with selected customers before its public release. If you're interested in learning more or getting early access, please reach out.</Warning>


# Add note to application
Source: https://docs.kombo.dev/ats/v1/post-applications-application-id-notes

POST /ats/applications/{application_id}/notes
Add a note to an application.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/ats/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/ats/connectors/smartrecruiters">SmartRecruiters</a></li>
    <li><img /><a href="/ats/connectors/lever">Lever</a></li>
    <li><img /><a href="/ats/connectors/cornerstonetalentlink">Cornerstone TalentLink</a></li>
    <li><img /><a href="/ats/connectors/recruitee">Tellent Recruitee</a></li>
    <li><img /><a href="/ats/connectors/greenhouse">Greenhouse (V1)</a></li>
    <li><img /><a href="/ats/connectors/greenhousev3">Greenhouse (V3)</a></li>
    <li><img /><a href="/ats/connectors/teamtailor">Teamtailor</a></li>
    <li><img /><a href="/ats/connectors/ashby">Ashby</a></li>
    <li><img /><a href="/ats/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/ats/connectors/ukgready">UKG Ready</a></li>
    <li><img /><a href="/ats/connectors/afas">AFAS Software</a></li>
    <li><img /><a href="/ats/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/ats/connectors/bullhorn4salesforce">Bullhorn for Salesforce</a></li>
    <li><img /><a href="/ats/connectors/bullhorn">Bullhorn</a></li>
    <li><img /><a href="/ats/connectors/workable">Workable</a></li>
    <li><img /><a href="/ats/connectors/jobvite">Jobvite</a></li>
    <li><img /><a href="/ats/connectors/fountain">Fountain</a></li>
    <li><img /><a href="/ats/connectors/pinpoint">Pinpoint</a></li>
    <li><img /><a href="/ats/connectors/dvinci">d.vinci</a></li>
    <li><img /><a href="/ats/connectors/dvinciadmin">d.vinci admin</a></li>
    <li><img /><a href="/ats/connectors/traffit">TRAFFIT</a></li>
    <li><img /><a href="/ats/connectors/abacusumantis">Abacus Umantis</a></li>
    <li><img /><a href="/ats/connectors/umantis">Haufe Umantis</a></li>
    <li><img /><a href="/ats/connectors/hrworks">HR WORKS</a></li>
    <li><img /><a href="/ats/connectors/otys">OTYS</a></li>
    <li><img /><a href="/ats/connectors/zohorecruit">Zoho Recruit</a></li>
    <li><img /><a href="/ats/connectors/eploy">Eploy</a></li>
    <li><img /><a href="/ats/connectors/jobdiva">JobDiva</a></li>
    <li><img /><a href="/ats/connectors/paradox">Paradox</a></li>
    <li><img /><a href="/ats/connectors/recruitcrm">Recruit CRM</a></li>
    <li><img /><a href="/ats/connectors/jazzhr">JazzHR</a></li>
    <li><img /><a href="/ats/connectors/homerun">Homerun</a></li>
    <li><img /><a href="/ats/connectors/carerix">Carerix</a></li>
    <li><img /><a href="/ats/connectors/carerixgraphql">Carerix (GraphQL)</a></li>
    <li><img /><a href="/ats/connectors/inrecruiting">InRecruiting by Zucchetti</a></li>
    <li><img /><a href="/ats/connectors/jobadder">JobAdder</a></li>
    <li><img /><a href="/ats/connectors/hr4you">HR4YOU</a></li>
    <li><img /><a href="/ats/connectors/comeet">Spark Hire Recruit</a></li>
    <li><img /><a href="/ats/connectors/mercury">Mercury</a></li>
    <li><img /><a href="/ats/connectors/crelate">Crelate</a></li>
    <li><img /><a href="/ats/connectors/manatal">Manatal</a></li>
    <li><img /><a href="/ats/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/ats/connectors/logicmelon">Logic Melon</a></li>
    <li><img /><a href="/ats/connectors/loxo">Loxo</a></li>
    <li><img /><a href="/ats/connectors/kula">Kula</a></li>
    <li><img /><a href="/ats/connectors/trackerrms">TrackerRMS</a></li>
    <li><img /><a href="/ats/connectors/talent360">Talent360</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Add extra information to an application. This can be any extra text information you want to add to an application.

<Note>
  This endpoint requires the permission **Add notes** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "content": "A new message from the candidate is available in YourChat!",
  "content_type": "PLAIN_TEXT",
  "remote_fields": {}
}
```


# Reject application
Source: https://docs.kombo.dev/ats/v1/post-applications-application-id-reject

POST /ats/applications/{application_id}/reject
Rejects an application with a provided reason.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/ats/connectors/workday">Workday</a></li>
    <li><img /><a href="/ats/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/ats/connectors/smartrecruiters">SmartRecruiters</a></li>
    <li><img /><a href="/ats/connectors/oraclerecruiting">Oracle Recruiting Cloud</a></li>
    <li><img /><a href="/ats/connectors/lever">Lever</a></li>
    <li><img /><a href="/ats/connectors/recruitee">Tellent Recruitee</a></li>
    <li><img /><a href="/ats/connectors/recruiterflow">RecruiterFlow</a></li>
    <li><img /><a href="/ats/connectors/greenhouse">Greenhouse (V1)</a></li>
    <li><img /><a href="/ats/connectors/greenhousev3">Greenhouse (V3)</a></li>
    <li><img /><a href="/ats/connectors/teamtailor">Teamtailor</a></li>
    <li><img /><a href="/ats/connectors/ashby">Ashby</a></li>
    <li><img /><a href="/ats/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/ats/connectors/ukgready">UKG Ready</a></li>
    <li><img /><a href="/ats/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/ats/connectors/bullhorn">Bullhorn</a></li>
    <li><img /><a href="/ats/connectors/workable">Workable</a></li>
    <li><img /><a href="/ats/connectors/jobvite">Jobvite</a></li>
    <li><img /><a href="/ats/connectors/abacusumantis">Abacus Umantis</a></li>
    <li><img /><a href="/ats/connectors/umantis">Haufe Umantis</a></li>
    <li><img /><a href="/ats/connectors/zohorecruit">Zoho Recruit</a></li>
    <li><img /><a href="/ats/connectors/eploy">Eploy</a></li>
    <li><img /><a href="/ats/connectors/odoo">Odoo</a></li>
    <li><img /><a href="/ats/connectors/mercury">Mercury</a></li>
    <li><img /><a href="/ats/connectors/manatal">Manatal</a></li>
    <li><img /><a href="/ats/connectors/avionte">Avionté</a></li>
    <li><img /><a href="/ats/connectors/trackerrms">TrackerRMS</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Rejects an application with a provided reason. Optionally, you can provide a free text note. You can get the list of rejection reasons with our [Get rejection reasons endpoint](/ats/v1/get-rejection-reasons).

<Note>
  This endpoint requires the permission **Reject applications** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "rejection_reason_id": "3PJ8PZhZZa1eEdd2DtPNtVup",
  "note": "Candidate was a great culture fit but didn't bring the hard skills we need.",
  "remote_fields": {}
}
```


# Add result link to application
Source: https://docs.kombo.dev/ats/v1/post-applications-application-id-result-links

POST /ats/applications/{application_id}/result-links
Add a result link to an application.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/ats/connectors/workday">Workday</a></li>
    <li><img /><a href="/ats/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/ats/connectors/smartrecruiters">SmartRecruiters</a></li>
    <li><img /><a href="/ats/connectors/oraclerecruiting">Oracle Recruiting Cloud</a></li>
    <li><img /><a href="/ats/connectors/lever">Lever</a></li>
    <li><img /><a href="/ats/connectors/icims">iCIMS</a></li>
    <li><img /><a href="/ats/connectors/recruitee">Tellent Recruitee</a></li>
    <li><img /><a href="/ats/connectors/greenhouse">Greenhouse (V1)</a></li>
    <li><img /><a href="/ats/connectors/greenhousev3">Greenhouse (V3)</a></li>
    <li><img /><a href="/ats/connectors/teamtailor">Teamtailor</a></li>
    <li><img /><a href="/ats/connectors/ashby">Ashby</a></li>
    <li><img /><a href="/ats/connectors/talentsoftcustomer">CEGID TalentSoft Customer</a></li>
    <li><img /><a href="/ats/connectors/onlyfy">Onlyfy</a></li>
    <li><img /><a href="/ats/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/ats/connectors/adpworkforcenow">ADP Workforce Now</a></li>
    <li><img /><a href="/ats/connectors/afas">AFAS Software</a></li>
    <li><img /><a href="/ats/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/ats/connectors/bullhorn4salesforce">Bullhorn for Salesforce</a></li>
    <li><img /><a href="/ats/connectors/bullhorn">Bullhorn</a></li>
    <li><img /><a href="/ats/connectors/bullhornlogin">Bullhorn Login</a></li>
    <li><img /><a href="/ats/connectors/workable">Workable</a></li>
    <li><img /><a href="/ats/connectors/jobvite">Jobvite</a></li>
    <li><img /><a href="/ats/connectors/fountain">Fountain</a></li>
    <li><img /><a href="/ats/connectors/pinpoint">Pinpoint</a></li>
    <li><img /><a href="/ats/connectors/welcometothejungle">Welcome to the Jungle</a></li>
    <li><img /><a href="/ats/connectors/dvinci">d.vinci</a></li>
    <li><img /><a href="/ats/connectors/dvinciadmin">d.vinci admin</a></li>
    <li><img /><a href="/ats/connectors/traffit">TRAFFIT</a></li>
    <li><img /><a href="/ats/connectors/erecruiter">eRecruiter</a></li>
    <li><img /><a href="/ats/connectors/abacusumantis">Abacus Umantis</a></li>
    <li><img /><a href="/ats/connectors/umantis">Haufe Umantis</a></li>
    <li><img /><a href="/ats/connectors/hrworks">HR WORKS</a></li>
    <li><img /><a href="/ats/connectors/otys">OTYS</a></li>
    <li><img /><a href="/ats/connectors/zohorecruit">Zoho Recruit</a></li>
    <li><img /><a href="/ats/connectors/eploy">Eploy</a></li>
    <li><img /><a href="/ats/connectors/jobdiva">JobDiva</a></li>
    <li><img /><a href="/ats/connectors/eightfold">Eightfold</a></li>
    <li><img /><a href="/ats/connectors/paradox">Paradox</a></li>
    <li><img /><a href="/ats/connectors/jazzhr">JazzHR</a></li>
    <li><img /><a href="/ats/connectors/homerun">Homerun</a></li>
    <li><img /><a href="/ats/connectors/carerix">Carerix</a></li>
    <li><img /><a href="/ats/connectors/carerixgraphql">Carerix (GraphQL)</a></li>
    <li><img /><a href="/ats/connectors/inrecruiting">InRecruiting by Zucchetti</a></li>
    <li><img /><a href="/ats/connectors/hr4you">HR4YOU</a></li>
    <li><img /><a href="/ats/connectors/gem">Gem</a></li>
    <li><img /><a href="/ats/connectors/mercury">Mercury</a></li>
    <li><img /><a href="/ats/connectors/manatal">Manatal</a></li>
    <li><img /><a href="/ats/connectors/breezyhr">Breezy HR</a></li>
    <li><img /><a href="/ats/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/ats/connectors/kula">Kula</a></li>
    <li><img /><a href="/ats/connectors/trackerrms">TrackerRMS</a></li>
    <li><img /><a href="/ats/connectors/talent360">Talent360</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

This can, for example, be used to link a candidate back to a test result/assessment in your application. As not all ATS tools have a "result link" feature, we sometimes repurpose other fields to expose it.

<Note>
  This endpoint requires the permission **Add result links** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "application_id": "8Xi6iZrwusZqJmDGXs49GBmJ",
  "label": "Assessment Result",
  "url": "https://example.com/test-results/5BtP1WC1UboS7CF3yxjKcvjG",
  "details": {
    "custom_field_name_prefix": "Acme:",
    "attributes": [
      {
        "key": "Score",
        "value": "100%"
      },
      {
        "key": "Time",
        "value": "2:30h"
      }
    ]
  },
  "remote_fields": {}
}
```


# Create candidate
Source: https://docs.kombo.dev/ats/v1/post-candidates

POST /ats/candidates
Create a new candidate and application for the specified job.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/ats/connectors/workday">Workday</a></li>
    <li><img /><a href="/ats/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/ats/connectors/smartrecruiters">SmartRecruiters</a></li>
    <li><img /><a href="/ats/connectors/factorial">Factorial</a></li>
    <li><img /><a href="/ats/connectors/oraclerecruiting">Oracle Recruiting Cloud</a></li>
    <li><img /><a href="/ats/connectors/lever">Lever</a></li>
    <li><img /><a href="/ats/connectors/icims">iCIMS</a></li>
    <li><img /><a href="/ats/connectors/cornerstonetalentlink">Cornerstone TalentLink</a></li>
    <li><img /><a href="/ats/connectors/recruitee">Tellent Recruitee</a></li>
    <li><img /><a href="/ats/connectors/recruiterflow">RecruiterFlow</a></li>
    <li><img /><a href="/ats/connectors/greenhouse">Greenhouse (V1)</a></li>
    <li><img /><a href="/ats/connectors/greenhousev3">Greenhouse (V3)</a></li>
    <li><img /><a href="/ats/connectors/greenhousejobboard">Greenhouse Job Board</a></li>
    <li><img /><a href="/ats/connectors/teamtailor">Teamtailor</a></li>
    <li><img /><a href="/ats/connectors/teamtailorjobboards">Teamtailor Job Boards</a></li>
    <li><img /><a href="/ats/connectors/ashby">Ashby</a></li>
    <li><img /><a href="/ats/connectors/talentsoft">CEGID TalentSoft FrontOffice</a></li>
    <li><img /><a href="/ats/connectors/concludis">concludis</a></li>
    <li><img /><a href="/ats/connectors/perbilityhelix">Perbility Helix</a></li>
    <li><img /><a href="/ats/connectors/talention">Talention</a></li>
    <li><img /><a href="/ats/connectors/piloga">P\&I Loga</a></li>
    <li><img /><a href="/ats/connectors/onlyfy">Onlyfy</a></li>
    <li><img /><a href="/ats/connectors/personio">Personio</a></li>
    <li><img /><a href="/ats/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/ats/connectors/ukgready">UKG Ready</a></li>
    <li><img /><a href="/ats/connectors/taleo">Oracle Taleo</a></li>
    <li><img /><a href="/ats/connectors/rexx">rexx systems</a></li>
    <li><img /><a href="/ats/connectors/afas">AFAS Software</a></li>
    <li><img /><a href="/ats/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/ats/connectors/bullhorn">Bullhorn</a></li>
    <li><img /><a href="/ats/connectors/bullhornlogin">Bullhorn Login</a></li>
    <li><img /><a href="/ats/connectors/workable">Workable</a></li>
    <li><img /><a href="/ats/connectors/jobvite">Jobvite</a></li>
    <li><img /><a href="/ats/connectors/fountain">Fountain</a></li>
    <li><img /><a href="/ats/connectors/softgarden">Softgarden</a></li>
    <li><img /><a href="/ats/connectors/softgardenpartner">Softgarden Partner</a></li>
    <li><img /><a href="/ats/connectors/pinpoint">Pinpoint</a></li>
    <li><img /><a href="/ats/connectors/welcometothejungle">Welcome to the Jungle</a></li>
    <li><img /><a href="/ats/connectors/dvinci">d.vinci</a></li>
    <li><img /><a href="/ats/connectors/join">JOIN</a></li>
    <li><img /><a href="/ats/connectors/sagehr">Sage HR</a></li>
    <li><img /><a href="/ats/connectors/traffit">TRAFFIT</a></li>
    <li><img /><a href="/ats/connectors/erecruiter">eRecruiter</a></li>
    <li><img /><a href="/ats/connectors/abacusumantis">Abacus Umantis</a></li>
    <li><img /><a href="/ats/connectors/umantis">Haufe Umantis</a></li>
    <li><img /><a href="/ats/connectors/jobylon">Jobylon</a></li>
    <li><img /><a href="/ats/connectors/taleez">Taleez</a></li>
    <li><img /><a href="/ats/connectors/hrworks">HR WORKS</a></li>
    <li><img /><a href="/ats/connectors/otys">OTYS</a></li>
    <li><img /><a href="/ats/connectors/zohorecruit">Zoho Recruit</a></li>
    <li><img /><a href="/ats/connectors/ceipal">Ceipal</a></li>
    <li><img /><a href="/ats/connectors/eploy">Eploy</a></li>
    <li><img /><a href="/ats/connectors/jobdiva">JobDiva</a></li>
    <li><img /><a href="/ats/connectors/careerplug">CareerPlug</a></li>
    <li><img /><a href="/ats/connectors/perview">Perview</a></li>
    <li><img /><a href="/ats/connectors/eightfold">Eightfold</a></li>
    <li><img /><a href="/ats/connectors/paycor">Paycor</a></li>
    <li><img /><a href="/ats/connectors/avature">Avature</a></li>
    <li><img /><a href="/ats/connectors/apploi">Apploi</a></li>
    <li><img /><a href="/ats/connectors/phenom">Phenom</a></li>
    <li><img /><a href="/ats/connectors/paradox">Paradox</a></li>
    <li><img /><a href="/ats/connectors/heyrecruit">Heyrecruit</a></li>
    <li><img /><a href="/ats/connectors/recruhr">RECRU</a></li>
    <li><img /><a href="/ats/connectors/recruitcrm">Recruit CRM</a></li>
    <li><img /><a href="/ats/connectors/jazzhr">JazzHR</a></li>
    <li><img /><a href="/ats/connectors/bite">BITE</a></li>
    <li><img /><a href="/ats/connectors/brassring">Brass Ring</a></li>
    <li><img /><a href="/ats/connectors/homerun">Homerun</a></li>
    <li><img /><a href="/ats/connectors/mysolution">Mysolution</a></li>
    <li><img /><a href="/ats/connectors/carerix">Carerix</a></li>
    <li><img /><a href="/ats/connectors/carerixgraphql">Carerix (GraphQL)</a></li>
    <li><img /><a href="/ats/connectors/hroffice">HR Office</a></li>
    <li><img /><a href="/ats/connectors/talentclue">Talent Clue</a></li>
    <li><img /><a href="/ats/connectors/inrecruiting">InRecruiting by Zucchetti</a></li>
    <li><img /><a href="/ats/connectors/jobadder">JobAdder</a></li>
    <li><img /><a href="/ats/connectors/ubeeo">Ubeeo</a></li>
    <li><img /><a href="/ats/connectors/connexys">Connexys By Bullhorn</a></li>
    <li><img /><a href="/ats/connectors/hr4you">HR4YOU</a></li>
    <li><img /><a href="/ats/connectors/cornerstoneondemand">Cornerstone OnDemand</a></li>
    <li><img /><a href="/ats/connectors/zvooverecruit">Zvoove Recruit</a></li>
    <li><img /><a href="/ats/connectors/odoo">Odoo</a></li>
    <li><img /><a href="/ats/connectors/comeet">Spark Hire Recruit</a></li>
    <li><img /><a href="/ats/connectors/compleetpitcher">Compleet (Pitcher API)</a></li>
    <li><img /><a href="/ats/connectors/compleet">Compleet (only PersoProfiler)</a></li>
    <li><img /><a href="/ats/connectors/gem">Gem</a></li>
    <li><img /><a href="/ats/connectors/laura">Laura</a></li>
    <li><img /><a href="/ats/connectors/covetorest">Coveto (REST API)</a></li>
    <li><img /><a href="/ats/connectors/coveto">Coveto (legacy SOAP API)</a></li>
    <li><img /><a href="/ats/connectors/mercury">Mercury</a></li>
    <li><img /><a href="/ats/connectors/crelate">Crelate</a></li>
    <li><img /><a href="/ats/connectors/manatal">Manatal</a></li>
    <li><img /><a href="/ats/connectors/avionte">Avionté</a></li>
    <li><img /><a href="/ats/connectors/mhmhr">MHM HR</a></li>
    <li><img /><a href="/ats/connectors/asymbl">Asymbl</a></li>
    <li><img /><a href="/ats/connectors/breezyhr">Breezy HR</a></li>
    <li><img /><a href="/ats/connectors/flatchr">Flatchr</a></li>
    <li><img /><a href="/ats/connectors/dayforce">Dayforce</a></li>
    <li><img /><a href="/ats/connectors/digitalrecruiters">Digital Recruiters</a></li>
    <li><img /><a href="/ats/connectors/applicantstack">ApplicantStack</a></li>
    <li><img /><a href="/ats/connectors/reachmee">ReachMee</a></li>
    <li><img /><a href="/ats/connectors/talentadore">TalentAdore</a></li>
    <li><img /><a href="/ats/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/ats/connectors/guidecom">GuideCom</a></li>
    <li><img /><a href="/ats/connectors/spott">Spott</a></li>
    <li><img /><a href="/ats/connectors/logicmelon">Logic Melon</a></li>
    <li><img /><a href="/ats/connectors/loxo">Loxo</a></li>
    <li><img /><a href="/ats/connectors/kula">Kula</a></li>
    <li><img /><a href="/ats/connectors/trackerrms">TrackerRMS</a></li>
    <li><img /><a href="/ats/connectors/databites">Databites</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

<Warning>
  **We recommend using the [Create application](/ats/v1/post-jobs-job-id-applications) endpoint instead.**

  We realized that in practice it was always more about creating *applications* instead of *candidates*, so we created a new, more aptly named one that you should use instead: [Create application](/ats/v1/post-jobs-job-id-applications)

  Using it also has the benefit that we return the newly created applicant at the root level, so you can easily store its ID.
</Warning>

<Note>
  This endpoint requires the permission **Create applications and candidates** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "candidate": {
    "first_name": "Frank",
    "last_name": "Doe",
    "company": "Acme Inc.",
    "title": "Head of Integrations",
    "email_address": "frank.doe@example.com",
    "phone_number": "+1-541-754-3010",
    "gender": "MALE",
    "salary_expectations": {
      "amount": 100000,
      "period": "YEAR"
    },
    "availability_date": "2021-01-01",
    "location": {
      "city": "New York",
      "country": "US",
      "state": "NY"
    },
    "social_links": [
      {
        "url": "https://www.linkedin.com/in/frank-doe-123456789/"
      },
      {
        "url": "https://twitter.com/frankdoe"
      }
    ]
  },
  "application": {
    "job_id": "BDpgnpZ148nrGh4mYHNxJBgx",
    "stage_id": "8x3YKRDcuRnwShdh96ShBNn1"
  },
  "attachments": [
    {
      "name": "Frank Doe CV.txt",
      "data": "SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=",
      "type": "CV",
      "content_type": "text/plain"
    }
  ],
  "screening_question_answers": [
    {
      "question_id": "3phFBNXRweGnDmsU9o2vdPuQ",
      "answer": "Yes"
    },
    {
      "question_id": "EYJjhMQT3LtVKXnTbnRT8s6U",
      "answer": [
        "GUzE666zfyjeoCJX6A8n7wh6",
        "5WPHzzKAv8cx97KtHRUV96U8",
        "7yZfKGzWigXxxRTygqAfHvyE"
      ]
    }
  ],
  "remote_fields": {}
}
```


# Add attachment to candidate
Source: https://docs.kombo.dev/ats/v1/post-candidates-candidate-id-attachments

POST /ats/candidates/{candidate_id}/attachments
Uploads an attachment file for the specified candidate.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/ats/connectors/workday">Workday</a></li>
    <li><img /><a href="/ats/connectors/smartrecruiters">SmartRecruiters</a></li>
    <li><img /><a href="/ats/connectors/oraclerecruiting">Oracle Recruiting Cloud</a></li>
    <li><img /><a href="/ats/connectors/lever">Lever</a></li>
    <li><img /><a href="/ats/connectors/icims">iCIMS</a></li>
    <li><img /><a href="/ats/connectors/recruitee">Tellent Recruitee</a></li>
    <li><img /><a href="/ats/connectors/recruiterflow">RecruiterFlow</a></li>
    <li><img /><a href="/ats/connectors/greenhouse">Greenhouse (V1)</a></li>
    <li><img /><a href="/ats/connectors/teamtailor">Teamtailor</a></li>
    <li><img /><a href="/ats/connectors/ashby">Ashby</a></li>
    <li><img /><a href="/ats/connectors/onlyfy">Onlyfy</a></li>
    <li><img /><a href="/ats/connectors/ukgready">UKG Ready</a></li>
    <li><img /><a href="/ats/connectors/afas">AFAS Software</a></li>
    <li><img /><a href="/ats/connectors/bullhorn4salesforce">Bullhorn for Salesforce</a></li>
    <li><img /><a href="/ats/connectors/bullhorn">Bullhorn</a></li>
    <li><img /><a href="/ats/connectors/bullhornlogin">Bullhorn Login</a></li>
    <li><img /><a href="/ats/connectors/workable">Workable</a></li>
    <li><img /><a href="/ats/connectors/welcometothejungle">Welcome to the Jungle</a></li>
    <li><img /><a href="/ats/connectors/erecruiter">eRecruiter</a></li>
    <li><img /><a href="/ats/connectors/taleez">Taleez</a></li>
    <li><img /><a href="/ats/connectors/hrworks">HR WORKS</a></li>
    <li><img /><a href="/ats/connectors/otys">OTYS</a></li>
    <li><img /><a href="/ats/connectors/jazzhr">JazzHR</a></li>
    <li><img /><a href="/ats/connectors/homerun">Homerun</a></li>
    <li><img /><a href="/ats/connectors/carerix">Carerix</a></li>
    <li><img /><a href="/ats/connectors/carerixgraphql">Carerix (GraphQL)</a></li>
    <li><img /><a href="/ats/connectors/inrecruiting">InRecruiting by Zucchetti</a></li>
    <li><img /><a href="/ats/connectors/jobadder">JobAdder</a></li>
    <li><img /><a href="/ats/connectors/hr4you">HR4YOU</a></li>
    <li><img /><a href="/ats/connectors/odoo">Odoo</a></li>
    <li><img /><a href="/ats/connectors/mercury">Mercury</a></li>
    <li><img /><a href="/ats/connectors/manatal">Manatal</a></li>
    <li><img /><a href="/ats/connectors/avionte">Avionté</a></li>
    <li><img /><a href="/ats/connectors/breezyhr">Breezy HR</a></li>
    <li><img /><a href="/ats/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/ats/connectors/loxo">Loxo</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

<Warning>
  **We recommend using the [add attachment to application](/ats/v1/post-applications-application-id-attachments) endpoint instead.**

  We realized that in practice it was always more about adding attachments to *applications* instead of *candidates*, so we created a new, more aptly named one that you should use instead: [add attachment to application](/ats/v1/post-applications-application-id-attachments)
</Warning>

<Note>
  This endpoint requires the permission **Add attachments** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "candidate_id": "GRKdd9dibYKKCrmGRSMJf3wu",
  "attachment": {
    "name": "Frank Doe CV.txt",
    "data": "SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=",
    "type": "CV",
    "content_type": "text/plain"
  }
}
```


# Add result link to candidate
Source: https://docs.kombo.dev/ats/v1/post-candidates-candidate-id-result-links

POST /ats/candidates/{candidate_id}/result-links
Add a result link to a candidate.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/ats/connectors/workday">Workday</a></li>
    <li><img /><a href="/ats/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/ats/connectors/smartrecruiters">SmartRecruiters</a></li>
    <li><img /><a href="/ats/connectors/lever">Lever</a></li>
    <li><img /><a href="/ats/connectors/recruitee">Tellent Recruitee</a></li>
    <li><img /><a href="/ats/connectors/greenhouse">Greenhouse (V1)</a></li>
    <li><img /><a href="/ats/connectors/teamtailor">Teamtailor</a></li>
    <li><img /><a href="/ats/connectors/ashby">Ashby</a></li>
    <li><img /><a href="/ats/connectors/onlyfy">Onlyfy</a></li>
    <li><img /><a href="/ats/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/ats/connectors/bullhorn">Bullhorn</a></li>
    <li><img /><a href="/ats/connectors/bullhornlogin">Bullhorn Login</a></li>
    <li><img /><a href="/ats/connectors/workable">Workable</a></li>
    <li><img /><a href="/ats/connectors/jobvite">Jobvite</a></li>
    <li><img /><a href="/ats/connectors/welcometothejungle">Welcome to the Jungle</a></li>
    <li><img /><a href="/ats/connectors/erecruiter">eRecruiter</a></li>
    <li><img /><a href="/ats/connectors/otys">OTYS</a></li>
    <li><img /><a href="/ats/connectors/jazzhr">JazzHR</a></li>
    <li><img /><a href="/ats/connectors/homerun">Homerun</a></li>
    <li><img /><a href="/ats/connectors/gem">Gem</a></li>
    <li><img /><a href="/ats/connectors/mercury">Mercury</a></li>
    <li><img /><a href="/ats/connectors/manatal">Manatal</a></li>
    <li><img /><a href="/ats/connectors/breezyhr">Breezy HR</a></li>
    <li><img /><a href="/ats/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/ats/connectors/talent360">Talent360</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

<Warning>
  **We recommend to use [add result link to application](/ats/v1/post-applications-application-id-result-links) instead.**

  This can, for example, be used to link a candidate back to a test result/assessment in your application. As not all ATS tools have a "result link" feature, we sometimes repurpose other fields to expose it.
</Warning>

<Note>
  This endpoint requires the permission **Add result links** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "label": "Assessment Result",
  "url": "https://example.com/test-results/5BtP1WC1UboS7CF3yxjKcvjG",
  "details": {
    "custom_field_name_prefix": "Acme:",
    "attributes": [
      {
        "key": "Score",
        "value": "100%"
      },
      {
        "key": "Time",
        "value": "2:30h"
      }
    ]
  },
  "remote_fields": {}
}
```


# Add tag to candidate
Source: https://docs.kombo.dev/ats/v1/post-candidates-candidate-id-tags

POST /ats/candidates/{candidate_id}/tags
Add a tag to a candidate.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/ats/connectors/workday">Workday</a></li>
    <li><img /><a href="/ats/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/ats/connectors/smartrecruiters">SmartRecruiters</a></li>
    <li><img /><a href="/ats/connectors/lever">Lever</a></li>
    <li><img /><a href="/ats/connectors/recruitee">Tellent Recruitee</a></li>
    <li><img /><a href="/ats/connectors/greenhouse">Greenhouse (V1)</a></li>
    <li><img /><a href="/ats/connectors/greenhousev3">Greenhouse (V3)</a></li>
    <li><img /><a href="/ats/connectors/teamtailor">Teamtailor</a></li>
    <li><img /><a href="/ats/connectors/ashby">Ashby</a></li>
    <li><img /><a href="/ats/connectors/onlyfy">Onlyfy</a></li>
    <li><img /><a href="/ats/connectors/workable">Workable</a></li>
    <li><img /><a href="/ats/connectors/welcometothejungle">Welcome to the Jungle</a></li>
    <li><img /><a href="/ats/connectors/erecruiter">eRecruiter</a></li>
    <li><img /><a href="/ats/connectors/zohorecruit">Zoho Recruit</a></li>
    <li><img /><a href="/ats/connectors/recruhr">RECRU</a></li>
    <li><img /><a href="/ats/connectors/odoo">Odoo</a></li>
    <li><img /><a href="/ats/connectors/avionte">Avionté</a></li>
    <li><img /><a href="/ats/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/ats/connectors/trackerrms">TrackerRMS</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Kombo takes care of creating the tag if required, finding out the right ID, and appending it to the list of tags.

<Note>
  This endpoint requires the permission **Manage tags** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "tag": {
    "name": "Excellent Fit"
  }
}
```


# Activate integration (optional)
Source: https://docs.kombo.dev/ats/v1/post-connect-activate-integration

POST /connect/activate-integration
Use this endpoint with the token you get from the connection flow to retrieve information about the created integration. It works in a similar way as the OAuth2 code flow to securely retrieve information and connect the integration to your user. You do not need to call this endpoint for an integration to become active.

<Warning>We are deprecating this endpoint in favour of the [get integration by code endpoint](/v1/get-integration-by-token-token). To migrate you only have to change to the new API endpoint.</Warning>

### Example Request Body

```json theme={null}
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtZXNzYWdlIjoiVGhpcyBpcyBub3QgYW4gYWN0dWFsIHRva2VuLiJ9.JulqgOZBMKceI8vh9YLpVX51efND0ZyfUNHDXLrPz_4"
}
```


# Create connection link
Source: https://docs.kombo.dev/ats/v1/post-connect-create-link

POST /connect/create-link
Generate a unique link that allows your user to enter the embedded Kombo Connect flow.

> Check out [our full guide](/connect/embedded-flow) for more details about implementing the connection flow into your app.

> Kombo will not deduplicate integrations for you that are created with this endpoint. You are responsible for keeping track of integrations in your system and prevent customers from connecting the same tool again. Use the [reconnection link](/v1/post-integrations-integration-id-relink) endpoint if you want a customer to update their credentials.

### Example Request Body

```json theme={null}
{
  "end_user_email": "test@example.com",
  "end_user_organization_name": "Test Inc.",
  "integration_category": "HRIS",
  "integration_tool": "personio",
  "end_user_origin_id": "123",
  "language": "en",
  "link_type": "EMBEDDED"
}
```


# Trigger sync
Source: https://docs.kombo.dev/ats/v1/post-force-sync

POST /force-sync
Trigger a sync for a specific integration.

<Warning>Please note that it is **not** necessary nor recommended to call this endpoint periodically on your side. Kombo already performs periodic syncs for you and you should only trigger syncs yourself in special cases (like when a user clicks on a "Sync" button in your app).</Warning>


# Create provisioning setup link (deprecated)
Source: https://docs.kombo.dev/ats/v1/post-hris-provisioning-groups-group-id-setup-links

POST /hris/provisioning-groups/{group_id}/setup-links
Create a new link that can be passed to the Kombo Connect SDK to open the provisioning setup UI.

<Warning>
  **This endpoint is deprecated!**

  Please use the [Create Setup Flow link endpoint](/v1/post-integrations-integration-id-setup-link) instead. It supports the full Setup Flow (including filtering, field mapping, and any other enabled steps) and works for any integration category, not just HRIS.
</Warning>


# Create reconnection link
Source: https://docs.kombo.dev/ats/v1/post-integrations-integration-id-relink

POST /integrations/{integration_id}/relink
Create a link that will allow the user to reconnect an integration. This is useful if you want to allow your users to update the credentials if the old ones for example expired.

Embed this the same way you would [embed the connect link](/connect/embedded-flow). By default, the link will be valid for 1 hour.

### Example Request Body

```json theme={null}
{
  "language": "en",
  "scope_config_id": "9Pv6aCFwNDEzPNmwjSsY9SQx",
  "link_type": "EMBEDDED"
}
```


# Create Setup Flow link
Source: https://docs.kombo.dev/ats/v1/post-integrations-integration-id-setup-link

POST /integrations/{integration_id}/setup-link
Create a link that lets your customer run the [Setup Flow](/hris/features/setup-flow/introduction) for an integration. Use this to send customers back into setup steps like field mapping or employee filtering without having to go through the initial connection flow again. Pass the returned URL to `showKomboConnect` from the Kombo Connect SDK, the same way you do with a connection link.

The integration must have at least one Setup Flow step enabled (e.g. field mapping or employee filtering); otherwise this endpoint returns a `PLATFORM.INPUT_INVALID` error. Steps can be enabled from the Integration Settings tab in the dashboard or via the [Create Connection Link endpoint](./post-connect-create-link).


# Create application
Source: https://docs.kombo.dev/ats/v1/post-jobs-job-id-applications

POST /ats/jobs/{job_id}/applications
Create a new application and candidate for the specified job.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/ats/connectors/workday">Workday</a></li>
    <li><img /><a href="/ats/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/ats/connectors/smartrecruiters">SmartRecruiters</a></li>
    <li><img /><a href="/ats/connectors/factorial">Factorial</a></li>
    <li><img /><a href="/ats/connectors/oraclerecruiting">Oracle Recruiting Cloud</a></li>
    <li><img /><a href="/ats/connectors/lever">Lever</a></li>
    <li><img /><a href="/ats/connectors/icims">iCIMS</a></li>
    <li><img /><a href="/ats/connectors/cornerstonetalentlink">Cornerstone TalentLink</a></li>
    <li><img /><a href="/ats/connectors/recruitee">Tellent Recruitee</a></li>
    <li><img /><a href="/ats/connectors/recruiterflow">RecruiterFlow</a></li>
    <li><img /><a href="/ats/connectors/greenhouse">Greenhouse (V1)</a></li>
    <li><img /><a href="/ats/connectors/greenhousev3">Greenhouse (V3)</a></li>
    <li><img /><a href="/ats/connectors/greenhousejobboard">Greenhouse Job Board</a></li>
    <li><img /><a href="/ats/connectors/teamtailor">Teamtailor</a></li>
    <li><img /><a href="/ats/connectors/teamtailorjobboards">Teamtailor Job Boards</a></li>
    <li><img /><a href="/ats/connectors/ashby">Ashby</a></li>
    <li><img /><a href="/ats/connectors/talentsoft">CEGID TalentSoft FrontOffice</a></li>
    <li><img /><a href="/ats/connectors/concludis">concludis</a></li>
    <li><img /><a href="/ats/connectors/perbilityhelix">Perbility Helix</a></li>
    <li><img /><a href="/ats/connectors/talention">Talention</a></li>
    <li><img /><a href="/ats/connectors/piloga">P\&I Loga</a></li>
    <li><img /><a href="/ats/connectors/onlyfy">Onlyfy</a></li>
    <li><img /><a href="/ats/connectors/personio">Personio</a></li>
    <li><img /><a href="/ats/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/ats/connectors/ukgready">UKG Ready</a></li>
    <li><img /><a href="/ats/connectors/taleo">Oracle Taleo</a></li>
    <li><img /><a href="/ats/connectors/rexx">rexx systems</a></li>
    <li><img /><a href="/ats/connectors/afas">AFAS Software</a></li>
    <li><img /><a href="/ats/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/ats/connectors/bullhorn">Bullhorn</a></li>
    <li><img /><a href="/ats/connectors/bullhornlogin">Bullhorn Login</a></li>
    <li><img /><a href="/ats/connectors/workable">Workable</a></li>
    <li><img /><a href="/ats/connectors/jobvite">Jobvite</a></li>
    <li><img /><a href="/ats/connectors/fountain">Fountain</a></li>
    <li><img /><a href="/ats/connectors/softgarden">Softgarden</a></li>
    <li><img /><a href="/ats/connectors/softgardenpartner">Softgarden Partner</a></li>
    <li><img /><a href="/ats/connectors/pinpoint">Pinpoint</a></li>
    <li><img /><a href="/ats/connectors/welcometothejungle">Welcome to the Jungle</a></li>
    <li><img /><a href="/ats/connectors/dvinci">d.vinci</a></li>
    <li><img /><a href="/ats/connectors/join">JOIN</a></li>
    <li><img /><a href="/ats/connectors/sagehr">Sage HR</a></li>
    <li><img /><a href="/ats/connectors/traffit">TRAFFIT</a></li>
    <li><img /><a href="/ats/connectors/erecruiter">eRecruiter</a></li>
    <li><img /><a href="/ats/connectors/abacusumantis">Abacus Umantis</a></li>
    <li><img /><a href="/ats/connectors/umantis">Haufe Umantis</a></li>
    <li><img /><a href="/ats/connectors/jobylon">Jobylon</a></li>
    <li><img /><a href="/ats/connectors/taleez">Taleez</a></li>
    <li><img /><a href="/ats/connectors/hrworks">HR WORKS</a></li>
    <li><img /><a href="/ats/connectors/otys">OTYS</a></li>
    <li><img /><a href="/ats/connectors/zohorecruit">Zoho Recruit</a></li>
    <li><img /><a href="/ats/connectors/ceipal">Ceipal</a></li>
    <li><img /><a href="/ats/connectors/eploy">Eploy</a></li>
    <li><img /><a href="/ats/connectors/jobdiva">JobDiva</a></li>
    <li><img /><a href="/ats/connectors/careerplug">CareerPlug</a></li>
    <li><img /><a href="/ats/connectors/perview">Perview</a></li>
    <li><img /><a href="/ats/connectors/eightfold">Eightfold</a></li>
    <li><img /><a href="/ats/connectors/paycor">Paycor</a></li>
    <li><img /><a href="/ats/connectors/avature">Avature</a></li>
    <li><img /><a href="/ats/connectors/apploi">Apploi</a></li>
    <li><img /><a href="/ats/connectors/phenom">Phenom</a></li>
    <li><img /><a href="/ats/connectors/paradox">Paradox</a></li>
    <li><img /><a href="/ats/connectors/heyrecruit">Heyrecruit</a></li>
    <li><img /><a href="/ats/connectors/recruhr">RECRU</a></li>
    <li><img /><a href="/ats/connectors/recruitcrm">Recruit CRM</a></li>
    <li><img /><a href="/ats/connectors/jazzhr">JazzHR</a></li>
    <li><img /><a href="/ats/connectors/bite">BITE</a></li>
    <li><img /><a href="/ats/connectors/brassring">Brass Ring</a></li>
    <li><img /><a href="/ats/connectors/homerun">Homerun</a></li>
    <li><img /><a href="/ats/connectors/mysolution">Mysolution</a></li>
    <li><img /><a href="/ats/connectors/carerix">Carerix</a></li>
    <li><img /><a href="/ats/connectors/carerixgraphql">Carerix (GraphQL)</a></li>
    <li><img /><a href="/ats/connectors/hroffice">HR Office</a></li>
    <li><img /><a href="/ats/connectors/talentclue">Talent Clue</a></li>
    <li><img /><a href="/ats/connectors/inrecruiting">InRecruiting by Zucchetti</a></li>
    <li><img /><a href="/ats/connectors/jobadder">JobAdder</a></li>
    <li><img /><a href="/ats/connectors/ubeeo">Ubeeo</a></li>
    <li><img /><a href="/ats/connectors/connexys">Connexys By Bullhorn</a></li>
    <li><img /><a href="/ats/connectors/hr4you">HR4YOU</a></li>
    <li><img /><a href="/ats/connectors/cornerstoneondemand">Cornerstone OnDemand</a></li>
    <li><img /><a href="/ats/connectors/zvooverecruit">Zvoove Recruit</a></li>
    <li><img /><a href="/ats/connectors/odoo">Odoo</a></li>
    <li><img /><a href="/ats/connectors/comeet">Spark Hire Recruit</a></li>
    <li><img /><a href="/ats/connectors/compleetpitcher">Compleet (Pitcher API)</a></li>
    <li><img /><a href="/ats/connectors/compleet">Compleet (only PersoProfiler)</a></li>
    <li><img /><a href="/ats/connectors/gem">Gem</a></li>
    <li><img /><a href="/ats/connectors/laura">Laura</a></li>
    <li><img /><a href="/ats/connectors/covetorest">Coveto (REST API)</a></li>
    <li><img /><a href="/ats/connectors/coveto">Coveto (legacy SOAP API)</a></li>
    <li><img /><a href="/ats/connectors/mercury">Mercury</a></li>
    <li><img /><a href="/ats/connectors/crelate">Crelate</a></li>
    <li><img /><a href="/ats/connectors/manatal">Manatal</a></li>
    <li><img /><a href="/ats/connectors/avionte">Avionté</a></li>
    <li><img /><a href="/ats/connectors/mhmhr">MHM HR</a></li>
    <li><img /><a href="/ats/connectors/asymbl">Asymbl</a></li>
    <li><img /><a href="/ats/connectors/breezyhr">Breezy HR</a></li>
    <li><img /><a href="/ats/connectors/flatchr">Flatchr</a></li>
    <li><img /><a href="/ats/connectors/dayforce">Dayforce</a></li>
    <li><img /><a href="/ats/connectors/digitalrecruiters">Digital Recruiters</a></li>
    <li><img /><a href="/ats/connectors/applicantstack">ApplicantStack</a></li>
    <li><img /><a href="/ats/connectors/reachmee">ReachMee</a></li>
    <li><img /><a href="/ats/connectors/talentadore">TalentAdore</a></li>
    <li><img /><a href="/ats/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/ats/connectors/guidecom">GuideCom</a></li>
    <li><img /><a href="/ats/connectors/spott">Spott</a></li>
    <li><img /><a href="/ats/connectors/logicmelon">Logic Melon</a></li>
    <li><img /><a href="/ats/connectors/loxo">Loxo</a></li>
    <li><img /><a href="/ats/connectors/kula">Kula</a></li>
    <li><img /><a href="/ats/connectors/trackerrms">TrackerRMS</a></li>
    <li><img /><a href="/ats/connectors/databites">Databites</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Visit our in-depth guides to learn more about:

* 🌐 [Setting the source of the application](/ats/features/implementation-guide/creating-applications#set-the-source-of-the-application)
* 📎 [Uploading attachments with the application](/ats/features/implementation-guide/creating-applications#upload-attachments-with-the-application)
* ♻️ [Retry behaviour](/ats/features/implementation-guide/creating-applications#retry-behaviour)
* ✏️ [Writing answers to screening questions](/ats/features/implementation-guide/creating-applications#write-answers-to-screening-questions)
* ⚠️ [Handling ATS-specific limitations](/ats/features/implementation-guide/creating-applications#handle-ats-specific-limitations)

<Note>
  This endpoint requires the permission **Create applications and candidates** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "candidate": {
    "first_name": "Frank",
    "last_name": "Doe",
    "company": "Acme Inc.",
    "title": "Head of Integrations",
    "email_address": "frank.doe@example.com",
    "phone_number": "+1-541-754-3010",
    "gender": "MALE",
    "salary_expectations": {
      "amount": 100000,
      "period": "YEAR"
    },
    "availability_date": "2021-01-01",
    "location": {
      "city": "New York",
      "zip_code": "10016",
      "state": "NY",
      "country": "US"
    }
  },
  "stage_id": "8x3YKRDcuRnwShdh96ShBNn1",
  "attachments": [
    {
      "name": "Frank Doe CV.txt",
      "data": "SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=",
      "type": "CV",
      "content_type": "text/plain"
    }
  ],
  "screening_question_answers": [
    {
      "question_id": "3phFBNXRweGnDmsU9o2vdPuQ",
      "answer": "Yes"
    },
    {
      "question_id": "EYJjhMQT3LtVKXnTbnRT8s6U",
      "answer": [
        "GUzE666zfyjeoCJX6A8n7wh6",
        "5WPHzzKAv8cx97KtHRUV96U8",
        "7yZfKGzWigXxxRTygqAfHvyE"
      ]
    }
  ],
  "remote_fields": {}
}
```


# Send passthrough request
Source: https://docs.kombo.dev/ats/v1/post-passthrough-tool-api

POST /passthrough/{tool}/{api}
Send a request to the specified integration's native API.

At Kombo we put a lot of work into making sure that our unified API covers all our customers' use cases and that they never have to think about integration-specific logic again. There are cases, however, where our customers want to build features that are very integration-specific. That's where this endpoint comes in.

Pass in details about the request you want to make to the integration's API and we'll forward it for you. We'll also take care of setting the right base URL and authenticating your requests.

To get started, please pick the relevant API (some tools provide multiple to due different base URLs or authentication schemes) from the table below and pass in the `{tool}/{api}` identifier as part of the path.

| Integration                  | `{tool}/{api}`                     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| ---------------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| 360Learning                  | `360learning/v2`                   | 360Learning [API v2](https://360learning.readme.io/docs). We automatically handle authentication and use `https://app.360learning.com/api/v2/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| a3innuva Nómina              | `a3innuvanomina/laboral`           | a3innuva Nómina API [docs](https://a3developers.wolterskluwer.es/). Requests are automatically authenticated using OAuth access tokens (refreshed when needed). Base URL: `https://a3api.wolterskluwer.es/Laboral/api`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Abacus Umantis               | `abacusumantis/v1`                 | [Umantis API v1](https://recruitingapp-91005709.umantis.com/api/v1/swagger-ui). We automatically authenticate all requests and use `https://\{subdomain\}.umantis.com/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Abacus                       | `abacus/api`                       | Abacus [REST API](https://apihub.abacus.ch/). We automatically authenticate all requests and use `https://\{\{abacusUrl\}\}/api/entity/v1/mandants/\{\{mandantId\}\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Absence.io                   | `absenceio/v2`                     | Absence.io [API](https://docs.absence.io/). We automatically authenticate all requests and use `https://app.absence.io/api/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| ADP Decidium                 | `adpdecidium/default`              | [ADP Decidium API](https://developers.adp.com/apis/api-explorer/hcm-offrg-dge). We automatically authenticate all requests and use `https://api.eu.adp.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| ADP Workforce Now            | `adpworkforcenow/default`          | [ADP Workforce Now API v2](https://developers.adp.com/build/api-explorer/hcm-offrg-wfn). We automatically authenticate all requests and use the correct subdomain.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| AFAS Software                | `afas/api`                         | AFAS' [API](https://connect.afas.nl/rest/get). We automatically authenticate all requests and use `https://\{domain\}/ProfitRestServices` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| AlexisHR                     | `alexishr/v1`                      | [AlexisHR's v1 API](https://docs.alexishr.com/) We automatically authenticate all requests and use `https://\{subdomain\}.alexishr.com` as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| ApplicantStack               | `applicantstack/api`               | ApplicantStack's [API](https://helpas.payrollservers.info/s/article/API-Integration-Guide). We automatically authenticate all requests and use `https://\{subdomain\}.applicantstack.com/api/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Apploi                       | `apploi/rest-api`                  | The [Apploi API](https://integrate.apploi.com/). We automatically authenticate all requests and use `https://partners.apploi.com/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Ashby                        | `ashby/v1`                         | Ashby's [V1 API](https://developers.ashbyhq.com/reference/introduction). We automatically authenticate all requests with the provided credentials and use `https://api.ashbyhq.com` as the base URL. Please note that Ashby uses an RPC-style API. Please check [the Ashby API documentation](https://developers.ashbyhq.com/reference/introduction) for details on how to use it.                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| Asymbl                       | `asymbl/v63`                       | We use `https://\{subdomain\}.my.salesforce.com` as the base URL. Find the official docs [here](https://asymblinc.github.io/ats/ats.html).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Avature                      | `avature/custom-api`               | Avatures's Custom API. Call `Get /openapi` to retrieve the specific custom API schema. We automatically authenticate all requests and use the instance specific custom API URL as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Avionté                      | `avionte/front-office-v1`          | Avionte's API. We automatically authenticate all requests and use `https://api.avionte.com/front-office/v1` as the base URL. Documentation for the BOLD Front Office API: [https://developer.avionte.com/reference/get-all-talent-tags](https://developer.avionte.com/reference/get-all-talent-tags)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| BambooHR                     | `bamboohr/v1`                      | BambooHR's [API](https://documentation.bamboohr.com/reference/get-employee). We automatically authenticate all requests using the customer credentials `https://api.bamboohr.com/api/gateway.php/\{subdomain\}/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| BITE                         | `bite/v1`                          | [Bite's v1 API](https://api.b-ite.io/docs/#/). We automatically authenticate all requests and use your configured API base URL with `/v1` appended (default `https://api.b-ite.io/v1`).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| BoondManager                 | `boondmanager/api`                 | BoondManager [REST API](https://ui.boondmanager.com/administrator/developer/apisandbox). We automatically authenticate all requests and use `https://ui.boondmanager.com/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Breezy HR                    | `breezyhr/v3`                      | [BreezyHR's v3 API](https://developer.breezy.hr/reference/overview). We automatically authenticate all requests and use "[https://api.breezy.hr/v3/](https://api.breezy.hr/v3/)" as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| Bullhorn for Salesforce      | `bullhorn4salesforce/v66`          | We use `https://\{subdomain\}.my.salesforce.com/services/data/v66.0` as the base URL. Find the official docs [here](https://kb.bullhorn.com/bh4sf/Content/BH4SF/Topics/bh4sfRestAPI.htm).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Bullhorn                     | `bullhorn/default`                 | [Bullhorn's API](https://bullhorn.github.io/rest-api-docs/index.html). We automatically use the right `https://\{subdomain\}.bullhornstaffing.com/rest-services/\{corpToken\}` base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| CareerPlug                   | `careerplug/api`                   | We use `https://api.careerplug.com` as the base URL. Find the official docs [here](https://api.careerplug.com/docs#api).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Carerix                      | `carerix/api`                      | Carerix [REST API](https://docs.carerix.io/rest/introduction). We automatically authenticate all requests and use `https://api.carerix.com` as the base URL. Please note that Carerix uses XML for request and response bodies.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Carerix                      | `carerixgraphql/graphql`           | Carerix [GraphQL API](https://docs.carerix.io/graphql/welcome). We automatically authenticate all requests (OAuth2 client credentials) and use `https://api.carerix.io/graphql/v1` as the base URL. Send GraphQL requests as `POST /graphql` with a JSON body of `\{ "query": "...", "variables": \{ ... \} \}`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| CEGID TalentSoft Customer    | `talentsoftcustomer/v1`            | Cegid Talentsoft Recruiting FrontOffice API: [API Documentation](https://developers.cegid.com/api-details#api=cegid-talentsoft-recruiting-frontoffice) We automatically authenticate all requests and use `https://\{customer_subdomain\}.talent-soft.com/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| CEGID TalentSoft FrontOffice | `talentsoft/v2`                    | Cegid Talentsoft Recruiting FrontOffice [API](https://developers.cegid.com/api-details). We automatically authenticate all requests using the provided credentials and use `https://\{domain\}/api/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Ceipal                       | `ceipal/v1`                        | We use `https://api.ceipal.com/v1` as the base URL. Find the official docs [here](https://developer.ceipal.com/ceipal-ats-version-one/ceipal-ats-v1-api-reference).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Cezanne HR                   | `cezannehr/dataservice`            | [CezanneHR's v7 dataservice API](https://api.cezannehr.com/).We automatically authenticate all requests and use the base URL `https://\{subdomain\}.cezanneondemand.com/cezanneondemand/v7/dataservice.svc`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Compleet (Persy)             | `compleetpersy/api`                | Compleet Persy [REST API](https://persy-api.refined.site/space/PAPI/450166808/Requirements+Jobfeed+%2F+Anforderungen+f%C3%BCr+Jobfeeds). We automatically authenticate all requests and use `https://www.germanpersonnel.de/persy/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Compleet                     | `compleetpitcher/pitcher`          | Compleet's Pitcher API. We automatically authenticate all requests and use the configured base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Connexys By Bullhorn         | `connexys/api`                     | [Connexy's API](https://api.conexsys.com/client/v2/docs/#section/Overview). We automatically authenticate all requests and use `https://\{connexys_domain\}/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Cornerstone OnDemand         | `cornerstoneondemand/core-hr`      | Cornerstone's [Core HR API](https://csod.dev/reference/core-hr/). We automatically authenticate all requests using the client ID and secret and use `https://\{your_domain\}.csod.com/services/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Cornerstone OnDemand         | `cornerstoneondemand/learning`     | Cornerstone's [Learning API](https://csod.dev/reference/learning/). We automatically authenticate all requests using the client ID and secret and use `https://\{your_domain\}.csod.com/services/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Cornerstone OnDemand         | `cornerstoneondemand/recruiting`   | Cornerstone's [Recruiting API](https://csod.dev/reference/recruiting/). We automatically authenticate all requests using the client ID and secret and use `https://\{your_domain\}.csod.com/services/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Cornerstone TalentLink       | `cornerstonetalentlink/apply`      | Cornerstone TalentLink's Apply API. We automatically authenticate all requests using the provided credentials and API key, and use `https://apiproxy.shared.lumessetalentlink.com/apply` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Cornerstone TalentLink       | `cornerstonetalentlink/rest`       | Cornerstone TalentLink's [REST API](https://developer.lumesse-talenthub.com/rest-api-developers-guide/1.21.33/index.html?page=rest-api\&subpage=introduction). We automatically authenticate all requests using the provided credentials and API key, and use `https://apiproxy.shared.lumessetalentlink.com/tlk/rest` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Coursera                     | `coursera/v1`                      | We use `https://api.coursera.com/ent` as the base URL. Find the official docs [here](https://dev.coursera.com).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Coveto (legacy SOAP API)     | `coveto/public`                    | We automatically use `https://\{subdomain\}.coveto.de` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Coveto (REST API)            | `covetorest/v1`                    | We automatically use `https://\{subdomain\}.coveto.de/public/api/v1` as the base URL. [https://demo.coveto.de/swagger-ui/index.html#/](https://demo.coveto.de/swagger-ui/index.html#/)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Crelate                      | `crelate/api`                      | Crelate [REST API](https://app.crelate.com/api3/docs/index.html). We automatically authenticate all requests and use `https://app.crelate.com/api3` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| d.vinci admin                | `dvinciadmin/odata-api`            | [DVinci ODATA API](https://dvinci.freshdesk.com/en/support/solutions/articles/75000059523-odata-reporting-api).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| d.vinci admin                | `dvinciadmin/rest-api`             | [DVinci REST API](https://static.dvinci-easy.com/files/d.vinci%20rest-api.html).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| d.vinci                      | `dvinci/apply-api`                 | The [DVinci Apply API](https://static.dvinci-easy.com/files/d.vinci%20application-apply-api.html). All requests are authenticated by Kombo and use `https://\{dvinci_domain\}/p/\{portal_path\}/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| d.vinci                      | `dvinci/rest-api`                  | The [DVinci REST API](https://static.dvinci-easy.com/files/d.vinci%20rest-api.html). All requests are authenticated by Kombo and use `https://\{dvinci_domain\}/restApi/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Databites                    | `databites/v1`                     | We use `https://\{subdomain\}.databites.de` as the base URL. Find the official docs [here](https://\{subdomain}.databites.de/api-dokumentationen/public-integrations/index).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| DATEV LODAS                  | `datev/eau`                        | DATEV's [eau](https://developer.datev.de/en/product-detail/eau-api/1.0.0/overview) API. We automatically authenticate all requests and use \`[https://eau.api.datev.de/\\\{platform](https://eau.api.datev.de/\\\{platform)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | platform-sandbox}/v1/clients/\{client-id}/\` as the base URL. |
| DATEV                        | `datevhr/eau`                      | DATEV's [eau](https://developer.datev.de/en/product-detail/eau-api/1.0.0/overview) API. We automatically authenticate all requests and use \`[https://eau.api.datev.de/\\\{platform](https://eau.api.datev.de/\\\{platform)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | platform-sandbox}/v1/clients/\{client-id}/\` as the base URL. |
| DATEV                        | `datevhr/hr-exports`               | DATEV's [hr-exports](https://developer.datev.de/en/product-detail/hr-exports/1.0.0/overview). We automatically authenticate all requests and use \`[https://hr-exports.api.datev.de/\\\{platform](https://hr-exports.api.datev.de/\\\{platform)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | platform-sandbox}/v1/clients/\{client-id}\` as the base URL.  |
| DATEV                        | `datevhr/hr:payrollreports`        | DATEV's [hr:payrollreports](https://developer.datev.de/en/product-detail/hr-payrollreports/2.0.0/overview) API. We automatically authenticate all requests and use \`[https://hr-payrollreports.api.datev.de/\\\{platform](https://hr-payrollreports.api.datev.de/\\\{platform)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | platform-sandbox}/v1/clients/\{client-id}/\` as the base URL. |
| DATEV                        | `datevlauds/lauds`                 | DATEV's [hr-exchange](https://developer.datev.de/de/product-detail/hr-exchange/1.0.0/overview). We automatically authenticate all requests and use \`[https://hr-exchange.api.datev.de/\\\{platform](https://hr-exchange.api.datev.de/\\\{platform)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | platform-sandbox}/v1/clients/\{client-id}\` as the base URL.  |
| Dayforce                     | `dayforce/V1`                      | [Dayforce's API](https://developers.dayforce.com/Build/Home.aspx). We automatically authenticate all requests and use `\{\{baseUrl\}\}/Api/\{\{clientNamespace\}\}/V1` as the base URL                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Deel                         | `deel/api`                         | Deel's [API](https://developer.deel.com/reference/). We automatically authenticate all requests using the provided credentials and use `https://\{api_domain\}/rest` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                               |
| Digital Recruiters           | `digitalrecruiters/api`            | Cegid Digital Recruiters [Talent Acquisition API](https://cegid-hr-developers.talentsoft.net/docs/tutorial-basics/Talent%20Acquisition/Getting%20Started). We automatically authenticate all requests by replacing `:token` in the request URL with your configured access token and use your configured Digital Recruiters domain as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Docebo                       | `docebo/api`                       | Docebo [API](https://developer.docebo.com). We automatically handle authentication and use `https://\{subdomain\}.docebosaas.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| Eightfold                    | `eightfold/api`                    | Eightfold's [API](https://apidocs.eightfold.ai/). We automatically authenticate all requests and use  `https://apiv2.\{region\}/api/v2/core/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Employment Hero              | `employmenthero/default`           | EmploymentHero [API](https://developer.employmenthero.com/api-references/#icon-book-open-introduction). We automatically authenticate all requests using the credentials supplied by the customer and use `https://api.employmenthero.com/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Eploy                        | `eploy/api`                        | Eploy's [API](https://www.eploy.com/resources/developers/api-documentation/). We automatically authenticate all requests. The base URL is `https://\{hostname\}/api`, where `\{hostname\}` is either `\{subdomain\}.eploy.net` or your full custom hostname when applicable.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| eRecruiter                   | `erecruiter/api`                   | [eRecruiter's API](https://api.erecruiter.net/swagger/ui/index). We automatically authenticate all requests and use `https://\{domain\}/Api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Eurécia                      | `eurecia/api`                      | Eurécia [REST API](https://api.eurecia.com/eurecia/fw/swagger/index.html#/) We automatically authenticate all requests and use `https://\{domain\}/eurecia/rest` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| Factorial                    | `factorial/api`                    | Factorial's [API](https://apidoc.factorialhr.com/). We automatically authenticate all requests and use `https://api.factorialhr.com/api` or `https://api.demo.factorial.dev/api` as the base URL, depending on the connected instance.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Flatchr                      | `flatchr/api`                      | Flatchr's [API](https://developers.flatchr.io/docs/getting_started). We automatically authenticate all requests and use `https://api.flatchr.io` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| Flatchr                      | `flatchr/career`                   | Flatchr's [Career API](https://developers.flatchr.io/docs/QuickStart/Candidats/Creer_un_candidat). We automatically authenticate all requests and use `https://career.flatchr.io` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| Fountain                     | `fountain/v2`                      | Fountain's [Hire API](https://developer.fountain.com/reference/get_v2-applicants). We automatically authenticate all requests. The base URL depends on how the integration is connected: Fountain One (OAuth) requests go to `https://services.fountain.com/api/servicehire/v2`, while legacy API-key requests go to `https://\{subdomain\}.fountain.com/api/v2`.                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| Fourth                       | `fourth/uk-employee`               | Fourth [UK Employee API](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference) We automatically authenticate all requests and use `https://api.fourth.com/hr/organisations/\{organisation_id\}/` as the base URL. We also enforce the required query params for all requests.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Gem                          | `gem/api`                          | Gem's [ATS API](https://api.gem.com/ats/v0/reference) We automatically authenticate all requests and use `https://api.gem.com/ats/v0` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Google Workspace             | `googleworkspace/admin`            | [Googles's API](https://developers.google.com/admin-sdk/directory/reference/rest). We automatically authenticate all requests and use '[https://admin.googleapis.com](https://admin.googleapis.com)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                               |
| Google Workspace             | `googleworkspace/people`           | [Googles's API](https://developers.google.com/people/api/rest). We automatically authenticate all requests and use '[https://people.googleapis.com](https://people.googleapis.com)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Greenhouse (V1)              | `greenhouse/harvest-v2`            | Greenhouse [Harvest API v2](https://developers.greenhouse.io/harvest.html). We automatically authenticate all requests using the API key and use `https://harvest.greenhouse.io/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Greenhouse (V1)              | `greenhouse/harvest`               | Greenhouse [Harvest API v1](https://developers.greenhouse.io/harvest.html). We automatically authenticate all requests using the API key and use `https://harvest.greenhouse.io/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Greenhouse (V3)              | `greenhousev3/harvestv3`           | We use `https://harvest.greenhouse.io/v3` as the base URL. Find the official docs [here](https://harvestdocs.greenhouse.io/reference/).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Greenhouse Job Board         | `greenhousejobboard/boards-api`    | [Greenhouse Job Board API](https://developers.greenhouse.io/job-board). We automatically authenticate all requests and use '[https://boards-api.greenhouse.io/v1/boards/\\\{job\_board\_token\\}](https://boards-api.greenhouse.io/v1/boards/\\\{job_board_token\\})' as the base URL. Optionally, you can provide a custom job\_board\_token to use a different job board.                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Greenhouse                   | `greenhouse/harvest-v2`            | Greenhouse [Harvest API v2](https://developers.greenhouse.io/harvest.html). We automatically authenticate all requests using the API key and use `https://harvest.greenhouse.io/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Greenhouse                   | `greenhouse/harvest`               | Greenhouse [Harvest API v1](https://developers.greenhouse.io/harvest.html). We automatically authenticate all requests using the API key and use `https://harvest.greenhouse.io/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Greenhouse                   | `greenhouse/harvestv3`             | We use `https://harvest.greenhouse.io/v3` as the base URL. Find the official docs [here](https://harvestdocs.greenhouse.io/reference/).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| GuideCom                     | `guidecom/api`                     | GuideCom's API. We automatically authenticate all requests and use the configured API base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Gusto                        | `gusto/v1`                         | [Gusto API](https://docs.gusto.com/app-integrations/docs/introduction). We automatically authenticate all requests with OAuth and use `\{api_base_url\}/v1` as the base URL (`https://api.gusto.com/v1` in production, `https://api.gusto-demo.com/v1` in development).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Hailey HR                    | `haileyhr/api`                     | Hailey HR's [API](https://api.haileyhr.app/docs/index.html). We automatically authenticate all requests using the provided credentials and use `https://api.haileyhr.app` as the base URL. Connections created against the `DEMO` remote environment are routed to `https://api.demo.haileyhr.app` instead.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Hansalog                     | `hansalog/vision`                  | Hansalog's [Vision API](https://hansalog-vision.document360.io/docs/). We automatically authenticate all requests and use `https://\{subdomain\}.hansalog-cloud.de/vision` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Haufe Umantis                | `umantis/v1`                       | [Umantis API v1](https://recruitingapp-91005709.umantis.com/api/v1/swagger-ui). We automatically authenticate all requests and use `https://\{subdomain\}.umantis.com/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| HeavenHR                     | `heavenhr/v2`                      | [HeavenHR API](https://api.heavenhr.com/). We automatically authenticate all requests using the provided credentials and use `https://api.heavenhr.com/api/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Heyrecruit                   | `heyrecruit/v2`                    | [Heyrecruit's v2 API](https://documenter.getpostman.com/view/23241256/2s9YysBLcf#47e271ac-47c8-4c75-9cc6-b8c506e9dad6). We automatically authenticate all requests using the client ID and secret and use `https://app.heyrecruit.de/api/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| HiBob                        | `hibob/docs`                       | This passthrough is only used for fetching employee documents in HiBob. It is present as a workaround while we are working on a new endpoint for fetching documents in HRIS. It should not be used for any other purpose. We automatically authenticate all requests using the service user credentials and use `https://app.hibob.com/api/docs/employees/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| HiBob                        | `hibob/hire`                       | [HiBob's Hire API](https://apidocs.hibob.com/docs/how-to-integrate-with-ats-hire-api). We automatically authenticate all requests using the hire service user credentials. The base URL is configured during the integration setup.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| HiBob                        | `hibob/v1`                         | [HiBob's v1 API](https://apidocs.hibob.com/reference/get_people). We automatically authenticate all requests using the service user credentials (or, for old integrations, the API key) and use `https://api.hibob.com/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| HoorayHR                     | `hoorayhr/api`                     | [HoorayHR API](https://api.hoorayhr.io/documentation/). We automatically authenticate all requests and use `https://api.hoorayhr.io` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                               |
| HR Office                    | `hroffice/soap`                    | [HROffice SOAP API](https://api.hroffice.nl/HROfficeCoreService.asmx). We automatically authenticate all requests and wrap them in a SOAP envelope. Build the request `Body` with the raw XML parameters for your operation (e.g., `\<languageId\>1\</languageId\>`). Use `/` as your `path`. Set your `method` to `POST`. You need to specify the `api_options` object and set `operation_name` to the SOAP operation you want to call (e.g., `GetAllJobByLanguage`).                                                                                                                                                                                                                                                                                                                                              |                                                               |
| HR WORKS                     | `hrworks/v2`                       | HRWorks's v2 [API](https://developers.hrworks.de/2.0/endpoints). We automatically authenticate all requests using the customer credentials.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| HR4YOU                       | `hr4you/v2`                        | [HR4YOU's v2 API](https://apiprodemo.hr4you.org/api2/docs). We automatically authenticate all requests and use the customers provided base URL (e.g. `https://your-company.hr4you.org/` or a custom domain).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Humaans                      | `humaans/api`                      | Humaans' [API](https://docs.humaans.io/api/). We automatically authenticate all requests using the API key and use `https://app.humaans.io/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| iCIMS                        | `icims/default`                    | [iCIMS Default API](https://developer-community.icims.com/). We automatically authenticate all requests and use `https://api.icims.com/customers/\{customer_id\}` as the base url.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| InRecruiting by Zucchetti    | `inrecruiting/default`             | [inRecruiting's v3 API](https://inrecruiting.intervieweb.it/api-docs/). We automatically authenticate all requests and use the customers domain as base URL                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Insperity                    | `insperity/api`                    | Insperity [APIs](https://developer.insperity.com/) We automatically authenticate all requests and use `https://api.insperity.com` as the base URL. For staging environments, we use `https://apistage.insperity.com`. Note that all requests require the company ID to be specified in the path or body.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| IRIS Cascade                 | `iriscascade/v2`                   | IRIS Cascade HR [API](https://swagger.hrapi.co.uk/). We automatically authenticate all requests using the provided credentials and use `https://api.iris.co.uk/hr/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| JazzHR                       | `jazzhr/v1`                        | [JazzHR's v1 API](https://www.resumatorapi.com/v1/#!`).We automatically authenticate all requests and use "[https://api.resumatorapi.com/v1/](https://api.resumatorapi.com/v1/)" as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| JobAdder                     | `jobadder/api`                     | We use `https://api.jobadder.com/v2` as the base URL. Find the official docs [here](https://api.jobadder.com/v2/docs).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| JobDiva                      | `jobdiva/api`                      | We automatically authenticate all requests and use `https://api.jobdiva.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Jobvite                      | `jobvite/api`                      | We automatically authenticate all requests and use '[https://api.jobvite.com/api/v2](https://api.jobvite.com/api/v2)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Jobvite                      | `jobvite/v2`                       | We use `https://api.jobvite.com/api/v2` as the base URL. Find the official docs [here](https://help.jobvite.com/hc/en-us/articles/8870636608925-Jobvite-API).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Jobylon                      | `jobylon/feed`                     | The [Jobylon Feed API](https://developer.jobylon.com/feed-api/). We automatically authenticate all requests and use `https://\{subdomain\}.jobylon.com/feeds/\{job_hash\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Jobylon                      | `jobylon/push`                     | The [Jobylon Push API](https://developer.jobylon.com/push-api-and-webhooks/). We automatically authenticate all requests and use `https://\{subdomain\}.jobylon.com/p1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| JOIN                         | `join/v2`                          | Join's [V2 API](https://docs.join.com/reference/getting-started). We automatically authenticate all requests and use `https://api.join.com/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Kenjo                        | `kenjo/api`                        | Kenjo's [API](https://kenjo.readme.io/reference/generate-the-api-key). We automatically authenticate all requests using the API key. The base URL is `https://api.kenjo.io/` (or `https://sandbox-api.kenjo.io/` for sandbox environments).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Kula                         | `kula/v1`                          | Kula's [REST API](https://developers.kula.ai/docs/getting-started/overview). We automatically authenticate all requests with the provided credentials and use `https://api.kula.ai/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Lattice Talent               | `latticetalent/talent`             | Lattice's [Talent API](https://developers.lattice.com/reference/introduction). We automatically authenticate all requests using API key credentials with `https://api.latticehq.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                               |
| Lattice                      | `lattice/passthrough`              | Lattice's [API](https://developers.lattice.com/v2/docs/base-url-1). We automatically authenticate all requests using OAuth credentials with `https://api.latticehq.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Lattice                      | `lattice/talent`                   | Lattice's [Talent API](https://developers.lattice.com/docs/introduction-1). We automatically authenticate all requests using OAuth credentials with `https://api.latticehq.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| Laura                        | `laura/api`                        | We automatically authenticate all requests and use `https://\{subdomain\}.rekrytointi.com/api/v1.2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Leapsome                     | `leapsome/scim`                    | Leapsome [SCIM API](https://api.leapsome.com/scim/v1/api-docs/). We automatically authenticate all requests using the credentials supplied by the customer and use `https://api.leapsome.com/scim/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Leapsome                     | `leapsome/v1`                      | Leapsome [API](https://api.leapsome.com/v1/api-docs/). We automatically authenticate all requests using the credentials supplied by the customer and use `https://api.leapsome.com/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Lever                        | `lever/v1`                         | [Lever's v1 API](https://hire.lever.co/developer/documentation). We automatically authenticate all requests using the partner credentials which have been configured in the Lever tool settings (this uses Kombo's partner credentials by default).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| LinkedIn Learning            | `linkedinlearning/v2`              | LinkedIn Learning [API v2](https://learn.microsoft.com/en-us/linkedin/learning/).  We automatically handle authentication and use `https://api.linkedin.com/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| Logic Melon                  | `logicmelon/json`                  | We use `https://api.logicmelon.co.uk` as the base URL. Find the official docs [here](https://api.logicmelon.com/JSON/Multiposter.asmx).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Loket                        | `loket/api`                        | [Loket's REST API](https://developers.loket.nl/). We automatically authenticate all requests and use `https://\{api_domain\}` as the base URL, where `api_domain` is the API domain configured during integration setup (e.g. `api.loket.nl`).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Loxo                         | `loxo/v1`                          | [Loxo's API](https://loxo.readme.io/reference/loxo-api). We automatically authenticate all requests and use '[https://app.loxo.co/api/\\\{agency\_slug\\}](https://app.loxo.co/api/\\\{agency_slug\\})' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Lucca                        | `lucca/api`                        | [Luccas's API](https://developers.lucca.fr/api-reference/legacy/introduction). We automatically authenticate all requests and use 'https\://\{account}.\{ilucca                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | ilucca-demo}.\{region}/' as the base URL.                     |
| Manatal                      | `manatal/career-page`              | Manatal's Career Page API. We use `https://api.manatal.com/open/v3/career-page/\{client_slug\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| Manatal                      | `manatal/open-api-v3`              | [Manatal's Open API v3](https://developers.manatal.com/reference/getting-started). We automatically authenticate all requests and use `https://api.manatal.com/open/v3` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Mercury                      | `mercury/v1`                       | Mercury's [V1 API](https://apim-uks-thirdpartyintegration-prod.azure-api.net/swagger/index.html?urls.primaryName=V1). We automatically authenticate all requests with the `subscription-key` and `tenant-id` headers and use the configured server URL with `/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Mercury                      | `mercury/v2`                       | Mercury's [V2 API](https://apim-uks-thirdpartyintegration-prod.azure-api.net/swagger/index.html?urls.primaryName=V2). We automatically authenticate all requests with the `subscription-key` and `tenant-id` headers and use the configured server URL with `/api/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Mercury                      | `mercury/v3`                       | Mercury's [V3 API](https://apim-uks-thirdpartyintegration-prod.azure-api.net/swagger/index.html?urls.primaryName=V3). We automatically authenticate all requests with the `subscription-key` and `tenant-id` headers and use the configured server URL with `/api/v3` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| MHR People First             | `peoplefirst/v1`                   | MHR People First [v1 API](https://docs.people-first.com/api/api-docs/api-docs.html). We automatically authenticate all requests using the access token and tenant/environment codes. For default environments, we use `https://\{tenant_code\}.people-first.com/api/v1` as the base URL. For non-default environments, we use `https://\{tenant_code\}-\{environment_code\}.people-first.com/api/v1`.                                                                                                                                                                                                                                                                                                                                                                                                               |                                                               |
| Microsoft Azure AD           | `azuread/v1`                       | [AzureAD's API](https://learn.microsoft.com/en-us/graph/api/resources/identity-network-access-overview?view=graph-rest-1.0). We automatically authenticate all requests.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Microsoft Entra ID           | `entraid/v1`                       | [AzureAD's API](https://learn.microsoft.com/en-us/graph/api/resources/identity-network-access-overview?view=graph-rest-1.0). We automatically authenticate all requests.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Moodle                       | `moodle/rest`                      | Moodle REST Web Services API. All calls go to `/webservice/rest/server.php` with `wsfunction` and `wstoken` parameters. We automatically handle authentication and use `\{site_url\}/webservice/rest/server.php` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| Mysolution                   | `mysolution/default`               | [Mysolution's API](https://swagger.mysolution.nl/). We automatically authenticate all requests and use the customer's domain as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Nmbrs                        | `nmbrs/soap`                       | [Nmbrs SOAP API](https://api.nmbrs.nl/soap/v3/). We automatically authenticate all requests and use `https://api.nmbrs.nl/soap/v3/` as the base URL. Set `data` to your raw XML string (the content that will be placed inside the `\<soap:Body\>` tag). Use `/` as your `path`, as we will always send requests to `https://api.nmbrs.nl/soap/v3/\{service_name\}.asmx`. Set your `method` to `POST`. You need to specify the `api_options` object and set `service_name` to the name of the service you want to call. Available services include `EmployeeService` and `CompanyService`.                                                                                                                                                                                                                          |                                                               |
| Odoo                         | `odoo/json2`                       | Odoo's [JSON-2 API](https://www.odoo.com/documentation/19.0/developer/reference/external_api.html). We automatically authenticate all requests and use `https://\{domain\}.odoo.com/json/2` as the base URL. Odoo JSON-2 requests are always `POST` requests and use paths like `/\{model\}/\{method\}` (e.g. `/res.partner/search_read`).                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Okta                         | `okta/v1`                          | [Okta's API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/ApiServiceIntegrations/). We automatically authenticate all request ans use 'https\://\<your-okta-domain>/api/v1' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Onlyfy                       | `onlyfy/v1`                        | Onlyfy's [Public v1 REST API](https://onlyfy.io/doc/v1#section/Introduction). We automatically authenticate all requests using the `apikey` header and use `https://api.prescreenapp.io/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Oracle HCM                   | `oraclehcm/api`                    | Oracle HCM Cloud [REST API](https://docs.oracle.com/en/cloud/saas/human-resources/24d/farws/index.html). We automatically authenticate all requests and use `https://\{domain\}/` as the base URL, where domain is your Oracle Cloud domain.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Oracle Recruiting Cloud      | `oraclerecruiting/rest`            | [Oracle's REST API](https://docs.oracle.com/en/cloud/saas/human-resources/24d/farws/rest-endpoints.html). We automatically authenticate all requests and use 'https\://\{company\_url}' as the base url.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Oracle Recruiting Cloud      | `oraclerecruiting/rest`            | [Oracles's REST API](https://docs.oracle.com/en/cloud/saas/human-resources/24d/farws/rest-endpoints.html). We automatically authenticate all requests and use 'https\://\{company\_url}' as the base url.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Oracle Taleo                 | `taleo/soap`                       | [Taleo's API](https://docs.oracle.com/en/cloud/saas/taleo-enterprise/23b/otwsu/c-taleoapi.html). We automatically authenticate all requests and use 'https\://\{your-subdomain}.taleo.net/enterprise/soap' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| OTYS                         | `otys/json-rpc`                    | [OTYS JSON-RPC API](https://ows.otys.nl/info/). We authenticate with your stored API key and inject the session token as the first element of the JSON-RPC `params` array on each request (except `loginByUid`, which uses `params` as sent). Requests use `https://ows.otys.nl` as the base URL (for example `POST /jservice.php` with the RPC method in the URL fragment, matching OTYS conventions).                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| PageUp People                | `pageup/v1`                        | We use `https://assessment-mock-api.dc0.pageuppeople.com` as the base URL. Find the official docs [here](https://developers.pageuppeople.com/Api/Partners/Assessment).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| PageUp People                | `pageup/v3`                        | We use `https://\<environment\>.\<dataCentreId\>.pageuppeople.com/v3/\<tenantId\>/recruitment` as the base URL. Find the official docs [here](https://developers.pageuppeople.com/Api/Recruitment).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Paradox                      | `paradox/v1`                       | We use `\{api_url\}/api/v1` as the base URL. Find the official docs [here](https://paradox.readme.io/).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Paradox                      | `paradox/v1public`                 | We use `\{api_url\}/api/v1/public` as the base URL. Find the official docs [here](https://paradox.readme.io/).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Paychex                      | `paychex/api`                      | Paychex [REST API](https://developer.paychex.com/documentation). We automatically authenticate all requests and use `https://api.paychex.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Paycom                       | `paycom/v1`                        | Paycom's REST API. We automatically authenticate all requests using the provided SID and API Token and use `https://api.paycomonline.net/v4/rest/index.php/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Paycor                       | `paycor/v1`                        | [Paycors's v1 API](https://developers.paycor.com/explore#section/Getting-Started). We automatically authenticate all requests and use '[https://apis.paycor.com](https://apis.paycor.com)'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| PayFit                       | `payfitcustomer/api`               | PayFit [Partner API](https://developers.payfit.io/reference). We automatically authenticate all requests using the provided API key and use `https://partner-api.payfit.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| PayFit                       | `payfitpartner/partner-api`        | PayFit [Partner API](https://developers.payfit.io/reference). We automatically authenticate all requests using the OAuth access token and use `https://partner-api.payfit.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Paylocity                    | `paylocity/default`                | [Paylocity's Weblink API](https://developer.paylocity.com/integrations/reference/authentication-weblink). We automatically authenticate all requests and use 'https\://\{api                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | dc1demogw}.paylocity.com/' as the base URL.                   |
| Paylocity                    | `paylocity/next-gen`               | [Paylocity's NextGen API](https://developer.paylocity.com/integrations/reference/authentication). We automatically authenticate all requests and use '[https://dc1prodgwext.paylocity.com/](https://dc1prodgwext.paylocity.com/)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| PeopleHR                     | `peoplehr/default`                 | [PeopleHR's API](https://apidocs.peoplehr.com/#). We automatically authenticate all request ans use '[https://api.peoplehr.net](https://api.peoplehr.net)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| PeopleXD                     | `peoplexd/b2b`                     | PeopleXD's [B2B API](https://documenter.getpostman.com/view/3101638/TzeTHUDu#intro). We automatically authenticate all requests and use `https://api.corehr.com/ws/\{tenant_id\}/corehr` or `https://uatapi.corehr.com/ws/\{tenant_id\}/corehr` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| Personio                     | `personio/jobboard`                | API endpoints exposed on Personio's public job board pages ([currently just the XML feed](https://developer.personio.de/reference/get_xml)). We automatically use the right `https://\{company\}.jobs.personio.de` base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Personio                     | `personio/personnel`               | Personio's [Personnel Data API](https://developer.personio.de/reference/get_company-employees). We automatically authenticate all requests using the client ID and secret and use `https://api.personio.de/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Personio                     | `personio/personnelv2`             | Personio's [V2 Personnel Data API](https://developer.personio.de/v2.0/reference/introduction). We automatically authenticate all requests using the client ID and secret and use `https://api.personio.de/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Personio                     | `personio/recruiting`              | Personio's [Recruiting API](https://developer.personio.de/reference/get_company-employees). We automatically authenticate all requests using the Recruiting access token and use `https://api.personio.de/v1/recruiting` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Personio                     | `personio/recruitingV2`            | Personio's [V2 Recruiting API](https://developer.personio.de/reference/get_v2-recruiting-applications). We automatically authenticate all requests using the Recruiting access token, send the `Beta` header and use `https://api.personio.de/v2/recruiting` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Phenom                       | `phenom/rest-api`                  | The [Phenom API](https://developer.phenom.com/). We automatically authenticate all requests and use `https://api-stg.phenompro.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Pinpoint                     | `pinpoint/v1`                      | Pinpoint's [JSON:API](https://developers.pinpointhq.com/docs). We automatically authenticate all requests using the `X-API-KEY` header and use `https://\{subdomain\}.pinpointhq.com/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Planday                      | `planday/api`                      | Planday's [HR API v1.0](https://openapi.planday.com/api/hr?version=v1.0). We automatically authenticate all requests and use `https://openapi.planday.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Recruit CRM                  | `recruitcrm/api`                   | We use `https://api.recruitcrm.io` as the base URL. Find the official docs [here](https://docs.recruitcrm.io/docs/rcrm-api-reference/ZG9jOjMyNzk0NA-getting-started).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                               |
| RecruiterFlow                | `recruiterflow/v1`                 | RecruiterFlow API [docs](https://docs.recruiterflow.com/). We automatically authenticate all requests using the RF-Api-Key header and use `https://api.recruiterflow.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Remote                       | `remotecom/default`                | Remote's [API](https://remote.com/resources/api/getting-started). We automatically authenticate all requests using provided credentials. The base URL is `https://gateway.remote.com/v1` for production API keys (prefixed `ra_live_`), or `https://gateway.remote-sandbox.com/v1` for sandbox API keys.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| rexx systems                 | `rexx/default`                     | Rexx's HRIS export API. There is only one endpoint: `Get /`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Rippling                     | `rippling/api`                     | Rippling's [API](https://developer.rippling.com/documentation). We automatically authenticate all requests and use `https://api.rippling.com/platform/api` or`https://rest.ripplingapis.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Sage HR                      | `sagehr/api`                       | Sage HR's [API](https://developer.sage.com/hr/reference/api-ref). We automatically authenticate all requests and use `https://\{subdomain\}.sage.hr/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Sage People                  | `sagepeople/salesforce-rest-api`   | Sage People is built on Salesforce's [API](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_what_is_rest_api.htm). We automatically authenticate all requests and use `https://\{customer_name\}.my.salesforce.com/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| SAP SuccessFactors           | `successfactors/lms-odata-v4`      | We use `https://\{api_domain\}/learning/odatav4` as the base URL. Find the official docs [here](https://help.sap.com/docs/successfactors-learning/sap-successfactors-learning-odata-apis).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| SAP SuccessFactors           | `successfactors/odata-v2`          | [SuccessFactors' OData V2 API](https://help.sap.com/doc/74597e67f54d4f448252bad4c2b601c9/2211/en-US/SF_HCM_OData_API_REF_en.pdf). We automatically authenticate all requests and use `https://\{api_domain\}\{path?\}/odata/v2` as the base URL (the optional `\{path\}` is used when connecting via proxied/gateway domains).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| SD Worx                      | `sdworx/default`                   | SD Worx's [OData API](https://apistaging.cobra.sdworx.com/Resources). We automatically authenticate all requests using the client ID and secret and use `\{api_url\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Silae                        | `silae/rest`                       | [Silae's REST API](https://silae-api.document360.io/docs). We automatically authenticate all requests and use '[https://payroll-api.silae.fr/payroll](https://payroll-api.silae.fr/payroll)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Simployer                    | `simployer/v1`                     | [AlexisHR's v1 API](https://docs.alexishr.com/) We automatically authenticate all requests and use `https://\{subdomain\}.alexishr.com` as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| SmartRecruiters              | `smartrecruiters/default`          | Smartrecruiters [API](https://developers.smartrecruiters.com/reference/apply-api). We automatically authenticate all requests using OAuth and use `https://api.smartrecruiters.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| SmartRecruiters              | `smartrecruiters/default`          | Smartrecruiters [API](https://developers.smartrecruiters.com/reference/apply-api). We automatically authenticate all requests using the credentials supplied by the customer and use `https://api.smartrecruiters.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Softgarden                   | `softgarden/apply-api`             | [Softgarden's Apply API](https://dev.softgarden.de/apply-api/). We automatically authenticate all requests and use '[https://jobdb.softgarden.de/jobdb/public](https://jobdb.softgarden.de/jobdb/public)' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Softgarden                   | `softgarden/frontend-v3`           | \[Softgarden's Frontend API v3]\([https://dev.softgarden.de/frontend-v3/](https://dev.softgarden.de/frontend-v3/). We automatically authenticate all requests and use '[https://api.softgarden.io/api/rest](https://api.softgarden.io/api/rest)' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Spark Hire Recruit           | `comeet/api`                       | [Spark Hire Recruit's API.](https://developers.comeet.com/reference/recruiting-api-overview)We automatically authenticate all requests and use `https://api.comeet.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Spott                        | `spott/protected`                  | The [Spott API](https://docs.gospott.com). We automatically authenticate all requests and use `https://api.gospott.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Sympa                        | `sympa/api`                        | Sympa's [API](https://documenter.getpostman.com/view/33639379/2sA3kXG1vX#intro). We automatically authenticate all requests and use `https://api.sympahr.net/api/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Taleez                       | `taleez/0`                         | [Taleez's API](https://api.taleez.com/swagger-ui/index.html). We automatically authenticate all requests and use `https://api.taleez.com/0` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Talention                    | `talention/v1`                     | Talention's API. We automatically authenticate all requests and use `https://\{api_domain\}/tms/\{account_id\}/external/api/1.0` as the base URL. Documentation is provided privately by Talention. Contact Kombo support for assistance with specific endpoints.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| TalentLMS                    | `talentlms/v2`                     | We use `https://\{subdomain\}.talentlms.com/api/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Teamtailor Job Boards        | `teamtailorjobboards/direct-apply` | Teamtailor's [Job Board Direct Apply API](https://partner.teamtailor.com/job_boards/direct_apply/#direct-apply). We automatically authenticate all requests and use `https://5qbn6o9x4h.execute-api.eu-west-1.amazonaws.com/production` as the base URL. All requests are automatically signed with HMAC-SHA256 signature.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Teamtailor                   | `teamtailor/v1`                    | We use `https://api.teamtailor.com/v1` as the base URL. Find the official docs [here](https://docs.teamtailor.com/).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Tellent Recruitee            | `recruitee/default`                | The [Recruitee API](https://api.recruitee.com/docs/index.html). We automatically authenticate all requests and use `https://api.recruitee.com/c/\{company_id\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| Tellent Recruitee            | `recruitee/v1`                     | We use `https://api.recruitee.com/c/\{company_id\}` as the base URL. Find the official docs [here](https://docs.recruitee.com/reference).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| TrackerRMS                   | `trackerrms/v1`                    | We use `https://evousapi.tracker-rms.com` as the base URL. Find the official docs [here](https://evousapi.tracker-rms.com/swagger/index.html).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| TRAFFIT                      | `traffit/v2`                       | Traffit's [v2 API](https://api.traffit.com). We authenticate all requests with the Traffit API key and use the base URL `https://yourdomain.traffit.com/api/integration/v2`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| TriNet PEO                   | `trinetpeo/v1`                     | We use `https://api.trinet.com` as the base URL. Find the official docs [here](https://developers.trinet.com).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Ubeeo                        | `ubeeo/api`                        | Ubeeo ATS API. We automatically authenticate all requests using OAuth client credentials and use `https://api.ats-platform.com` as the base URL (sandbox: `https://api.acc.ats-platform.com`).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Udemy Business               | `udemy/learning`                   | Udemy Business REST API. We automatically handle authentication and use `https://\{account_name\}.udemy.com/api-2.0/organizations/\{account_id\}/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| UKG Pro WFM                  | `ukgprowfm/api`                    | UKG Pro WFM's [API](https://developer.ukg.com/wfm/reference/welcome-to-the-ukg-pro-workforce-management-api). We automatically authenticate all requests and use `https://\{hostname\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| UKG Pro                      | `ukgpro/default`                   | [UKG Pro's HRIS API](https://developer.ukg.com/hcm/reference/get_personnel-v1-person-details). We automatically authenticate all requests and use  `https://\{hostname\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| UKG Pro                      | `ukgpro/recruting`                 | [UKG Pro's Recruiting API](https://developer.ukg.com/hcm/reference/retrieveapplications). We automatically authenticate all requests and use  `https://\{hostname\}/talent/recruiting/v2/\{tenantalias\}/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| UKG Ready                    | `ukgready/api`                     | UKG Ready [API](https://secure.saashr.com/ta/docs/rest/public/). We automatically authenticate all requests using the provided credentials and use `https://\{api_domain\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Visma Peple                  | `peple/hrm`                        | [Visma Payroll Reporting API](https://api.analytics1.hrm.visma.net/docs/openapi.html). We automatically authenticate all requests using the client credentials and use '[https://api.analytics1.hrm.visma.net](https://api.analytics1.hrm.visma.net)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Visma Raet - Youforce        | `youforce/v1.0`                    | [Youforce's basic v1.0 API](https://vr-api-integration.github.io/youforce-api-documentation/postman_collections.html). We automatically authenticate all requests and use '[https://api.youforce.com](https://api.youforce.com)' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Visma YouServe               | `youserve/learning`                | Visma YouServe [Learning API](https://youserve-domain-api.github.io/SwaggerUI/learning.html). We automatically authenticate all requests using OAuth 2.0 with the provided credentials and use `https://api.youserve.nl/learning/v1.0` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Workable                     | `workable/v1`                      | **Deprecated: Use `v3` instead.** Workable's [API](https://workable.readme.io/reference/generate-an-access-token). We automatically authenticate all requests using the client ID and secret and use `https://\{subdomain\}.\{environment\}.com/spi/v3` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Workable                     | `workable/v3`                      | Workable's [API](https://workable.readme.io/reference/generate-an-access-token). We automatically authenticate all requests using the client ID and secret and use `https://\{subdomain\}.\{environment\}.com/spi/v3` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Workday                      | `workday/custom-report`            | [Workday's Custom Reports](https://community.workday.com/sites/default/files/file-hosting/productionapi/index.html). We automatically authenticate all requests and use `https://\{domain\}/ccx/service/customreport2/\{tenant\}/` as the base URL. Set your `method` to `GET`. The `path` should be the report path after the tenant, e.g., `/\{report_owner\}/\{report_name\}`. You can include query parameters in the `params` object (e.g., `format=json`).                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| Workday                      | `workday/rest`                     | [Workday's REST API](https://community.workday.com/sites/default/files/file-hosting/restapi/index.html). We automatically authenticate all requests and use the correct Workday REST base URL for your tenant. The base URL follows the format: https\://\{domain}/api/\{service\_name}/\{version}/\{tenant}. You can specify any valid REST endpoint and method. See the Workday REST API documentation for available endpoints. You must specify the `api_options` object and set `service_name` to the name of the service you want to call. You can also specify the `version` (e.g., "v1", "v2"); if omitted, it defaults to "v1".                                                                                                                                                                             |                                                               |
| Workday                      | `workday/soap`                     | [Workday's SOAP API](https://community.workday.com/sites/default/files/file-hosting/productionapi/index.html). We automatically authenticate all requests. Set `data` to your raw xml string. Use `/` as your `path`, as we will always send requests to `https://\{domain\}/ccx/service/\{tenant\}/\{service_name\}`. Set your `method` to `POST`. You need to specify the `api_options` object and set `service_name` to the name of the service you want to call. Find all available services [here](https://community.workday.com/sites/default/files/file-hosting/productionapi/versions/v41.0/index.html). The string that you submit as `data` will be the content of the `soapenv:Body` tag in the request. You can set the `service_version` to any valid Workday service version (the default is `38.2`). |                                                               |
| workforce.com                | `workforcecom/api`                 | Workforce.com [API](https://my.workforce.com/api/v2/documentation). We automatically authenticate all requests using the provided credentials and use `https://my.tanda.co` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Zelt                         | `zelt/partner`                     | Zelt's [Partner API](https://go.zelt.app/apiv2/swagger). We automatically authenticate all requests using the connected OAuth credentials and use `https://go.zelt.app/apiv2/partner` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Zoho Recruit                 | `zohorecruit/v2`                   | Zoho Recruit's [V2 API](https://www.zoho.com/recruit/developer-guide/apiv2/modules-api.html). We automatically authenticate all requests and use `https://recruit.\{domain\}/recruit/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Zvoove Recruit               | `zvooverecruit/applicants`         | [Zvoove Recruit's Applicants API](https://api.zvoove.com/docs/). We automatically authenticate all requests using the applicants API key and use 'https\://\{domain}/api/public' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Zvoove Recruit               | `zvooverecruit/jobs`               | [Zvoove Recruit's Jobs API](https://api.zvoove.com/docs/). We automatically authenticate all requests using the jobs API key and use 'https\://\{domain}/api/public' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |

<Note>Please note that the passthrough API endpoints are only meant for edge cases. That's why we only expose them for new integrations after understanding a concrete customer use case. If you have such a use case in mind, please reach out to Kombo.</Note>


# Move application to stage
Source: https://docs.kombo.dev/ats/v1/put-applications-application-id-stage

PUT /ats/applications/{application_id}/stage
Moves an application to a specified stage. Use job-specific stages from GET /jobs, not the deprecated /application-stages endpoint.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/ats/connectors/workday">Workday</a></li>
    <li><img /><a href="/ats/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/ats/connectors/smartrecruiters">SmartRecruiters</a></li>
    <li><img /><a href="/ats/connectors/oraclerecruiting">Oracle Recruiting Cloud</a></li>
    <li><img /><a href="/ats/connectors/lever">Lever</a></li>
    <li><img /><a href="/ats/connectors/icims">iCIMS</a></li>
    <li><img /><a href="/ats/connectors/cornerstonetalentlink">Cornerstone TalentLink</a></li>
    <li><img /><a href="/ats/connectors/recruitee">Tellent Recruitee</a></li>
    <li><img /><a href="/ats/connectors/recruiterflow">RecruiterFlow</a></li>
    <li><img /><a href="/ats/connectors/greenhouse">Greenhouse (V1)</a></li>
    <li><img /><a href="/ats/connectors/greenhousev3">Greenhouse (V3)</a></li>
    <li><img /><a href="/ats/connectors/teamtailor">Teamtailor</a></li>
    <li><img /><a href="/ats/connectors/ashby">Ashby</a></li>
    <li><img /><a href="/ats/connectors/onlyfy">Onlyfy</a></li>
    <li><img /><a href="/ats/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/ats/connectors/ukgready">UKG Ready</a></li>
    <li><img /><a href="/ats/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/ats/connectors/bullhorn4salesforce">Bullhorn for Salesforce</a></li>
    <li><img /><a href="/ats/connectors/bullhorn">Bullhorn</a></li>
    <li><img /><a href="/ats/connectors/workable">Workable</a></li>
    <li><img /><a href="/ats/connectors/jobvite">Jobvite</a></li>
    <li><img /><a href="/ats/connectors/fountain">Fountain</a></li>
    <li><img /><a href="/ats/connectors/pinpoint">Pinpoint</a></li>
    <li><img /><a href="/ats/connectors/dvinciadmin">d.vinci admin</a></li>
    <li><img /><a href="/ats/connectors/traffit">TRAFFIT</a></li>
    <li><img /><a href="/ats/connectors/abacusumantis">Abacus Umantis</a></li>
    <li><img /><a href="/ats/connectors/umantis">Haufe Umantis</a></li>
    <li><img /><a href="/ats/connectors/jobylon">Jobylon</a></li>
    <li><img /><a href="/ats/connectors/zohorecruit">Zoho Recruit</a></li>
    <li><img /><a href="/ats/connectors/eploy">Eploy</a></li>
    <li><img /><a href="/ats/connectors/paradox">Paradox</a></li>
    <li><img /><a href="/ats/connectors/recruitcrm">Recruit CRM</a></li>
    <li><img /><a href="/ats/connectors/homerun">Homerun</a></li>
    <li><img /><a href="/ats/connectors/carerix">Carerix</a></li>
    <li><img /><a href="/ats/connectors/carerixgraphql">Carerix (GraphQL)</a></li>
    <li><img /><a href="/ats/connectors/inrecruiting">InRecruiting by Zucchetti</a></li>
    <li><img /><a href="/ats/connectors/jobadder">JobAdder</a></li>
    <li><img /><a href="/ats/connectors/odoo">Odoo</a></li>
    <li><img /><a href="/ats/connectors/gem">Gem</a></li>
    <li><img /><a href="/ats/connectors/laura">Laura</a></li>
    <li><img /><a href="/ats/connectors/mercury">Mercury</a></li>
    <li><img /><a href="/ats/connectors/manatal">Manatal</a></li>
    <li><img /><a href="/ats/connectors/avionte">Avionté</a></li>
    <li><img /><a href="/ats/connectors/asymbl">Asymbl</a></li>
    <li><img /><a href="/ats/connectors/breezyhr">Breezy HR</a></li>
    <li><img /><a href="/ats/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/ats/connectors/spott">Spott</a></li>
    <li><img /><a href="/ats/connectors/logicmelon">Logic Melon</a></li>
    <li><img /><a href="/ats/connectors/loxo">Loxo</a></li>
    <li><img /><a href="/ats/connectors/kula">Kula</a></li>
    <li><img /><a href="/ats/connectors/trackerrms">TrackerRMS</a></li>
    <li><img /><a href="/ats/connectors/talent360">Talent360</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

<Note>
  This endpoint requires the permission **Set application stage** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "stage_id": "3PJ8PZhZZa1eEdd2DtPNtVup",
  "remote_fields": {}
}
```


# Set integration enabled
Source: https://docs.kombo.dev/ats/v1/put-integrations-integration-id-enabled

PUT /integrations/{integration_id}/enabled
Enable or disable the specified integration. When disabling, all currently running syncs will be cancelled.

All authentication credentials and configuration are preserved. Syncs can be resumed by re-enabling the integration.

You may use this to, for example, pause syncing for customers that are temporarily not using the integration.


# Data Residency and Compliance
Source: https://docs.kombo.dev/data-residency-compliance

Understanding Kombo's data handling, security, and regional deployment options

## Data Residency Options

Kombo runs fully independent regional deployments. You choose your region during onboarding, and all data processing stays within that region.

If you operate globally, you can also receive separate Kombo environments in multiple regions (for example, an EU environment and a US environment under the same tenant). Each environment is fully isolated and follows the residency guarantees of its own region.

### Available Regions

| Region | API Endpoint       | Location      |
| ------ | ------------------ | ------------- |
| **EU** | `api.kombo.dev`    | Europe        |
| **US** | `api.us.kombo.dev` | United States |

### Architectural Isolation

Each region operates its own isolated infrastructure — API servers, databases, sync workers, and object storage are all region-scoped. There is no cross-region data access:

* API keys created in one region cannot authenticate against the other region's API.
* PII of end-customers never leaves the selected region.
* Regional resources (integrations, synced data, logs) cannot be shared across regions.

The global dashboard frontend routes to the correct regional backend based on your tenant configuration. The dashboard itself does not store customer data — it connects to your region's backend for all operations.

## Compliance and Security

### Certifications

* **ISO 27001 Certified**
* **SOC 2 Type 2 Certified**
* **GDPR Compliant**
* **HIPAA Compliant**
* **DSGVO Compliant**

### Data Security

* **Encryption at rest**: All stored data is encrypted.
* **Regular penetration testing**: Independent security audits verify our controls.
* **API key security**: Keys support [IP allowlisting, expiration, and individual revocation](/hris/getting-started/authentication#api-key-security).
* **Role-based access**: Dashboard users are assigned [roles](/hris/guides/environments#roles-and-access-control) that control what environments and actions they can access.
* **SSO and MFA**: Available for dashboard authentication (subject to your plan).
* **Audit logs**: All sensitive operations (key management, configuration changes) are [logged](/hris/features/audit-logs).

For the full details on our security practices, visit our [Security Center](https://security.kombo.dev/).

## Data Retention

* **Integration data**: When an integration is deleted, all of its data is removed after **14 days**. See the full [deletion policy](/hris/features/deletion-policy).
* **Logs**: Sync, action, and request/response logs are retained for a fixed default period. Longer retention is available on Enterprise plans — reach out to the Kombo team for details.

### GDPR deletion requests

Kombo does not own the source-of-truth record for end-customer data — the underlying HRIS or ATS does. GDPR deletion requests therefore follow this flow:

1. The data subject requests deletion from the company that operates the connected ATS or HRIS.
2. That company removes the record from their HRIS or ATS.
3. On the next sync, Kombo detects that the record is no longer present in the upstream system and mirrors the deletion in our database.

This means Kombo's data stays consistent with what the customer has in their own HR or recruiting system without us needing to act as a separate controller for deletion requests.

## Additional Information

If you have specific questions or need detailed information for a security questionnaire, reach out to the Kombo team or visit our [Security Center](https://security.kombo.dev/).


# Extending the model
Source: https://docs.kombo.dev/extending-the-model

How to make Kombo's unified models fit your product

Kombo's unified models cover the fields that are standard across HR and ATS systems. When your product needs additional data, Kombo offers several ways to go beyond the unified model — each suited to a different scenario.

### Custom Fields — Unified Extra Data (Reads)

The most common option. [Custom fields](/hris/features/custom-fields) let you define your own field keys (e.g., `t_shirt_size`) and map them to the corresponding field in each connected integration. Values are returned as part of the unified API response in a `custom_fields` object, so your code stays integration-agnostic.

Custom fields can be mapped via the dashboard, through automatic mapping rules that match on field keys, or through the [self-serve setup flow](/hris/features/setup-flow/introduction) where your end customers map them during onboarding. Use the [Custom Field Explorer](/hris/features/custom-fields#map-fields-based-on-live-data) to discover available fields from the remote tool in real-time without waiting for a sync.

<Frame>
  <img />
</Frame>

### Remote Fields — Extra Data on Writes

When a write action (e.g., creating a candidate) requires tool-specific data that isn't part of the unified request body, [remote fields](/hris/features/remote-fields) let you pass it alongside the unified payload. Each tool has its own `remote_fields` schema documented on the relevant write endpoint.

### Field Remapping — Override Default Mappings

[Remapping](/hris/features/remapping/introduction) lets you override how Kombo maps specific unified fields. For example, you can change which source field populates `job_title` for a particular integration, or remap enum values. This is useful when an integration's default mapping doesn't match how your customer has configured their system.

### Passthrough API — Full Native API Access

For use cases that go beyond field-level customization, the [Passthrough API](/hris/features/passthrough-api) lets you call the underlying tool's native API directly, with Kombo handling authentication. This gives you access to any endpoint the tool offers — reading resources Kombo doesn't model, calling custom actions, or accessing tool-specific configuration.

### Choosing the Right Approach

| Scenario                                                                                    | Recommended                                        |
| ------------------------------------------------------------------------------------------- | -------------------------------------------------- |
| Read extra fields from synced data (standard or provider-specific; one integration or many) | [Custom fields](/hris/features/custom-fields)      |
| Send extra data on a write action                                                           | [Remote fields](/hris/features/remote-fields)      |
| Override how a unified field is mapped                                                      | [Remapping](/hris/features/remapping/introduction) |
| Access an entirely different API endpoint                                                   | [Passthrough API](/hris/features/passthrough-api)  |


# Error Handling
Source: https://docs.kombo.dev/guides/errors

Learn what errors the Kombo API can return and how to handle them.

## Error Format

Proper error responses from the Kombo API will always follow this structure:

<CodeGroup>
  ```json Error Response highlight={4, 7} theme={null}
  {
    "status": "error",
    "error": {
      "code": "INTEGRATION.MODEL_NOT_AVAILABLE",
      "title": "This data model isn't supported for the selected integration.",
      "message": "The \"employees\" model is not yet available for Greenhouse. Please reach out to Kombo if you need this functionality.",
      "log_url": "https://app.kombo.dev/my-prod/logs?interactionId=123456"
    }
  }
  ```

  ```json Minimal Error Response theme={null}
  {
    "status": "error",
    "error": {
      "code": null,
      "title": null,
      "message": "An error without a code.",
      "log_url": null
    }
  }
  ```
</CodeGroup>

<ResponseField name="code" type="string | null">
  A unique identifier for programmatic error handling, used to determine the specific type of error that occurred. See the list below for all available codes.
</ResponseField>

<ResponseField name="title" type="string | null">
  A static, human-readable label. (Note: While we initially only used the *message* field, we are gradually moving static error descriptions to the *title* field).
</ResponseField>

<ResponseField name="message" type="string">
  A dynamic, detailed description of what went wrong in this specific instance.
</ResponseField>

<ResponseField name="log_url" type="string | null">
  A link to the [log page](/ats/features/logs) in the dashboard where you can investigate the issue yourself. If you need assistance, please share this link with our support team.
</ResponseField>

## Error Handling Recommendations

When building error handling logic, **always use the `code` field** if available to identify specific error types programmatically (see [the complete list of error codes](#error-codes) below):

```ts theme={null}
// NOTE: We do NOT recommend *also* checking on the HTTP status code -
// only checking the Kombo `code` field is enough
if (response.error.code === 'PLATFORM.RATE_LIMIT_EXCEEDED') {
  // Handle rate limit exceeded
}
```

Reality is messy and there will be rare cases where you might receive an error response that doesn't follow our typical structure, for example when our load balancer returns a 503 response due to an internal failure.

As a result, we recommend still having basic handling for when you don't receive a `code`:

```ts theme={null}
if (!response.error?.code) {
  // Handle generic error
}
```

Please **do not** write conditional logic based on the `message` field, as message text may change between releases. Similarly, **do not** rely on HTTP status codes or other response properties, as these may be updated for consistency across the API.

## Error Scenarios

The examples below demonstrate different error situations that can occur when using the Kombo API:

<AccordionGroup>
  <Accordion title="Kombo responds with validation error">
    **Scenario**: You submit a request with missing fields. Kombo validates inputs and rejects the request with a platform validation error.

    ```ts theme={null}
    await fetch('https://api.kombo.dev/v1/ats/candidates', {
      method: 'POST',
      headers: {
        Authorization: 'Bearer <API_KEY>',
        'Content-Type': 'application/json',
        'X-Integration-Id': '<INTEGRATION_ID>',
      },
      body: JSON.stringify({
        // the body content is missing
      })
    })
    ```

    ```json theme={null}
    {
      "status": "error",
      "error": {
        "code": "PLATFORM.INPUT_INVALID",
        "title": "Your request contains invalid data and failed validation.",
        "message": "candidate: Required; application: Required",
        "log_url": "https://app.kombo.dev/my-prod/logs?interactionId=123456"
      }
    }
    ```
  </Accordion>

  <Accordion title="Integration responds with categorized error">
    **Scenario**: You're building a job board that automatically applies candidates to positions. A candidate clicks "Apply" on a job they've already applied to previously.

    When you call `POST /ats/applications` to create the application, the ATS system (like Greenhouse) rejects it because the candidate already applied. However, Kombo categorizes this specific rejection with a structured error code:

    ```json theme={null}
    {
      "status": "error",
      "error": {
        "code": "ATS.APPLICATION_ALREADY_EXISTS",
        "title": "Candidate has already applied to this job.",
        "message": "John Doe (john@example.com) has an existing application for Software Engineer position",
        // ...
      }
    }
    ```

    **Error Handling**: You can check for this specific error code and handle it appropriately:

    ```ts theme={null}
    // ...call to create application...

    const body = await response.json()
    if (body.error.code === "ATS.APPLICATION_ALREADY_EXISTS") {
      showInfo("You've already applied to this position.")
      return
    }

    throw new Error("Application failed")
    ```
  </Accordion>

  <Accordion title="Integration system is unavailable">
    **Scenario**: The downstream API (ATS, HRIS, etc.) experiences downtime or maintenance. After internal retries, Kombo returns a categorized remote error.

    ```json theme={null}
    {
      "status": "error",
      "error": {
        "code": "REMOTE.SERVICE_UNAVAILABLE",
        "title": "The remote system is currently unavailable.",
        "message": "The API of \"Workday\" is currently unavailable. Please try again later.",
        "log_url": "https://app.kombo.dev/my-prod/logs?interactionId=123456"
      }
    }
    ```

    **Error Handling**: Implement retry with exponential backoff, or inform the user to try again later.
  </Accordion>
</AccordionGroup>

## FAQ

<AccordionGroup>
  <Accordion title="Why the `title` and `message`?">
    Let's imagine you get these two error responses:

    ```json theme={null}
    {
      "status": "error",
      "error": {
        "code": "REMOTE.INPUT_INVALID",
        "title": "The remote system returned validation errors.",
        "message": "Employee field 'department' is required for BambooHR",
        "log_url": null
      }
    }
    ```

    ```json theme={null}
    {
      "status": "error",
      "error": {
        "code": "REMOTE.INPUT_INVALID",
        "title": "The remote system returned validation errors.",
        "message": "Candidate field 'email' must be a valid email address for Greenhouse",
        "log_url": null
      }
    }
    ```

    They both have the `code` "REMOTE.INPUT\_INVALID" and the same `title` of "The remote system returned validation errors."

    However, while the `title` is always identical for this error code, the `message` varies completely depending on the integration. Each integration may format errors differently, and we don't guarantee any specific message format or structure.

    (Note: Below in the list of error codes, you can see the current `title` text for each error type.)
  </Accordion>

  <Accordion title="Is the `code` always present?">
    Not every error is categorized yet. So the `code` can also be `null`.

    If the `code` is currently `null` but a specific error type (like `ATS.JOB_CLOSED`) would make sense, please contact support.
  </Accordion>

  <Accordion title="Which errors can be safely retried?">
    Requests failing with [`PLATFORM.RATE_LIMIT_EXCEEDED`](#platform-rate_limit_exceeded), [`PLATFORM.CONCURRENCY_LIMIT_EXCEEDED`](#platform-concurrency_limit_exceeded), [`REMOTE.RATE_LIMIT_EXCEEDED`](#remote-rate_limit_exceeded) or [`REMOTE.SERVICE_UNAVAILABLE`](#remote-service_unavailable) are generally safe to retry. If our load balancer responds with HTTP `503`, you should retry the request as well.

    Validation errors ([`PLATFORM.INPUT_INVALID`](#platform-input_invalid) and [`REMOTE.INPUT_INVALID`](#remote-input_invalid)) can be retried after you correct the underlying input.

    For other errors, avoid automatic retries without human input. Use exponential backoff (preferably with jitter) for retries.
  </Accordion>
</AccordionGroup>

## Error Codes

Most errors include an error `code` that can be used to identify their cause and write application logic to handle them appropriately.

Since **new error codes may be added in the future**, your application logic should handle unknown error codes gracefully.
Below, you can find a list of all the error codes that can be returned by the API:

<Info>
  Some error codes appear in pairs with different namespaces to indicate their origin:

  * [`PLATFORM.RATE_LIMIT_EXCEEDED`](#platform-rate_limit_exceeded) and [`REMOTE.RATE_LIMIT_EXCEEDED`](#remote-rate_limit_exceeded)
  * [`PLATFORM.INPUT_INVALID`](#platform-input_invalid) and [`REMOTE.INPUT_INVALID`](#remote-input_invalid)
  * [`PLATFORM.UNKNOWN_ERROR`](#platform-unknown_error) and [`REMOTE.UNKNOWN_HTTP_ERROR`](#remote-unknown_http_error)

  `PLATFORM.*` errors come from Kombo while `REMOTE.*` errors (originally) come from the downstream API (ATS, HRIS, etc.).
</Info>

<Note>
  We're still finalizing our error categorization.
  Platform errors are already well-categorized, but not every remote system error is fully classified yet.
  If you notice a missing or miscategorized error, please let us know.
</Note>

***

### Namespace `PLATFORM`

All the errors related to the general Kombo platform.

#### `PLATFORM.RATE_LIMIT_EXCEEDED`

Title: "Rate limit exceeded."\
HTTP Status: 429 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

#### `PLATFORM.CONCURRENCY_LIMIT_EXCEEDED`

Title: "Concurrency limit exceeded."\
HTTP Status: 429 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

#### `PLATFORM.INTEGRATION_NOT_FOUND`

Title: "Integration not found."\
HTTP Status: 404 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

#### `PLATFORM.INPUT_INVALID`

Title: "Your request contains invalid data and failed validation."\
HTTP Status: 400 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

<Info>
  Review the information that is being sent in the request, as there might be missing or invalid fields. Check the Logs for more details.
</Info>

#### `PLATFORM.UNKNOWN_ERROR`

Title: "An unknown error occurred in our system."\
HTTP Status: 500 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

<Info>
  This is the fallback error message, when an unexpected error has occurred on the side of Kombo.

  We're still improving our error categorization. If this seems like it should be a more *specific* error type (like `ATS.JOB_CLOSED`), please contact support.
</Info>

#### `PLATFORM.IP_NOT_WHITELISTED`

Title: "Your IP address is not whitelisted."\
HTTP Status: 403 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

#### `PLATFORM.AUTHENTICATION_INVALID`

Title: "The provided authentication is invalid."\
HTTP Status: 401 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

#### `PLATFORM.TASK_TIMED_OUT`

Title: "The task timed out."\
HTTP Status: 500 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

<Info>
  The task did not complete in time. This is usually a transient issue. Retry the request with the same idempotency key to resume processing.
</Info>

***

### Namespace `INTEGRATION`

All the errors related to the *connection* to a specific remote system.

#### `INTEGRATION.PERMISSION_MISSING`

Title: "A permission is missing in the remote system."\
HTTP Status: 400 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

<Info>
  Check in the Kombo dashboard which permissions are missing. Review the connection guide for how to add them and inform your customer of the required steps. For some integrations, a re-connect may be necessary.
</Info>

#### `INTEGRATION.AUTHENTICATION_INVALID`

Title: "The integration cannot authenticate with the remote system."\
HTTP Status: 403 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

<Info>
  Use the reconnection link to re-authenticate the integration. If this repeats, review the logs and contact Kombo support.
</Info>

#### `INTEGRATION.QA_FAILED`

Title: "The integration's setup sync failed quality checks."\
HTTP Status: 409 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

<Info>
  No action is required on your side. Kombo support is investigating. We will notify you if any input or changes are needed from your side.
</Info>

#### `INTEGRATION.SETUP_SYNC_PENDING`

Title: "The integration's setup sync is still running."\
HTTP Status: 409 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

<Info>
  To prevent incomplete or inconsistent data, API requests are blocked until the setup sync completes.

  For larger remote systems, the initial sync can take longer. Monitor progress in the Kombo dashboard.

  If it takes unusually long or appears stuck, contact Kombo support. We can review the job and, if appropriate, trigger a limited "recent data only" sync to speed up availability.
</Info>

#### `INTEGRATION.SETUP_INCOMPLETE`

Title: "The integration setup process is incomplete."\
HTTP Status: 409 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

<Info>
  Some integrations require additional setup steps from the end customer beyond simply connecting their credentials. This can include configuring webhooks within the remote tool, setting up sources for ATS integrations, or configuring employee filters for HRIS. This error means the end customer has connected the integration but has not yet completed those required steps.

  To unblock the integration, generate a setup link from the integration's detail page and share it with the end customer, or open the setup flow on their behalf directly from the dashboard.

  As a last resort, dashboard admins can force-complete setup from the integration's "Issues" panel using the "Force unlock" button, but this should only be done if you are certain the missing steps are not required.
</Info>

<Info>
  The setup steps are already shown to your end customer at the end of a Kombo Connect session.

  If you would like to surface the setup experience to a customer in your UI outside of that flow, you can use the [Create Setup Flow link](/hris/v1/post-integrations-integration-id-setup-link) endpoint to generate a link and pass it to `showKomboConnect` from the Kombo Connect SDK, the same way you handle the initial connection flow. This lets your customers complete the remaining setup steps without leaving your product.
</Info>

#### `INTEGRATION.INACTIVE`

Title: "This integration is currently deactivated."\
HTTP Status: 403 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

<Info>
  In the Kombo Dashboard you can reactivate the integration.
</Info>

#### `INTEGRATION.MODEL_NOT_AVAILABLE`

Title: "This data model isn't supported for the selected integration."\
HTTP Status: 400 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

<Info>
  Look at the "Coverage Grid" in the Kombo Dashboard for more details. Reach out to the Kombo support if you need this functionality.
</Info>

#### `INTEGRATION.MODEL_DISABLED`

Title: "This data model is disabled in the integration's scope configuration."\
HTTP Status: 403 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

<Info>
  Go to the integration in the Kombo Dashboard. In the settings the "Scope config" is configured.
  Change this scope config to enable the functionality.
</Info>

#### `INTEGRATION.ACTION_NOT_AVAILABLE`

Title: "This action isn't supported for the selected integration."\
HTTP Status: 400 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

<Info>
  Look at the "Coverage Grid" in the Kombo Dashboard for more details. Reach out to the Kombo support if you need this functionality.
</Info>

#### `INTEGRATION.ACTION_DISABLED`

Title: "This action is disabled in the integration's scope configuration."\
HTTP Status: 400 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

<Info>
  Go to the integration in the Kombo Dashboard. In the settings the "Scope config" is configured.
  Change this scope config to enable the functionality.
</Info>

***

### Namespace `REMOTE`

All the errors originating from third-party HRIS/ATS systems.

#### `REMOTE.SERVICE_UNAVAILABLE`

Title: "The remote system is currently unavailable."\
HTTP Status: 500 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

<Info>
  This is usually due to scheduled maintenance or an outage on the vendor side. Check the logs for details. If it does not resolve within a few hours, please reach out to support.
</Info>

#### `REMOTE.RATE_LIMIT_EXCEEDED`

Title: "Kombo has hit the rate limit of the integration's API. Please try again later."\
HTTP Status: 429 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

<Info>
  Kombo is already retrying requests to the remote system automatically. Only when the backoff exceeds what we can do in the request we abort and return this error.
</Info>

#### `REMOTE.INPUT_INVALID`

Title: "The remote system returned validation errors."\
HTTP Status: 400 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

#### `REMOTE.UNKNOWN_HTTP_ERROR`

Title: "The remote system returned errors."\
HTTP Status: 400 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

<Info>
  We're still improving our error categorization. If this seems like it should be a more *specific* error type (like `ATS.JOB_CLOSED`), please contact support.
</Info>

***

### Namespace `HRIS`

All the errors related to the HRIS use-case.

#### `HRIS.STAFFING_ENTITY_CLOSED`

Title: "The staffing entity is closed."\
HTTP Status: 400 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

<Info>
  Ensure to only call our get employee form endpoint with open staffing entities.
</Info>

<Info>
  Select a different staffing entity (job/position/requisition) to create the employee for.
</Info>

#### `HRIS.EMPLOYEE_ALREADY_EXISTS`

Title: "The employee already exists in the HRIS system."\
HTTP Status: 400 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

***

### Namespace `ATS`

All the errors related to the ATS use-case.

#### `ATS.JOB_CLOSED`

Title: "The requested job is closed."\
HTTP Status: 400 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

<Info>
  This occurs when candidates try to apply to jobs that have been closed or archived in the ATS system. This is normal and not critical unless it happens frequently, which may indicate outdated job listings.
</Info>

<Info>
  Ensure your UI filters out closed jobs and refreshes job statuses regularly. When this error occurs, show the user that the job is closed.
</Info>

#### `ATS.APPLICATION_ALREADY_EXISTS`

Title: "The candidate has already applied to this job."\
HTTP Status: 400 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

<Info>
  Show the candidate that they have already applied to the job. If your system created the first application, restrict the candidate from applying again.
</Info>

***

### Namespace `LMS`

All the errors related to the LMS use-case.

#### `LMS.COURSE_UPDATE_NOT_SUPPORTED`

Title: "Course updates are not supported for this tool."\
HTTP Status: 400 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

<Info>
  This integration does not support updating existing courses. You can only create new courses. If you need to update a course, deactivate it and create it again.
</Info>

***

### Namespace `AI_APPLY`

All the errors related to AI Apply.

#### `AI_APPLY.JOB_FEED_IMPORT_ALREADY_RUNNING`

Title: "This job feed already has a running import."\
HTTP Status: 409 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

<Info>
  Ensure you do not start parallel imports for the same job feed. If this persists after the suggested retry time, check your logs and contact Kombo support.
</Info>

#### `AI_APPLY.JOB_FEED_IMPORT_TIMED_OUT`

Title: "The job feed import timed out."\
HTTP Status: 504 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

#### `AI_APPLY.JOB_POSTING_ALREADY_EXISTS`

Title: "A job posting with this URL already exists for this career site."\
HTTP Status: 409 <Tooltip href="#error-handling-recommendations"><Icon icon="circle-info" /></Tooltip>

<Info>
  You can retrieve the existing job posting by listing all postings for the career site (GET /v1/ai-apply/postings) and filtering by URL. If you want to re-trigger parsing, contact Kombo support.
</Info>


# Available HRIS Connectors
Source: https://docs.kombo.dev/hris/connectors

Browse all available HRIS connectors integrated with Kombo

Through Kombo's Unified HRIS API, you can integrate with 98+ HRIS systems.

<Note>
  Please note that this page only lists connectors for Kombo's **HRIS API**. You can also browse our [ATS connectors](/ats/connectors) and [Assessment connectors](/assessment/connectors) and [LMS connectors](/lms/connectors).
</Note>

<CardGroup>
  <Card title="a3innuva Nómina" icon="https://storage.googleapis.com/kombo-assets/integrations/a3innuvanomina/icon.svg" href="/hris/connectors/a3innuvanomina">
    HRIS connector
  </Card>

  <Card title="Abacus" icon="https://storage.googleapis.com/kombo-assets/integrations/abacus/icon.svg" href="/hris/connectors/abacus">
    HRIS connector
  </Card>

  <Card title="Absence.io" icon="https://storage.googleapis.com/kombo-assets/integrations/absenceio/icon.svg" href="/hris/connectors/absenceio">
    HRIS connector
  </Card>

  <Card title="ADP Decidium" icon="https://storage.googleapis.com/kombo-assets/integrations/adpdecidium/icon.svg" href="/hris/connectors/adpdecidium">
    HRIS connector
  </Card>

  <Card title="ADP Workforce Now" icon="https://storage.googleapis.com/kombo-assets/integrations/adpworkforcenow/icon.svg" href="/hris/connectors/adpworkforcenow">
    HRIS connector
  </Card>

  <Card title="AFAS Software" icon="https://storage.googleapis.com/kombo-assets/integrations/afas/icon.svg" href="/hris/connectors/afas">
    HRIS connector
  </Card>

  <Card title="AlexisHR" icon="https://storage.googleapis.com/kombo-assets/integrations/alexishr/icon.svg" href="/hris/connectors/alexishr">
    HRIS connector
  </Card>

  <Card title="BambooHR" icon="https://storage.googleapis.com/kombo-assets/integrations/bamboohr/icon.svg" href="/hris/connectors/bamboohr">
    HRIS connector
  </Card>

  <Card title="BoondManager" icon="https://storage.googleapis.com/kombo-assets/integrations/boondmanager/icon.svg" href="/hris/connectors/boondmanager">
    HRIS connector
  </Card>

  <Card title="Breathe HR" icon="https://storage.googleapis.com/kombo-assets/integrations/breathehr/icon.svg" href="/hris/connectors/breathehr">
    HRIS connector
  </Card>

  <Card title="CatalystOne" icon="https://storage.googleapis.com/kombo-assets/integrations/catalystone/icon.svg" href="/hris/connectors/catalystone">
    HRIS connector
  </Card>

  <Card title="Cezanne HR" icon="https://storage.googleapis.com/kombo-assets/integrations/cezannehr/icon.svg" href="/hris/connectors/cezannehr">
    HRIS connector
  </Card>

  <Card title="Charlie" icon="https://storage.googleapis.com/kombo-assets/integrations/charliehr/icon.svg" href="/hris/connectors/charliehr">
    HRIS connector
  </Card>

  <Card title="Cornerstone OnDemand" icon="https://storage.googleapis.com/kombo-assets/integrations/cornerstoneondemand/icon.svg" href="/hris/connectors/cornerstoneondemand">
    HRIS connector
  </Card>

  <Card title="DATEV" icon="https://storage.googleapis.com/kombo-assets/integrations/datevlauds/icon.svg" href="/hris/connectors/datevlauds">
    HRIS connector
  </Card>

  <Card title="DATEV HR" icon="https://storage.googleapis.com/kombo-assets/integrations/datevhr/icon.svg" href="/hris/connectors/datevhr">
    HRIS connector
  </Card>

  <Card title="DATEV LODAS" icon="https://storage.googleapis.com/kombo-assets/integrations/datev/icon.svg" href="/hris/connectors/datev">
    HRIS connector
  </Card>

  <Card title="DATEV Lohn & Gehalt" icon="https://storage.googleapis.com/kombo-assets/integrations/datevlug/icon.svg" href="/hris/connectors/datevlug">
    HRIS connector
  </Card>

  <Card title="Dayforce" icon="https://storage.googleapis.com/kombo-assets/integrations/dayforce/icon.svg" href="/hris/connectors/dayforce">
    HRIS connector
  </Card>

  <Card title="Deel" icon="https://storage.googleapis.com/kombo-assets/integrations/deel/icon.svg" href="/hris/connectors/deel">
    HRIS connector
  </Card>

  <Card title="Employment Hero" icon="https://storage.googleapis.com/kombo-assets/integrations/employmenthero/icon.svg" href="/hris/connectors/employmenthero">
    HRIS connector
  </Card>

  <Card title="Eurécia" icon="https://storage.googleapis.com/kombo-assets/integrations/eurecia/icon.svg" href="/hris/connectors/eurecia">
    HRIS connector
  </Card>

  <Card title="Factorial" icon="https://storage.googleapis.com/kombo-assets/integrations/factorial/icon.svg" href="/hris/connectors/factorial">
    HRIS connector
  </Card>

  <Card title="Fourth" icon="https://storage.googleapis.com/kombo-assets/integrations/fourth/icon.svg" href="/hris/connectors/fourth">
    HRIS connector
  </Card>

  <Card title="Google Workspace" icon="https://storage.googleapis.com/kombo-assets/integrations/googleworkspace/icon.svg" href="/hris/connectors/googleworkspace">
    HRIS connector
  </Card>

  <Card title="Gusto" icon="https://storage.googleapis.com/kombo-assets/integrations/gusto/icon.svg" href="/hris/connectors/gusto">
    HRIS connector
  </Card>

  <Card title="Hailey HR" icon="https://storage.googleapis.com/kombo-assets/integrations/haileyhr/icon.svg" href="/hris/connectors/haileyhr">
    HRIS connector
  </Card>

  <Card title="Hansalog" icon="https://storage.googleapis.com/kombo-assets/integrations/hansalog/icon.svg" href="/hris/connectors/hansalog">
    HRIS connector
  </Card>

  <Card title="HeavenHR" icon="https://storage.googleapis.com/kombo-assets/integrations/heavenhr/icon.svg" href="/hris/connectors/heavenhr">
    HRIS connector
  </Card>

  <Card title="HiBob" icon="https://storage.googleapis.com/kombo-assets/integrations/hibob/icon.svg" href="/hris/connectors/hibob">
    HRIS connector
  </Card>

  <Card title="HoorayHR" icon="https://storage.googleapis.com/kombo-assets/integrations/hoorayhr/icon.svg" href="/hris/connectors/hoorayhr">
    HRIS connector
  </Card>

  <Card title="HR WORKS" icon="https://storage.googleapis.com/kombo-assets/integrations/hrworks/icon.svg" href="/hris/connectors/hrworks">
    HRIS connector
  </Card>

  <Card title="HR4YOU" icon="https://storage.googleapis.com/kombo-assets/integrations/hr4you/icon.svg" href="/hris/connectors/hr4you">
    HRIS connector
  </Card>

  <Card title="Humaans" icon="https://storage.googleapis.com/kombo-assets/integrations/humaans/icon.svg" href="/hris/connectors/humaans">
    HRIS connector
  </Card>

  <Card title="Insperity" icon="https://storage.googleapis.com/kombo-assets/integrations/insperity/icon.svg" href="/hris/connectors/insperity">
    HRIS connector
  </Card>

  <Card title="IRIS Cascade" icon="https://storage.googleapis.com/kombo-assets/integrations/iriscascade/icon.svg" href="/hris/connectors/iriscascade">
    HRIS connector
  </Card>

  <Card title="iTrent" icon="https://storage.googleapis.com/kombo-assets/integrations/itrent/icon.svg" href="/hris/connectors/itrent">
    HRIS connector
  </Card>

  <Card title="Kallidus (Sapling)" icon="https://storage.googleapis.com/kombo-assets/integrations/sapling/icon.svg" href="/hris/connectors/sapling">
    HRIS connector
  </Card>

  <Card title="Kenjo" icon="https://storage.googleapis.com/kombo-assets/integrations/kenjo/icon.svg" href="/hris/connectors/kenjo">
    HRIS connector
  </Card>

  <Card title="Kombo Sandbox" icon="https://storage.googleapis.com/kombo-assets/integrations/sandbox/icon.svg" href="/hris/connectors/sandbox">
    HRIS connector
  </Card>

  <Card title="Lattice" icon="https://storage.googleapis.com/kombo-assets/integrations/lattice/icon.svg" href="/hris/connectors/lattice">
    HRIS connector
  </Card>

  <Card title="Lattice Talent" icon="https://storage.googleapis.com/kombo-assets/integrations/latticetalent/icon.svg" href="/hris/connectors/latticetalent">
    HRIS connector
  </Card>

  <Card title="Leapsome" icon="https://storage.googleapis.com/kombo-assets/integrations/leapsome/icon.svg" href="/hris/connectors/leapsome">
    HRIS connector
  </Card>

  <Card title="Loket" icon="https://storage.googleapis.com/kombo-assets/integrations/loket/icon.svg" href="/hris/connectors/loket">
    HRIS connector
  </Card>

  <Card title="Lucca" icon="https://storage.googleapis.com/kombo-assets/integrations/lucca/icon.svg" href="/hris/connectors/lucca">
    HRIS connector
  </Card>

  <Card title="MHR People First" icon="https://storage.googleapis.com/kombo-assets/integrations/peoplefirst/icon.svg" href="/hris/connectors/peoplefirst">
    HRIS connector
  </Card>

  <Card title="Microsoft Azure AD" icon="https://storage.googleapis.com/kombo-assets/integrations/azuread/icon.svg" href="/hris/connectors/azuread">
    HRIS connector
  </Card>

  <Card title="Microsoft Entra ID" icon="https://storage.googleapis.com/kombo-assets/integrations/entraid/icon.svg" href="/hris/connectors/entraid">
    HRIS connector
  </Card>

  <Card title="Mirus" icon="https://storage.googleapis.com/kombo-assets/integrations/mirus/icon.svg" href="/hris/connectors/mirus">
    HRIS connector
  </Card>

  <Card title="Namely" icon="https://storage.googleapis.com/kombo-assets/integrations/namely/icon.svg" href="/hris/connectors/namely">
    HRIS connector
  </Card>

  <Card title="Nibelis" icon="https://storage.googleapis.com/kombo-assets/integrations/nibelis/icon.svg" href="/hris/connectors/nibelis">
    HRIS connector
  </Card>

  <Card title="Nmbrs" icon="https://storage.googleapis.com/kombo-assets/integrations/nmbrs/icon.svg" href="/hris/connectors/nmbrs">
    HRIS connector
  </Card>

  <Card title="Officient" icon="https://storage.googleapis.com/kombo-assets/integrations/officient/icon.svg" href="/hris/connectors/officient">
    HRIS connector
  </Card>

  <Card title="Okta" icon="https://storage.googleapis.com/kombo-assets/integrations/okta/icon.svg" href="/hris/connectors/okta">
    HRIS connector
  </Card>

  <Card title="Oracle HCM" icon="https://storage.googleapis.com/kombo-assets/integrations/oraclehcm/icon.svg" href="/hris/connectors/oraclehcm">
    HRIS connector
  </Card>

  <Card title="OysterHR" icon="https://storage.googleapis.com/kombo-assets/integrations/oysterhr/icon.svg" href="/hris/connectors/oysterhr">
    HRIS connector
  </Card>

  <Card title="Paychex" icon="https://storage.googleapis.com/kombo-assets/integrations/paychex/icon.svg" href="/hris/connectors/paychex">
    HRIS connector
  </Card>

  <Card title="Paycom" icon="https://storage.googleapis.com/kombo-assets/integrations/paycom/icon.svg" href="/hris/connectors/paycom">
    HRIS connector
  </Card>

  <Card title="Paycor" icon="https://storage.googleapis.com/kombo-assets/integrations/paycor/icon.svg" href="/hris/connectors/paycor">
    HRIS connector
  </Card>

  <Card title="PayFit Customer" icon="https://storage.googleapis.com/kombo-assets/integrations/payfitcustomer/icon.svg" href="/hris/connectors/payfitcustomer">
    HRIS connector
  </Card>

  <Card title="PayFit Partner" icon="https://storage.googleapis.com/kombo-assets/integrations/payfitpartner/icon.svg" href="/hris/connectors/payfitpartner">
    HRIS connector
  </Card>

  <Card title="PayFit Legacy" icon="https://storage.googleapis.com/kombo-assets/integrations/payfit/icon.svg" href="/hris/connectors/payfit">
    HRIS connector
  </Card>

  <Card title="Paylocity" icon="https://storage.googleapis.com/kombo-assets/integrations/paylocity/icon.svg" href="/hris/connectors/paylocity">
    HRIS connector
  </Card>

  <Card title="PeopleHR" icon="https://storage.googleapis.com/kombo-assets/integrations/peoplehr/icon.svg" href="/hris/connectors/peoplehr">
    HRIS connector
  </Card>

  <Card title="PeopleXD" icon="https://storage.googleapis.com/kombo-assets/integrations/peoplexd/icon.svg" href="/hris/connectors/peoplexd">
    HRIS connector
  </Card>

  <Card title="Perbility Helix" icon="https://storage.googleapis.com/kombo-assets/integrations/perbilityhelix/icon.svg" href="/hris/connectors/perbilityhelix">
    HRIS connector
  </Card>

  <Card title="Personio" icon="https://storage.googleapis.com/kombo-assets/integrations/personio/icon.svg" href="/hris/connectors/personio">
    HRIS connector
  </Card>

  <Card title="Planday" icon="https://storage.googleapis.com/kombo-assets/integrations/planday/icon.svg" href="/hris/connectors/planday">
    HRIS connector
  </Card>

  <Card title="Remote" icon="https://storage.googleapis.com/kombo-assets/integrations/remotecom/icon.svg" href="/hris/connectors/remotecom">
    HRIS connector
  </Card>

  <Card title="rexx systems" icon="https://storage.googleapis.com/kombo-assets/integrations/rexx/icon.svg" href="/hris/connectors/rexx">
    HRIS connector
  </Card>

  <Card title="Rippling" icon="" href="/hris/connectors/rippling">
    HRIS connector
  </Card>

  <Card title="Sage HR" icon="https://storage.googleapis.com/kombo-assets/integrations/sagehr/icon.svg" href="/hris/connectors/sagehr">
    HRIS connector
  </Card>

  <Card title="Sage People" icon="https://storage.googleapis.com/kombo-assets/integrations/sagepeople/icon.svg" href="/hris/connectors/sagepeople">
    HRIS connector
  </Card>

  <Card title="SAP SuccessFactors" icon="https://storage.googleapis.com/kombo-assets/integrations/successfactors/icon.svg" href="/hris/connectors/successfactors">
    HRIS connector
  </Card>

  <Card title="SCIM" icon="https://storage.googleapis.com/kombo-assets/integrations/scim/icon.svg" href="/hris/connectors/scim">
    HRIS connector
  </Card>

  <Card title="SD Worx" icon="https://storage.googleapis.com/kombo-assets/integrations/sdworx/icon.svg" href="/hris/connectors/sdworx">
    HRIS connector
  </Card>

  <Card title="Sesame HR" icon="https://storage.googleapis.com/kombo-assets/integrations/sesamehr/icon.svg" href="/hris/connectors/sesamehr">
    HRIS connector
  </Card>

  <Card title="SFTP" icon="https://storage.googleapis.com/kombo-assets/integrations/sftp/icon.svg" href="/hris/connectors/sftp">
    HRIS connector
  </Card>

  <Card title="SFTP Fetch" icon="https://storage.googleapis.com/kombo-assets/integrations/sftpfetch/icon.svg" href="/hris/connectors/sftpfetch">
    HRIS connector
  </Card>

  <Card title="Silae" icon="" href="/hris/connectors/silae">
    HRIS connector
  </Card>

  <Card title="Simployer" icon="https://storage.googleapis.com/kombo-assets/integrations/simployer/icon.svg" href="/hris/connectors/simployer">
    HRIS connector
  </Card>

  <Card title="Square" icon="https://storage.googleapis.com/kombo-assets/integrations/square/icon.svg" href="/hris/connectors/square">
    HRIS connector
  </Card>

  <Card title="Sympa" icon="https://storage.googleapis.com/kombo-assets/integrations/sympa/icon.svg" href="/hris/connectors/sympa">
    HRIS connector
  </Card>

  <Card title="Tellent HR" icon="https://storage.googleapis.com/kombo-assets/integrations/kiwihr/icon.svg" href="/hris/connectors/kiwihr">
    HRIS connector
  </Card>

  <Card title="TriNet (Zenefits)" icon="https://storage.googleapis.com/kombo-assets/integrations/trinet/icon.svg" href="/hris/connectors/trinet">
    HRIS connector
  </Card>

  <Card title="TriNet PEO" icon="https://storage.googleapis.com/kombo-assets/integrations/trinetpeo/icon.svg" href="/hris/connectors/trinetpeo">
    HRIS connector
  </Card>

  <Card title="UKG Pro" icon="https://storage.googleapis.com/kombo-assets/integrations/ukgpro/icon.svg" href="/hris/connectors/ukgpro">
    HRIS connector
  </Card>

  <Card title="UKG Pro WFM" icon="https://storage.googleapis.com/kombo-assets/integrations/ukgprowfm/icon.svg" href="/hris/connectors/ukgprowfm">
    HRIS connector
  </Card>

  <Card title="UKG Ready" icon="https://storage.googleapis.com/kombo-assets/integrations/ukgready/icon.svg" href="/hris/connectors/ukgready">
    HRIS connector
  </Card>

  <Card title="Visma Peple" icon="https://storage.googleapis.com/kombo-assets/integrations/peple/icon.svg" href="/hris/connectors/peple">
    HRIS connector
  </Card>

  <Card title="Visma Raet - Youforce" icon="https://storage.googleapis.com/kombo-assets/integrations/youforce/icon.svg" href="/hris/connectors/youforce">
    HRIS connector
  </Card>

  <Card title="Visma YouServe" icon="https://storage.googleapis.com/kombo-assets/integrations/youserve/icon.svg" href="/hris/connectors/youserve">
    HRIS connector
  </Card>

  <Card title="Workday" icon="https://storage.googleapis.com/kombo-assets/integrations/workday/icon.svg" href="/hris/connectors/workday">
    HRIS connector
  </Card>

  <Card title="Workday Custom Report SFTP" icon="https://storage.googleapis.com/kombo-assets/integrations/workdaycustomreportsftp/icon.svg" href="/hris/connectors/workdaycustomreportsftp">
    HRIS connector
  </Card>

  <Card title="Workday Custom Reports" icon="https://storage.googleapis.com/kombo-assets/integrations/workdaycustomreport/icon.svg" href="/hris/connectors/workdaycustomreport">
    HRIS connector
  </Card>

  <Card title="workforce.com" icon="https://storage.googleapis.com/kombo-assets/integrations/workforcecom/icon.svg" href="/hris/connectors/workforcecom">
    HRIS connector
  </Card>

  <Card title="Zelt" icon="https://storage.googleapis.com/kombo-assets/integrations/zelt/icon.svg" href="/hris/connectors/zelt">
    HRIS connector
  </Card>

  <Card title="Zoho People" icon="https://storage.googleapis.com/kombo-assets/integrations/zohopeople/icon.svg" href="/hris/connectors/zohopeople">
    HRIS connector
  </Card>
</CardGroup>

## Missing something?

We're always expanding our offering of integrations, so if there's a solution that's missing, [let's talk](https://www.kombo.dev/demo)! If you're an existing Kombo customer, please [reach out to support](mailto:support@kombo.dev).


# a3innuva Nómina HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/a3innuvanomina

a3innuva Nómina connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The a3innuva Nómina HRIS integration allows you to sync HRIS data between a3innuva Nómina and your application through Kombo's unified API. The tool slug for this connector is `a3innuvanomina`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/40857776238225-a3innuva-N%C3%B3mina-How-do-I-link-my-account">
    Step-by-step instructions to connect your a3innuva Nómina account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | tax\_id               |       |
      | gender                |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | name                    |       |
      | unit                    |       |
      | half\_days\_supported   |       |
      | exact\_times\_supported |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create absence">
      <Note>
        Supported absenteeism types: holidays (vacaciones), retributed permissions (permisos-retribuidos). Supported temporary disability types: illnesses (enfermedad-comun) Illness absences require remote\_fields.a3innuvanomina.benefit\_type\_id (Delegated Payment, No Right to Benefit, or Direct payment).
      </Note>

      | Input Field       | Notes |
      | ----------------- | ----- |
      | employee\_id      |       |
      | absence\_type\_id |       |
      | start\_date       |       |
      | end\_date         |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | OAuth            |       |
    | API Passthrough  |       |
    | Delta Syncs      |       |
    | Connection Guide |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Info>
      Some **required** form fields are referencing the following data models:

      * Legal Entities
      * Locations

      Consider enabling these in your [scope configuration](/hris/features/scopes).
    </Info>

    <ResponseField name="workplaceCode" type="single_select">**Workplace**<br />
    A3 workplace code to assign the employee to.<br />
    References `/v1/hris/locations?remote_model=location`</ResponseField>
    <ResponseField name="companyCode" type="single_select">**Company**<br />
    A3 company to assign the employee to.<br />
    References `/v1/hris/legal-entities?remote_model=legal_entity`</ResponseField>

    <ResponseField name="identification" type="object">
      **Identification**

      <Expandable title="properties">
        <ResponseField name="identificationType" type="single_select">**Identification Type**</ResponseField>
        <ResponseField name="identifierNumber" type="text">**Identifier Number**</ResponseField>
        <ResponseField name="legalName" type="text">**Legal Name**</ResponseField>
        <ResponseField name="secondName1" type="text">**Second Name 1**</ResponseField>
        <ResponseField name="secondName2" type="text">**Second Name 2**</ResponseField>
        <ResponseField name="sex" type="single_select">**Sex**</ResponseField>
        <ResponseField name="ssAffiliationNumberPrefix" type="text">**SS Affiliation Prefix**</ResponseField>
        <ResponseField name="ssAffiliationNumber" type="text">**SS Affiliation Number**</ResponseField>
        <ResponseField name="ssAffiliationNumberSuffix" type="text">**SS Affiliation Suffix**</ResponseField>
        <ResponseField name="enrollmentDate" type="date">**Enrollment Date**</ResponseField>
        <ResponseField name="personType" type="single_select">**Person Type**</ResponseField>
        <ResponseField name="birthRegion" type="text">**Birth Region**</ResponseField>
        <ResponseField name="birthCountry" type="single_select">**Birth Country**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="agreement" type="object">
      **Agreement**

      <Expandable title="properties">
        <ResponseField name="nonRenumerated" type="checkbox">**Non Remunerated**</ResponseField>
        <ResponseField name="companyAgreementCode" type="text">**Company Agreement Code**</ResponseField>
        <ResponseField name="classificationCode" type="number">**Classification Code**</ResponseField>
        <ResponseField name="jobPositionCode" type="text">**Job Position Code**</ResponseField>
        <ResponseField name="subClassificationCode" type="number">**Sub Classification Code**</ResponseField>
        <ResponseField name="cnoOccupationID" type="single_select">**CNO Occupation**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="contribution" type="object">
      **Contribution**

      <Expandable title="properties">
        <ResponseField name="contributionTypeID" type="single_select">**Contribution Type ID**</ResponseField>
        <ResponseField name="regime" type="single_select">**Regime**</ResponseField>
        <ResponseField name="tariffGroupID" type="number">**Tariff Group ID**</ResponseField>
        <ResponseField name="occupationCodeTGSS" type="text">**Occupation Code TGSS**</ResponseField>
        <ResponseField name="ims" type="number">**IMS**</ResponseField>
        <ResponseField name="it" type="number">**IT**</ResponseField>
        <ResponseField name="paymentFrequency" type="number">**Payment Frequency**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="address" type="object">
      **Address**

      <Expandable title="properties">
        <ResponseField name="acronymID" type="text">**Acronym ID**</ResponseField>
        <ResponseField name="streetName" type="text">**Street Name**</ResponseField>
        <ResponseField name="buildingNumber" type="text">**Building Number**</ResponseField>
        <ResponseField name="stairwell" type="text">**Stairwell**</ResponseField>
        <ResponseField name="floor" type="text">**Floor**</ResponseField>
        <ResponseField name="gate" type="text">**Gate**</ResponseField>
        <ResponseField name="town" type="text">**Town**</ResponseField>
        <ResponseField name="postalCode" type="text">**Postal Code**</ResponseField>
        <ResponseField name="countryID" type="single_select">**Country ID**</ResponseField>
        <ResponseField name="poBox" type="text">**PO Box**</ResponseField>
      </Expandable>
    </ResponseField>
  </Tab>
</Tabs>


# Abacus HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/abacus

Abacus connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Abacus HRIS integration allows you to sync HRIS data between Abacus and your application through Kombo's unified API. The tool slug for this connector is `abacus`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/32154621629841-Abacus-HRIS-How-do-I-link-my-account">
    Step-by-step instructions to connect your Abacus account to Kombo.
  </Card>
</CardGroup>

## General Notes

* Some Abacus instances will have scheduled maintenance during night time. Expect failing syncs during that time.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | tax\_id               |       |
      | gender                |       |
      | marital\_status       |       |
      | employment\_type      |       |
      | legal\_entity\_id     |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      <Note>
        Abacus API only returns a departmentId
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | API Passthrough    |       |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
    | Group Types        |       |
    | DEPARTMENT         |       |
  </Tab>
</Tabs>


# Absence.io HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/absenceio

Absence.io connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Absence.io HRIS integration allows you to sync HRIS data between Absence.io and your application through Kombo's unified API. The tool slug for this connector is `absenceio`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/37674031794833-Absence-io-How-do-I-link-my-account">
    Step-by-step instructions to connect your Absence.io account to Kombo.
  </Card>

  <Card title="Sandbox Environment" icon="flask" href="https://www.absence.io/try-for-free/">
    Access the Absence.io sandbox environment for testing and development.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_number    |       |
      | first\_name         |       |
      | last\_name          |       |
      | display\_full\_name |       |
      | work\_email         |       |
      | employment\_status  |       |
      | work\_location\_id  |       |
      | manager\_id         |       |
      | start\_date         |       |
      | termination\_date   |       |
      | remote\_created\_at |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | name                    |       |
      | unit                    |       |
      | half\_days\_supported   |       |
      | exact\_times\_supported |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | approver\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_time         |       |
      | end\_time           |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create absence">
      | Input Field       | Notes |
      | ----------------- | ----- |
      | employee\_id      |       |
      | absence\_type\_id |       |
      | start\_date       |       |
      | end\_date         |       |
    </Accordion>

    <Accordion title="Delete absence">
      | Input Field | Notes |
      | ----------- | ----- |
      | absence\_id |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | API Passthrough       |       |
    | Scope Testing         |       |
    | Delta Syncs           |       |
    | Custom Field Explorer |       |
    | Employees             |       |
    | Connection Guide      |       |
    | Group Types           |       |
    | TEAM                  |       |
    | DEPARTMENT            |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Note>
      We fetch the available roles from all the users during the sync. There is no standalone endpoint to fetch them. This means we will only show roles that are already assigned to users.
    </Note>

    <ResponseField name="firstName" type="text">**First Name**<br />
    The first name of the employee<br />
    Unified field: `first_name`</ResponseField>
    <ResponseField name="lastName" type="text">**Last Name**<br />
    The last name of the employee<br />
    Unified field: `last_name`</ResponseField>
    <ResponseField name="email" type="text">**Private Email**<br />
    The private email address of the employee<br />
    Unified field: `private_email`</ResponseField>
    <ResponseField name="roleId" type="single_select">**Role**</ResponseField>
  </Tab>
</Tabs>


# ADP Decidium HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/adpdecidium

ADP Decidium connector for Kombo's HRIS API

<Note>This connector requires a custom Kombo plan. Please contact us to enable it.</Note>

<Note>This connector is in closed beta. Please contact us to get access.</Note>

The ADP Decidium HRIS integration allows you to sync HRIS data between ADP Decidium and your application through Kombo's unified API. The tool slug for this connector is `adpdecidium`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/47996462534929-ADP-Decidium-How-do-I-link-my-account">
    Step-by-step instructions to connect your ADP Decidium account to Kombo.
  </Card>

  <Card title="Partnership Guide" icon="handshake" href="https://help.kombo.dev/hc/en-us/articles/47999564556561-ADP-Decidium-How-to-get-your-Partner-Credentials">
    Learn how to become a partner with ADP Decidium to enable this integration.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      <Note>
        Decidium does not designate a primary work assignment. Kombo treats the first non-terminated assignment as primary and only exposes its location. Only the primary work assignment's manager is exposed via Kombo's API. Only the first nationality is exposed via Kombo's API.
      </Note>

      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | name                    |       |
      | unit                    |       |
      | half\_days\_supported   |       |
      | exact\_times\_supported |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_half\_day    |       |
      | end\_half\_day      |       |
      | unit                |       |
      | status              |       |
      | type\_id            |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | API Passthrough       |       |
    | Scope Testing         |       |
    | Per Model Tests       |       |
    | Custom Field Explorer |       |
    | Employees             |       |
    | Connection Guide      |       |
    | Employment History    |       |
    | Group Types           |       |
    | DEPARTMENT            |       |
    | COST\_CENTER          |       |
  </Tab>
</Tabs>


# ADP Workforce Now HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/adpworkforcenow

ADP Workforce Now connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The ADP Workforce Now HRIS integration allows you to sync HRIS data between ADP Workforce Now and your application through Kombo's unified API. The tool slug for this connector is `adpworkforcenow`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/29675977484945">
    Step-by-step instructions to connect your ADP Workforce Now account to Kombo.
  </Card>
</CardGroup>

## General Notes

* This connector is built for **ADP Workforce Now**, a product available only in North America. Please do not confuse it with **ADP Workforce**.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      <Note>
        Only the primary employment's work location is exposed via Kombo's API. Only the primary employment's manager is exposed via Kombo's API. Only the first nationality is exposed via Kombo's API.
      </Note>

      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | ethnicity             |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Time Off Balances">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | type\_id            |       |
      | balance             |       |
      | balance\_unit       |       |
      | used                |       |
      | used\_unit          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee">
      <Note>
        Creating an employee in ADP Workforce Now creates an 'in-progress' hire. The onboarding process must be completed within ADP Workforce Now's UI before the full employee data will be retrievable via Kombo's API. ADP Workforce Now requires two separate remote fields for creating an employee: `onboarding_template_code` and `applicant_payroll_profile_group_code`. View the possible values in the Kombo dashboard by clicking on the ADP Workforce Now integration and viewing the field report in the settings tab.
      </Note>

      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | job\_title              |       |
      | home\_address.street\_1 |       |
      | home\_address.city      |       |
      | home\_address.zip\_code |       |
      | home\_address.country   |       |
      | mobile\_phone\_number   |       |
      | start\_date             |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | API Passthrough  |       |
    | Scope Testing    |       |
    | Per Model Tests  |       |
    | Connection Guide |       |
    | Prerequisites    |       |
    | Group Types      |       |
    | DEPARTMENT       |       |
    | COST\_CENTER     |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Note>
      Creating an employee in ADP Workforce Now creates an 'in-progress' hire. The onboarding process must be completed within ADP Workforce Now New Hire wizard before the full employee data will be retrievable via Kombo's `get-employees` API.
    </Note>

    <ResponseField name="applicantOnboarding" type="object">
      **Applicant Onboarding**

      <Expandable title="properties">
        <ResponseField name="onboardingTemplateCode" type="single_select">**Onboarding Template Code**<br />
        The onboarding template used to complete the hiring process in the ADP Workforce Now New Hire wizard.</ResponseField>

        <ResponseField name="applicantPersonalProfile" type="object">
          **Personal Information**

          <Expandable title="properties">
            <ResponseField name="birthName" type="object">
              **Name**

              <Expandable title="properties">
                <ResponseField name="givenName" type="text">**First Name**<br />
                The first name of the employee<br />
                Unified field: `first_name`</ResponseField>
                <ResponseField name="familyName" type="text">**Last Name**<br />
                The last name of the employee<br />
                Unified field: `last_name`</ResponseField>
              </Expandable>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="applicantWorkerProfile" type="object">
          **Worker Information**

          <Expandable title="properties">
            <ResponseField name="hireDate" type="date">**Hire Date**<br />
            Unified field: `start_date`</ResponseField>
            <ResponseField name="job" type="single_select">**Job Title**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="applicantPayrollProfile" type="object">
          **Payroll Information**

          <Expandable title="properties">
            <ResponseField name="payrollGroupCode" type="single_select">**Company Code**</ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** ADP Workforce Now

For **ADP Workforce Now**, we also offer the following other connector variants:

<CardGroup>
  <Card title="ADP Workforce Now ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/adpworkforcenow/icon.svg" href="/ats/connectors/adpworkforcenow">
    ADP Workforce Now for the ATS category
  </Card>
</CardGroup>


# AFAS Software HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/afas

AFAS Software connector for Kombo's HRIS API

The AFAS Software HRIS integration allows you to sync HRIS data between AFAS Software and your application through Kombo's unified API. The tool slug for this connector is `afas`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/18767909752337">
    Step-by-step instructions to connect your AFAS Software account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | gender                |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | parent\_id          |       |
    </Accordion>

    <Accordion title="Employee Document Categories">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Add document to employee">
      | Input Field            | Notes |
      | ---------------------- | ----- |
      | employee\_id           |       |
      | category\_id           |       |
      | document.name          |       |
      | document.content\_type |       |
      | document.data\_url     |       |
      | document.data          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | API Passthrough    |       |
    | Connection Guide   |       |
    | Employment History |       |
    | Group Types        |       |
    | DEPARTMENT         |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** AFAS Software

For **AFAS Software**, we also offer the following other connector variants:

<CardGroup>
  <Card title="AFAS Software ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/afas/icon.svg" href="/ats/connectors/afas">
    AFAS Software for the ATS category
  </Card>
</CardGroup>


# AlexisHR HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/alexishr

AlexisHR connector for Kombo's HRIS API

The AlexisHR HRIS integration allows you to sync HRIS data between AlexisHR and your application through Kombo's unified API. The tool slug for this connector is `alexishr`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/22477829315985-AlexisHR-How-do-I-link-my-account">
    Step-by-step instructions to connect your AlexisHR account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | avatar                |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      <Note>
        In AlexisHR, absence types can be overwritten with policies, which are not available via API. The absence type returned by Kombo will therefore represent the default leave type, not the policy.
      </Note>

      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | name                    |       |
      | unit                    |       |
      | half\_days\_supported   |       |
      | exact\_times\_supported |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | approver\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_half\_day    |       |
      | end\_half\_day      |       |
      | start\_time         |       |
      | end\_time           |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | parent\_id          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create absence">
      <Note>
        AlexisHR will disregard time specific data on absences spanning multiple days. Trying to create an absence that conforms with the Kombo absence type might still fail, as AlexisHR allows to override types with leave policies, which are not available through the API.
      </Note>

      | Input Field       | Notes |
      | ----------------- | ----- |
      | employee\_id      |       |
      | absence\_type\_id |       |
      | status            |       |
      | start\_date       |       |
      | end\_date         |       |
      | start\_half\_day  |       |
      | end\_half\_day    |       |
      | employee\_note    |       |
      | start\_time       |       |
      | end\_time         |       |
    </Accordion>

    <Accordion title="Delete absence">
      | Input Field | Notes |
      | ----------- | ----- |
      | absence\_id |       |
    </Accordion>

    <Accordion title="Create employee">
      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | gender                  |       |
      | job\_title              |       |
      | home\_address.street\_1 |       |
      | home\_address.city      |       |
      | home\_address.zip\_code |       |
      | home\_address.country   |       |
      | date\_of\_birth         |       |
      | mobile\_phone\_number   |       |
      | nationality             |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | API Passthrough    |       |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
    | Group Types        |       |
    | TEAM               |       |
    | DEPARTMENT         |       |
    | COST\_CENTER       |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Info>
      Some **optional** form fields are referencing the following data models:

      * Employees
      * Groups
      * Locations

      Consider enabling these in your [scope configuration](/hris/features/scopes).
    </Info>

    <ResponseField name="firstName" type="text">**First Name**<br />
    The first name of the employee<br />
    Unified field: `first_name`</ResponseField>
    <ResponseField name="lastName" type="text">**Last Name**<br />
    The last name of the employee<br />
    Unified field: `last_name`</ResponseField>
    <ResponseField name="userName" type="text">**Username**</ResponseField>
    <ResponseField name="workEmail" type="text">**Work Email**<br />
    The email address of the employee<br />
    Unified field: `work_email`</ResponseField>
    <ResponseField name="privateEmail" type="text">**Private Email**<br />
    The private email address of the employee<br />
    Unified field: `private_email`</ResponseField>
    <ResponseField name="workPhone" type="text">**Work Phone**<br />
    The work phone number including country code, e.g. +1 234 567 890</ResponseField>
    <ResponseField name="privatePhone" type="text">**Private Phone**<br />
    The private phone number including country code, e.g. +1 234 567 890<br />
    Unified field: `mobile_phone_number`</ResponseField>
    <ResponseField name="birthDate" type="date">**Date of Birth**<br />
    The employee's date of birth<br />
    Unified field: `date_of_birth`</ResponseField>
    <ResponseField name="avatarUrl" type="text">**Avatar URL**</ResponseField>
    <ResponseField name="nationality" type="single_select">**Nationality**</ResponseField>
    <ResponseField name="gender" type="single_select">**Gender**<br />
    The gender of the employee<br />
    Unified field: `gender`</ResponseField>
    <ResponseField name="pronoun" type="text">**Pronoun**</ResponseField>
    <ResponseField name="title" type="text">**Job Title**<br />
    The title of the position this person is working in<br />
    Unified field: `job_title`</ResponseField>
    <ResponseField name="officeId" type="single_select">**Office**<br />
    Unified field: `location_id`<br />
    References `/v1/hris/locations?remote_model=location`</ResponseField>
    <ResponseField name="managerEmployeeId" type="single_select">**Manager**<br />
    References `/v1/hris/employees?remote_model=employee`</ResponseField>
    <ResponseField name="departmentId" type="single_select">**Department**<br />
    References `/v1/hris/groups?types=DEPARTMENT`</ResponseField>
    <ResponseField name="costCenterId" type="single_select">**Cost Center**<br />
    References `/v1/hris/groups?types=COST_CENTER`</ResponseField>
    <ResponseField name="division" type="text">**Division**</ResponseField>
    <ResponseField name="organization" type="text">**Organization**</ResponseField>
    <ResponseField name="employeeNumber" type="text">**Employee Number**</ResponseField>

    <ResponseField name="tax" type="object">
      **Tax**

      <Expandable title="properties">
        <ResponseField name="table" type="number">**Tax Table**</ResponseField>
        <ResponseField name="column" type="number">**Tax Column**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="hasOccupationalPension" type="checkbox">**Has Occupational Pension**</ResponseField>
    <ResponseField name="ssn" type="text">**SSN**</ResponseField>
    <ResponseField name="ssnCountry" type="single_select">**SSN Country**</ResponseField>

    <ResponseField name="bankAccount" type="object">
      **Bank Account**

      <Expandable title="properties">
        <ResponseField name="bank" type="text">**Bank**</ResponseField>
        <ResponseField name="clearing" type="text">**Clearing**</ResponseField>
        <ResponseField name="number" type="text">**Number**</ResponseField>
        <ResponseField name="iban" type="text">**IBAN**</ResponseField>
        <ResponseField name="bic" type="text">**BIC**</ResponseField>
        <ResponseField name="country" type="single_select">**Country**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="homeAddress" type="object">
      **Home Address**

      <Expandable title="properties">
        <ResponseField name="street" type="text">**Street 1**<br />
        The street address of the employee<br />
        Unified field: `home_address.street_1`</ResponseField>
        <ResponseField name="postalCode" type="text">**ZIP Code**<br />
        The ZIP code of the employee<br />
        Unified field: `home_address.zip_code`</ResponseField>
        <ResponseField name="city" type="text">**City**<br />
        The city of the employee<br />
        Unified field: `home_address.city`</ResponseField>
        <ResponseField name="country" type="single_select">**Country**</ResponseField>
      </Expandable>
    </ResponseField>
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Legacy name for AlexisHR. Use Simployer for new connections

For **AlexisHR**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Simployer" icon="https://storage.googleapis.com/kombo-assets/integrations/simployer/icon.svg" href="/hris/connectors/simployer">
    Current name after AlexisHR was acquired by Simployer
  </Card>
</CardGroup>

<Note>You can only use one variant at a time.</Note>


# Microsoft Azure AD HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/azuread

Microsoft Azure AD connector for Kombo's HRIS API

The Microsoft Azure AD HRIS integration allows you to sync HRIS data between Microsoft Azure AD and your application through Kombo's unified API. The tool slug for this connector is `azuread`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/17934805960465">
    Step-by-step instructions to connect your Microsoft Azure AD account to Kombo.
  </Card>

  <Card title="Partnership Guide" icon="handshake" href="https://help.kombo.dev/hc/en-us/articles/39925115101201-Azure-AD-Entra-ID-How-to-setup-different-connection-flows">
    Learn how to become a partner with Microsoft Azure AD to enable this integration.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | avatar                |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee">
      <Note>
        Azure / entra requires a password to be set when creating a user. The user has to use the password on his initial sign-in and will be forced to change the password once signed in. The work\_email field is required. The domain of the submitted email has to be one of the verified domains in the organization.
      </Note>

      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | job\_title              |       |
      | home\_address.street\_1 |       |
      | home\_address.city      |       |
      | home\_address.zip\_code |       |
      | home\_address.country   |       |
      | date\_of\_birth         |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | OAuth                 |       |
    | API Passthrough       |       |
    | Additional Scopes     |       |
    | Custom Field Explorer |       |
    | Employees             |       |
    | Connection Guide      |       |
    | Prerequisites         |       |
    | Group Types           |       |
    | DEPARTMENT            |       |
    | COST\_CENTER          |       |
  </Tab>

  <Tab title="Create Employee with Form">
    *We don't have enough information yet about the fields to display them here.*
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Legacy Azure AD integration. Microsoft rebranded Azure AD to Entra ID. Both variants work, but consider using Entra ID for new connections

For **Microsoft Azure AD**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Microsoft Entra ID" icon="https://storage.googleapis.com/kombo-assets/integrations/entraid/icon.svg" href="/hris/connectors/entraid">
    Current Microsoft Entra ID integration (recommended for new connections)
  </Card>
</CardGroup>

<Note>You can only use one variant at a time.</Note>


# BambooHR HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/bamboohr

BambooHR connector for Kombo's HRIS API

The BambooHR HRIS integration allows you to sync HRIS data between BambooHR and your application through Kombo's unified API. The tool slug for this connector is `bamboohr`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/17797240347921-BambooHR-HRIS-How-do-I-link-my-account">
    Step-by-step instructions to connect your BambooHR account to Kombo.
  </Card>

  <Card title="Sandbox Environment" icon="flask" href="https://www.bamboohr.com/signup/">
    Access the BambooHR sandbox environment for testing and development.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | ethnicity             |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | avatar                |       |
      | work\_location\_id    |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | name                  |       |
      | unit                  |       |
      | half\_days\_supported |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Time Off Balances">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | type\_id            |       |
      | balance             |       |
      | balance\_unit       |       |
      | used                |       |
      | used\_unit          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Timesheets">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | started\_at         |       |
      | ended\_at           |       |
      | timezone            |       |
      | payable\_hours      |       |
      | approval\_status    |       |
      | approved\_at        |       |
      | comment             |       |
    </Accordion>

    <Accordion title="Employee Document Categories">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create absence">
      | Input Field       | Notes |
      | ----------------- | ----- |
      | employee\_id      |       |
      | absence\_type\_id |       |
      | status            |       |
      | start\_date       |       |
      | end\_date         |       |
      | amount            |       |
      | employee\_note    |       |
    </Accordion>

    <Accordion title="Delete absence">
      | Input Field | Notes |
      | ----------- | ----- |
      | absence\_id |       |
    </Accordion>

    <Accordion title="Create employee">
      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | gender                  |       |
      | job\_title              |       |
      | home\_address.street\_1 |       |
      | home\_address.street\_2 |       |
      | home\_address.city      |       |
      | home\_address.state     |       |
      | home\_address.zip\_code |       |
      | home\_address.country   |       |
      | date\_of\_birth         |       |
      | mobile\_phone\_number   |       |
      | start\_date             |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>

    <Accordion title="Add document to employee">
      | Input Field            | Notes |
      | ---------------------- | ----- |
      | employee\_id           |       |
      | category\_id           |       |
      | document.name          |       |
      | document.content\_type |       |
      | document.data\_url     |       |
      | document.data          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | OAuth                 |       |
    | API Passthrough       |       |
    | Scope Testing         |       |
    | Per Model Tests       |       |
    | Per Field Tests       |       |
    | Custom Field Explorer |       |
    | Employees             |       |
    | Connection Guide      |       |
    | Prerequisites         |       |
    | Create credentials    |       |
    | Employment History    |       |
    | Group Types           |       |
    | TEAM                  |       |
    | DEPARTMENT            |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <ResponseField name="firstName" type="text">**First Name**<br />
    The first name of the employee<br />
    Unified field: `first_name`</ResponseField>
    <ResponseField name="lastName" type="text">**Last Name**<br />
    The last name of the employee<br />
    Unified field: `last_name`</ResponseField>
    <ResponseField name="homeEmail" type="text">**Private Email**<br />
    The private email of the employee.<br />
    Unified field: `private_email`</ResponseField>
    <ResponseField name="dateOfBirth" type="date">**Date of Birth**<br />
    The employee's date of birth<br />
    Unified field: `date_of_birth`</ResponseField>
    <ResponseField name="workEmail" type="text">**Work Email**<br />
    The email address of the employee<br />
    Unified field: `work_email`</ResponseField>
    <ResponseField name="ssn" type="text">**SSN**<br />
    A standard United States Social Security number, with dashes.</ResponseField>
    <ResponseField name="gender" type="single_select">**Gender**<br />
    The gender of the employee<br />
    Unified field: `gender`</ResponseField>
    <ResponseField name="maritalStatus" type="single_select">**Marital Status**<br />
    The marital status of the employee.</ResponseField>
    <ResponseField name="hireDate" type="date">**Start Date**<br />
    Start date of the employee. Also considered to be the hire date<br />
    Unified field: `start_date`</ResponseField>
    <ResponseField name="address1" type="text">**Street 1**<br />
    The street address of the employee<br />
    Unified field: `home_address.street_1`</ResponseField>
    <ResponseField name="address2" type="text">**Street 2**<br />
    The street address of the employee<br />
    Unified field: `home_address.street_2`</ResponseField>
    <ResponseField name="zipcode" type="text">**ZIP Code**<br />
    The ZIP code of the employee<br />
    Unified field: `home_address.zip_code`</ResponseField>
    <ResponseField name="city" type="text">**City**<br />
    The city of the employee<br />
    Unified field: `home_address.city`</ResponseField>
    <ResponseField name="state" type="text">**State**<br />
    The state of the employee<br />
    Unified field: `home_address.state`</ResponseField>
    <ResponseField name="country" type="single_select">**Country**<br />
    The country of the employee.</ResponseField>
    <ResponseField name="exempt" type="single_select">**Exempt**<br />
    The FLSA Overtime Status of the employee.</ResponseField>
    <ResponseField name="pay_type" type="single_select">**Pay Type**<br />
    The pay type of the employee.</ResponseField>
    <ResponseField name="payRate" type="number">**Pay Rate**<br />
    The pay rate of the employee.<br />
    Unified field: `yearly_salary`</ResponseField>
    <ResponseField name="paidPer" type="single_select">**Pay Per**<br />
    The pay per of the employee.</ResponseField>
    <ResponseField name="paySchedule" type="single_select">**Pay Schedule**<br />
    The pay schedule of the employee.</ResponseField>
    <ResponseField name="location" type="single_select">**Location**<br />
    The location of the employee.</ResponseField>
    <ResponseField name="department" type="single_select">**Department**<br />
    The department of the employee.</ResponseField>
    <ResponseField name="division" type="single_select">**Division**<br />
    The division of the employee.</ResponseField>
    <ResponseField name="jobTitle" type="single_select">**Job Title**<br />
    The job title of the employee.</ResponseField>

    <ResponseField name="custom_fields" type="object">
      **Custom fields**

      <Expandable title="properties">
        <ResponseField name="158" type="text">**Emergency Contact Name**</ResponseField>
        <ResponseField name="160" type="single_select">**Emergency Contact Relationship**</ResponseField>
        <ResponseField name="1928" type="date">**Dependent Birth Date**</ResponseField>
        <ResponseField name="4047" type="date">**Job Information: Date**</ResponseField>
      </Expandable>
    </ResponseField>
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** BambooHR

For **BambooHR**, we also offer the following other connector variants:

<CardGroup>
  <Card title="BambooHR ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/bamboohr/icon.svg" href="/ats/connectors/bamboohr">
    BambooHR for the ATS category
  </Card>
</CardGroup>


# BoondManager HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/boondmanager

BoondManager connector for Kombo's HRIS API

The BoondManager HRIS integration allows you to sync HRIS data between BoondManager and your application through Kombo's unified API. The tool slug for this connector is `boondmanager`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/25156761925137-BoondManager-How-do-I-link-my-account">
    Step-by-step instructions to connect your BoondManager account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      <Note>
        Locations have the same address as the legal\_entity and are considered of type OFFICE because employees can be set to work there in Boond Manager.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      <Note>
        We map `email1` to work\_email and `email2` to personal\_email The employment\_type of all consultants is considered CONTRACT while everyone else is considered FULL\_TIME.
      </Note>

      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | avatar                |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | name                    |       |
      | unit                    |       |
      | half\_days\_supported   |       |
      | exact\_times\_supported |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | amount              |       |
      | unit                |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | API Passthrough    |       |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
    | Group Types        |       |
    | DEPARTMENT         |       |
  </Tab>
</Tabs>


# Breathe HR HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/breathehr

Breathe HR connector for Kombo's HRIS API

The Breathe HR HRIS integration allows you to sync HRIS data between Breathe HR and your application through Kombo's unified API. The tool slug for this connector is `breathehr`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/20857974074257">
    Step-by-step instructions to connect your Breathe HR account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | gender                |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | avatar                |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | unit                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_half\_day    |       |
      | end\_half\_day      |       |
      | amount              |       |
      | unit                |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee">
      <Note>
        Breathe HR requires a start date for the employee. If no start date is provided, we use the current date.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | first\_name     |       |
      | last\_name      |       |
      | work\_email     |       |
      | job\_title      |       |
      | date\_of\_birth |       |
      | start\_date     |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
    | Group Types        |       |
    | DEPARTMENT         |       |
  </Tab>
</Tabs>


# CatalystOne HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/catalystone

CatalystOne connector for Kombo's HRIS API

The CatalystOne HRIS integration allows you to sync HRIS data between CatalystOne and your application through Kombo's unified API. The tool slug for this connector is `catalystone`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/30726706687889">
    Step-by-step instructions to connect your CatalystOne account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Employees">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | display\_full\_name |       |
      | job\_title          |       |
      | work\_email         |       |
      | personal\_email     |       |
      | ssn                 |       |
      | gender              |       |
      | employment\_status  |       |
      | employment\_type    |       |
      | work\_location\_id  |       |
      | legal\_entity\_id   |       |
      | manager\_id         |       |
      | home\_address       |       |
      | date\_of\_birth     |       |
      | start\_date         |       |
      | termination\_date   |       |
      | remote\_created\_at |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | employment\_type    |       |
      | effective\_date     |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
    | Group Types        |       |
    | DEPARTMENT         |       |
  </Tab>
</Tabs>


# Cezanne HR HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/cezannehr

Cezanne HR connector for Kombo's HRIS API

The Cezanne HR HRIS integration allows you to sync HRIS data between Cezanne HR and your application through Kombo's unified API. The tool slug for this connector is `cezannehr`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/23272427261713-CezanneHR-How-do-I-link-my-account">
    Step-by-step instructions to connect your Cezanne HR account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | gender                |       |
      | ethnicity             |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | avatar                |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | name                    |       |
      | unit                    |       |
      | half\_days\_supported   |       |
      | exact\_times\_supported |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | approver\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_half\_day    |       |
      | end\_half\_day      |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee">
      <Note>
        Cezanne HR requires birth date for the employee. The `date_of_birth` field is expected to be provided in the request body. Cezanne HR requires `gender` for the employee. We will default to "Not Known" if the `gender` field is not provided in the request body.
      </Note>

      | Input Field     | Notes |
      | --------------- | ----- |
      | first\_name     |       |
      | last\_name      |       |
      | gender          |       |
      | date\_of\_birth |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | API Passthrough    |       |
    | Connection Guide   |       |
    | Employment History |       |
    | Group Types        |       |
    | TEAM               |       |
    | DEPARTMENT         |       |
    | COST\_CENTER       |       |
  </Tab>
</Tabs>


# Charlie HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/charliehr

Charlie connector for Kombo's HRIS API

The Charlie HRIS integration allows you to sync HRIS data between Charlie and your application through Kombo's unified API. The tool slug for this connector is `charliehr`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/18685711755025">
    Step-by-step instructions to connect your Charlie account to Kombo.
  </Card>

  <Card title="Sandbox Environment" icon="flask" href="https://www.charliehr.com/join">
    Access the Charlie sandbox environment for testing and development.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | first\_name           |       |
      | last\_name            |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | tax\_id               |       |
      | gender                |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | avatar                |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | name                  |       |
      | half\_days\_supported |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | approver\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Time Off Balances">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | type\_id            |       |
      | balance             |       |
      | balance\_unit       |       |
      | used                |       |
      | used\_unit          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
    | Group Types        |       |
    | TEAM               |       |
  </Tab>
</Tabs>


# Cornerstone OnDemand HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/cornerstoneondemand

Cornerstone OnDemand connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Cornerstone OnDemand HRIS integration allows you to sync HRIS data between Cornerstone OnDemand and your application through Kombo's unified API. The tool slug for this connector is `cornerstoneondemand`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/29501337571473">
    Step-by-step instructions to connect your Cornerstone OnDemand account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | first\_name           |       |
      | last\_name            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | gender                |       |
      | employment\_status    |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee">
      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | home\_address.street\_1 |       |
      | home\_address.city      |       |
      | home\_address.state     |       |
      | home\_address.zip\_code |       |
      | home\_address.country   |       |
      | mobile\_phone\_number   |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | API Passthrough       |       |
    | Scope Testing         |       |
    | Per Model Tests       |       |
    | Custom Field Explorer |       |
    | Employees             |       |
    | Connection Guide      |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Cornerstone OnDemand

For **Cornerstone OnDemand**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Cornerstone OnDemand ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/cornerstoneondemand/icon.svg" href="/ats/connectors/cornerstoneondemand">
    Cornerstone OnDemand for the ATS category
  </Card>

  <Card title="Cornerstone OnDemand LMS" icon="https://storage.googleapis.com/kombo-assets/integrations/cornerstoneondemand/icon.svg" href="/lms/connectors/cornerstoneondemand">
    Cornerstone OnDemand for the LMS category
  </Card>
</CardGroup>


# DATEV LODAS HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/datev

DATEV LODAS connector for Kombo's HRIS API

<Note>This connector requires a custom Kombo plan. Please contact us to enable it.</Note>

The DATEV LODAS HRIS integration allows you to sync HRIS data between DATEV LODAS and your application through Kombo's unified API. The tool slug for this connector is `datev`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/17624306602641-Wie-verbinde-ich-meinen-DATEV-LODAS-Account-">
    Step-by-step instructions to connect your DATEV LODAS account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Absence Types">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | name                  |       |
      | unit                  |       |
      | half\_days\_supported |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create absence">
      | Input Field       | Notes |
      | ----------------- | ----- |
      | employee\_id      |       |
      | absence\_type\_id |       |
      | start\_date       |       |
      | end\_date         |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | OAuth            |       |
    | API Passthrough  |       |
    | Scope Testing    |       |
    | Connection Guide |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Our legacy LODAS integration. No data can be read from DATEV

For **DATEV LODAS**, we also offer the following other connector variants:

<CardGroup>
  <Card title="DATEV" icon="https://storage.googleapis.com/kombo-assets/integrations/datevlauds/icon.svg" href="/hris/connectors/datevlauds">
    Our latest DATEV integration supporting the new Lohnaustauschdatenservice, to synchronize data bidirectional in real time. It also supports the legacy ASCII write interface. Works with both DATEV payroll products: LODAS and Lohn und Gehalt
  </Card>

  <Card title="DATEV HR" icon="https://storage.googleapis.com/kombo-assets/integrations/datevhr/icon.svg" href="/hris/connectors/datevhr">
    Legacy DATEV HR integration using the Lohnergebnisdatenservice API, to synchronize data with the monthly payroll results and only the ASCII write interface. This is slightly cheaper for the end customer than the DATEV LAUDS integration. Works with both DATEV payroll products: LODAS and Lohn und Gehalt
  </Card>

  <Card title="DATEV Lohn & Gehalt" icon="https://storage.googleapis.com/kombo-assets/integrations/datevlug/icon.svg" href="/hris/connectors/datevlug">
    Our legacy Lohn und Gehalt integration. No data can be read from DATEV
  </Card>
</CardGroup>

<Note>Multiple variants can be used within your Kombo environment at the same time.</Note>


# DATEV HR HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/datevhr

DATEV connector for Kombo's HRIS API

<Note>This connector requires a custom Kombo plan. Please contact us to enable it.</Note>

The DATEV HRIS integration allows you to sync HRIS data between DATEV and your application through Kombo's unified API. The tool slug for this connector is `datevhr`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/27472113295121-DATEV-Wie-stelle-ich-eine-Verbindung-mit-DATEV-her">
    Step-by-step instructions to connect your DATEV account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Employees">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_number    |       |
      | first\_name         |       |
      | last\_name          |       |
      | nationality         |       |
      | job\_title          |       |
      | ssn                 |       |
      | gender              |       |
      | employment\_status  |       |
      | employment\_type    |       |
      | weekly\_hours       |       |
      | home\_address       |       |
      | date\_of\_birth     |       |
      | start\_date         |       |
      | termination\_date   |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      <Note>
        Custom fields will not work for historical employments. Either use remote\_data or contact our support.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | OAuth              |       |
    | API Passthrough    |       |
    | Scope Testing      |       |
    | Connection Guide   |       |
    | Employment History |       |
    | Group Types        |       |
    | COST\_CENTER       |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Legacy DATEV HR integration using the Lohnergebnisdatenservice API, to synchronize data with the monthly payroll results and only the ASCII write interface. This is slightly cheaper for the end customer than the DATEV LAUDS integration. Works with both DATEV payroll products: LODAS and Lohn und Gehalt

For **DATEV**, we also offer the following other connector variants:

<CardGroup>
  <Card title="DATEV" icon="https://storage.googleapis.com/kombo-assets/integrations/datevlauds/icon.svg" href="/hris/connectors/datevlauds">
    Our latest DATEV integration supporting the new Lohnaustauschdatenservice, to synchronize data bidirectional in real time. It also supports the legacy ASCII write interface. Works with both DATEV payroll products: LODAS and Lohn und Gehalt
  </Card>

  <Card title="DATEV LODAS" icon="https://storage.googleapis.com/kombo-assets/integrations/datev/icon.svg" href="/hris/connectors/datev">
    Our legacy LODAS integration. No data can be read from DATEV
  </Card>

  <Card title="DATEV Lohn & Gehalt" icon="https://storage.googleapis.com/kombo-assets/integrations/datevlug/icon.svg" href="/hris/connectors/datevlug">
    Our legacy Lohn und Gehalt integration. No data can be read from DATEV
  </Card>
</CardGroup>

<Note>Multiple variants can be used within your Kombo environment at the same time.</Note>


# DATEV HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/datevlauds

DATEV connector for Kombo's HRIS API

<Note>This connector requires a custom Kombo plan. Please contact us to enable it.</Note>

<Note>This connector is in closed beta. Please contact us to get access.</Note>

The DATEV HRIS integration allows you to sync HRIS data between DATEV and your application through Kombo's unified API. The tool slug for this connector is `datevlauds`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/27472113295121-DATEV-Wie-stelle-ich-eine-Verbindung-mit-DATEV-her">
    Step-by-step instructions to connect your DATEV account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | tax\_id               |       |
      | gender                |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | name                    |       |
      | unit                    |       |
      | half\_days\_supported   |       |
      | exact\_times\_supported |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | amount              |       |
      | unit                |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | OAuth              |       |
    | API Passthrough    |       |
    | Scope Testing      |       |
    | Connection Guide   |       |
    | Employment History |       |
    | Group Types        |       |
    | DEPARTMENT         |       |
    | COST\_CENTER       |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Our latest DATEV integration supporting the new Lohnaustauschdatenservice, to synchronize data bidirectional in real time. It also supports the legacy ASCII write interface. Works with both DATEV payroll products: LODAS and Lohn und Gehalt

For **DATEV**, we also offer the following other connector variants:

<CardGroup>
  <Card title="DATEV HR" icon="https://storage.googleapis.com/kombo-assets/integrations/datevhr/icon.svg" href="/hris/connectors/datevhr">
    Legacy DATEV HR integration using the Lohnergebnisdatenservice API, to synchronize data with the monthly payroll results and only the ASCII write interface. This is slightly cheaper for the end customer than the DATEV LAUDS integration. Works with both DATEV payroll products: LODAS and Lohn und Gehalt
  </Card>

  <Card title="DATEV LODAS" icon="https://storage.googleapis.com/kombo-assets/integrations/datev/icon.svg" href="/hris/connectors/datev">
    Our legacy LODAS integration. No data can be read from DATEV
  </Card>

  <Card title="DATEV Lohn & Gehalt" icon="https://storage.googleapis.com/kombo-assets/integrations/datevlug/icon.svg" href="/hris/connectors/datevlug">
    Our legacy Lohn und Gehalt integration. No data can be read from DATEV
  </Card>
</CardGroup>

<Note>Multiple variants can be used within your Kombo environment at the same time.</Note>


# DATEV Lohn & Gehalt HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/datevlug

DATEV Lohn & Gehalt connector for Kombo's HRIS API

<Note>This connector requires a custom Kombo plan. Please contact us to enable it.</Note>

The DATEV Lohn & Gehalt HRIS integration allows you to sync HRIS data between DATEV Lohn & Gehalt and your application through Kombo's unified API. The tool slug for this connector is `datevlug`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/17624306602641-Wie-verbinde-ich-meinen-DATEV-LODAS-Account-">
    Step-by-step instructions to connect your DATEV Lohn & Gehalt account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Absence Types">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | name                    |       |
      | unit                    |       |
      | exact\_times\_supported |       |
      | remote\_data            |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create absence">
      | Input Field       | Notes |
      | ----------------- | ----- |
      | employee\_id      |       |
      | absence\_type\_id |       |
      | start\_date       |       |
      | end\_date         |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | OAuth            |       |
    | Scope Testing    |       |
    | Connection Guide |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Our legacy Lohn und Gehalt integration. No data can be read from DATEV

For **DATEV Lohn & Gehalt**, we also offer the following other connector variants:

<CardGroup>
  <Card title="DATEV" icon="https://storage.googleapis.com/kombo-assets/integrations/datevlauds/icon.svg" href="/hris/connectors/datevlauds">
    Our latest DATEV integration supporting the new Lohnaustauschdatenservice, to synchronize data bidirectional in real time. It also supports the legacy ASCII write interface. Works with both DATEV payroll products: LODAS and Lohn und Gehalt
  </Card>

  <Card title="DATEV HR" icon="https://storage.googleapis.com/kombo-assets/integrations/datevhr/icon.svg" href="/hris/connectors/datevhr">
    Legacy DATEV HR integration using the Lohnergebnisdatenservice API, to synchronize data with the monthly payroll results and only the ASCII write interface. This is slightly cheaper for the end customer than the DATEV LAUDS integration. Works with both DATEV payroll products: LODAS and Lohn und Gehalt
  </Card>

  <Card title="DATEV LODAS" icon="https://storage.googleapis.com/kombo-assets/integrations/datev/icon.svg" href="/hris/connectors/datev">
    Our legacy LODAS integration. No data can be read from DATEV
  </Card>
</CardGroup>

<Note>Multiple variants can be used within your Kombo environment at the same time.</Note>


# Dayforce HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/dayforce

Dayforce connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Dayforce HRIS integration allows you to sync HRIS data between Dayforce and your application through Kombo's unified API. The tool slug for this connector is `dayforce`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/36072225356433">
    Step-by-step instructions to connect your Dayforce account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | ethnicity             |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | work\_location\_id    |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | API Passthrough       |       |
    | Delta Syncs           |       |
    | Custom Field Explorer |       |
    | Employees             |       |
    | Connection Guide      |       |
    | Group Types           |       |
    | DEPARTMENT            |       |
    | COST\_CENTER          |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Note>
      The custom Employee Properties are followup calls to the Dayforce API and can partially fail. This means you create a new employee, but some custom properties are not created.
    </Note>

    <Info>
      Some **optional** form fields are referencing the following data models:

      * Employees

      Consider enabling these in your [scope configuration](/hris/features/scopes).
    </Info>

    <Warning>
      This form may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
    </Warning>

    <ResponseField name="FirstName" type="text">**First Name**<br />
    The first name of the employee<br />
    Unified field: `first_name`</ResponseField>
    <ResponseField name="LastName" type="text">**Last Name**<br />
    The last name of the employee<br />
    Unified field: `last_name`</ResponseField>
    <ResponseField name="BirthDate" type="date">**Date of Birth**<br />
    The employee's date of birth<br />
    Unified field: `date_of_birth`</ResponseField>

    <ResponseField name="Culture" type="single_select" />

    <ResponseField name="HireDate" type="date">**Start Date**<br />
    Start date of the employee. Also considered to be the hire date<br />
    Unified field: `start_date`</ResponseField>
    <ResponseField name="SocialSecurityNumber" type="text">**Social Security Number**<br />
    The Social Security Number can be required depending on the seeing of Dayforce.</ResponseField>
    <ResponseField name="Gender" type="single_select">The gender of the employee</ResponseField>
    <ResponseField name="SeniorityDate" type="date">**Seniority Date**</ResponseField>
    <ResponseField name="SendFirstTimeAccessEmail" type="checkbox">**Send First Time Access Email**</ResponseField>
    <ResponseField name="RetirementRequestDate" type="date">**Retirement Request Date**</ResponseField>
    <ResponseField name="EmployeeId" type="number">**Employee ID**</ResponseField>
    <ResponseField name="XRefCode" type="text">**Username**<br />
    The username for the employee, which is also the XRefCode.</ResponseField>

    <ResponseField name="Addresses" type="object">
      <Expandable title="properties">
        <ResponseField name="Address1" type="text">**Street 1**<br />
        The street address of the employee<br />
        Unified field: `home_address.street_1`</ResponseField>
        <ResponseField name="City" type="text">The city of the employee<br />
        Unified field: `home_address.city`</ResponseField>
        <ResponseField name="PostalCode" type="text">**ZIP Code**<br />
        The ZIP code of the employee<br />
        Unified field: `home_address.zip_code`</ResponseField>
        <ResponseField name="State" type="single_select">The XRefCode of the state</ResponseField>
        <ResponseField name="Country" type="single_select">The XRefCode of the country</ResponseField>
        <ResponseField name="EffectiveStart" type="date">**Effective Start**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="Contacts" type="object">
      <Expandable title="properties">
        <ResponseField name="HomePhone" type="object">
          **Home Phone**

          <Expandable title="properties">
            <ResponseField name="ContactNumber" type="text">**Mobile Phone Number**<br />
            The mobile phone number of the employee<br />
            Unified field: `mobile_phone_number`</ResponseField>
            <ResponseField name="EffectiveStart" type="date">**Effective Start**</ResponseField>
            <ResponseField name="EffectiveEnd" type="date">**Effective End**</ResponseField>
            <ResponseField name="Country" type="single_select">The XRefCode of the country</ResponseField>
            <ResponseField name="Extension" type="text">The extension of the phone number</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="PersonalEmail" type="object">
          **Personal Email**

          <Expandable title="properties">
            <ResponseField name="ElectronicAddress" type="text">**Private Email**<br />
            The private email address of the employee<br />
            Unified field: `private_email`</ResponseField>
            <ResponseField name="EffectiveStart" type="date">**Effective Start**</ResponseField>
            <ResponseField name="EffectiveEnd" type="date">**Effective End**</ResponseField>
            <ResponseField name="Country" type="single_select">The XRefCode of the country</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="BusinessEmail" type="object">
          **Business Email**

          <Expandable title="properties">
            <ResponseField name="ElectronicAddress" type="text">**Work Email**<br />
            The email address of the employee<br />
            Unified field: `work_email`</ResponseField>
            <ResponseField name="EffectiveStart" type="date">**Effective Start**</ResponseField>
            <ResponseField name="EffectiveEnd" type="date">**Effective End**</ResponseField>
            <ResponseField name="Country" type="single_select">The XRefCode of the country</ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="EmploymentStatuses" type="object">
      **Employment Status**

      <Expandable title="properties">
        <ResponseField name="PayType" type="single_select">**Pay Type**</ResponseField>
        <ResponseField name="PayClass" type="single_select">**Pay Class**</ResponseField>
        <ResponseField name="PayGroup" type="single_select">**Pay Group**</ResponseField>
        <ResponseField name="BaseRate" type="number">**Base Rate**</ResponseField>
        <ResponseField name="BaseSalary" type="number">**Base Salary**<br />
        Unified field: `yearly_salary`</ResponseField>
        <ResponseField name="MonthlyHours" type="number">**Monthly Hours**</ResponseField>
        <ResponseField name="AverageDailyHours" type="number">**Average Daily Hours**</ResponseField>
        <ResponseField name="TargetBonus" type="number">**Target Bonus**</ResponseField>
        <ResponseField name="FTEAnnualSalary" type="number">**FTE Annual Salary**</ResponseField>
        <ResponseField name="ShiftRotation" type="single_select">**Shift Rotation**</ResponseField>
        <ResponseField name="ShiftRotationDayOffset" type="number">**Shift Rotation Day Offset**</ResponseField>
        <ResponseField name="ShiftRotationStartDate" type="date">**Shift Rotation Start Date**</ResponseField>
        <ResponseField name="CreateShiftRotationShift" type="checkbox">**Create Shift Rotation Shift**</ResponseField>
        <ResponseField name="PayHolidayGroup" type="single_select">**Pay Holiday Group**</ResponseField>
        <ResponseField name="EmployeeGroup" type="single_select">**Employee Group**</ResponseField>
        <ResponseField name="PayPolicy" type="single_select">**Pay Policy**</ResponseField>
        <ResponseField name="EntitlementPolicy" type="single_select">**Entitlement Policy**</ResponseField>
        <ResponseField name="TimeOffPolicy" type="single_select">**Time Off Policy**</ResponseField>
        <ResponseField name="PayrollPolicy" type="single_select">**Payroll Policy**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="Roles" type="object">
      <Expandable title="properties">
        <ResponseField name="Role" type="text">The XRefCode of the role of the employee</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="UnionMemberships" type="object">
      **Union Memberships**

      <Expandable title="properties">
        <ResponseField name="Union" type="single_select">Union</ResponseField>
        <ResponseField name="UnionMembershipDate" type="date">**Union Membership Date**</ResponseField>
        <ResponseField name="EffectiveStart" type="date">**Effective Start**</ResponseField>
        <ResponseField name="EffectiveEnd" type="date">**Effective End**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="WorkAssignments" type="object">
      **Work Assignments**

      <Expandable title="properties">
        <ResponseField name="Position" type="single_select" />

        <ResponseField name="Location" type="single_select" />

        <ResponseField name="EffectiveStart" type="date">**Effective Start**</ResponseField>
        <ResponseField name="IsVirtual" type="checkbox">**Is Virtual**</ResponseField>
        <ResponseField name="BusinessTitle" type="text">**Business Title**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="WorkContracts" type="object">
      **Work Contracts**

      <Expandable title="properties">
        <ResponseField name="EndDate" type="date">**End Date**</ResponseField>
        <ResponseField name="AverageNumOfDays" type="number">**Average Number of Days**</ResponseField>
        <ResponseField name="BaseHours" type="number">**Base Hours**</ResponseField>
        <ResponseField name="BaseComplementaryHours" type="number">**Base Complementary Hours**</ResponseField>
        <ResponseField name="ContractWorkPercent" type="number">**Contract Work Percent**</ResponseField>
        <ResponseField name="CreateShiftOnHolidays" type="checkbox">**Create Shift on Holidays**</ResponseField>
        <ResponseField name="FullTimeHours" type="number">**Full Time Hours**</ResponseField>
        <ResponseField name="StartDate" type="date">**Start Date**</ResponseField>
        <ResponseField name="WorkPatternLengthDays" type="number">**Work Pattern Length Days**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="OnboardingPolicies" type="object">
      **Onboarding Policies**

      <Expandable title="properties">
        <ResponseField name="OnboardingPolicy" type="text">**Onboarding Policy**<br />
        The XRefCode of the onboarding policy</ResponseField>
        <ResponseField name="EffectiveStart" type="date">**Effective Start**</ResponseField>
        <ResponseField name="EffectiveEnd" type="date">**Effective End**</ResponseField>
        <ResponseField name="IsInternalHire" type="checkbox">**Is Internal Hire**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="EmployeeManagers" type="object">
      **Employee Managers**

      <Expandable title="properties">
        <ResponseField name="EffectiveStart" type="date">**Effective Start**</ResponseField>
        <ResponseField name="EffectiveEnd" type="date">**Effective End**</ResponseField>
        <ResponseField name="ManagerXRefCode" type="single_select">**Manager XRefCode**<br />
        References `/v1/hris/employees?remote_model=employee`</ResponseField>
        <ResponseField name="ManagerType" type="text">**Manager Type**<br />
        The type of manager</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="EmployeeProperties" type="object">
      **Custom Employee Properties**

      <Expandable title="properties">
        <Warning>
          This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
        </Warning>
      </Expandable>
    </ResponseField>
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Dayforce

For **Dayforce**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Dayforce ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/dayforce/icon.svg" href="/ats/connectors/dayforce">
    Dayforce for the ATS category
  </Card>
</CardGroup>


# Deel HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/deel

Deel connector for Kombo's HRIS API

The Deel HRIS integration allows you to sync HRIS data between Deel and your application through Kombo's unified API. The tool slug for this connector is `deel`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/18401663397521">
    Step-by-step instructions to connect your Deel account to Kombo.
  </Card>

  <Card title="Partnership Guide" icon="handshake" href="https://help.kombo.dev/hc/en-us/articles/18977903676433-Deel-How-to-get-your-Partner-Credentials">
    Learn how to become a partner with Deel to enable this integration.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | display\_full\_name |       |
      | job\_title          |       |
      | work\_email         |       |
      | personal\_email     |       |
      | gender              |       |
      | employment\_status  |       |
      | employment\_type    |       |
      | work\_location\_id  |       |
      | legal\_entity\_id   |       |
      | manager\_id         |       |
      | home\_address       |       |
      | date\_of\_birth     |       |
      | start\_date         |       |
      | termination\_date   |       |
      | remote\_created\_at |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | name                    |       |
      | unit                    |       |
      | half\_days\_supported   |       |
      | exact\_times\_supported |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_half\_day    |       |
      | end\_half\_day      |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Time Off Balances">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | type\_id            |       |
      | balance             |       |
      | balance\_unit       |       |
      | used                |       |
      | used\_unit          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create absence">
      <Note>
        Everything in Deel works through contracts, creating an absence requires that the employee has an active contract. We use the employee's latest active contract to register the absence.
      </Note>

      | Input Field       | Notes |
      | ----------------- | ----- |
      | employee\_id      |       |
      | absence\_type\_id |       |
      | start\_date       |       |
      | end\_date         |       |
      | start\_half\_day  |       |
      | end\_half\_day    |       |
      | employee\_note    |       |
    </Accordion>

    <Accordion title="Delete absence">
      | Input Field | Notes |
      | ----------- | ----- |
      | absence\_id |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | OAuth            |       |
    | API Passthrough  |       |
    | Connection Guide |       |
    | Prerequisites    |       |
    | Locate Admin     |       |
    | Group Types      |       |
    | TEAM             |       |
    | DEPARTMENT       |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Info>
      Some **required** form fields are referencing the following data models:

      * Groups
      * Legal Entities

      Additionally, there are some **optional** form fields that reference:

      * Employees
      * Groups

      Consider enabling these in your [scope configuration](/hris/features/scopes).
    </Info>

    <ResponseField name="client" type="object">
      **Organization**<br />
      Where the new employee sits in your Deel organization.

      <Expandable title="properties">
        <ResponseField name="legalEntity" type="single_select">**Legal Entity**<br />
        Unified field: `legal_entity_id`<br />
        References `/v1/hris/legal-entities?remote_model=legal_entity`</ResponseField>
        <ResponseField name="team" type="single_select">**Team**<br />
        References `/v1/hris/groups?types=TEAM`</ResponseField>
        <ResponseField name="department" type="single_select">**Department**<br />
        References `/v1/hris/groups?types=DEPARTMENT`</ResponseField>
        <ResponseField name="directManager" type="single_select">**Direct Manager**<br />
        References `/v1/hris/employees?remote_model=employee`</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="employee" type="object">
      **Employee**<br />
      Personal details for the new employee.

      <Expandable title="properties">
        <ResponseField name="email" type="text">**Private Email**<br />
        The personal email of the employee.<br />
        Unified field: `private_email`</ResponseField>
        <ResponseField name="first_name" type="text">**First Name**<br />
        The first name of the employee<br />
        Unified field: `first_name`</ResponseField>
        <ResponseField name="last_name" type="text">**Last Name**<br />
        The last name of the employee<br />
        Unified field: `last_name`</ResponseField>
        <ResponseField name="nationality" type="text">**Nationality**<br />
        The uppercase two-letter ISO country (e.g., DE)<br />
        Unified field: `nationality`</ResponseField>
        <ResponseField name="country" type="text">**Country**<br />
        The country where the employee works, as an uppercase two-letter ISO code (e.g., DE).</ResponseField>
        <ResponseField name="work_email" type="text">**Work Email**<br />
        The email address of the employee<br />
        Unified field: `work_email`</ResponseField>
        <ResponseField name="preferred_first_name" type="text">**Preferred First Name**</ResponseField>
        <ResponseField name="preferred_last_name" type="text">**Preferred Last Name**</ResponseField>
        <ResponseField name="external_id" type="text">**External ID**<br />
        An external identifier to store on the employee.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="employment" type="object">
      **Employment**<br />
      Job, seniority, and contract dates. Deel requires all of these to issue a direct-employee contract.

      <Expandable title="properties">
        <ResponseField name="start_date" type="date">**Start Date**<br />
        Start date of the employee. Also considered to be the hire date<br />
        Unified field: `start_date`</ResponseField>
        <ResponseField name="job_title" type="text">**Job Title**<br />
        The title of the position this person is working in<br />
        Unified field: `job_title`</ResponseField>
        <ResponseField name="seniority" type="single_select">**Seniority**</ResponseField>
        <ResponseField name="type" type="single_select">**Employment Type**</ResponseField>
        <ResponseField name="part_time_percentage" type="number">**Part-time Percentage**<br />
        Required when Employment Type is Part-time.</ResponseField>
        <ResponseField name="end_date" type="date">**End Date**<br />
        The end date of the employment, for fixed-term hires.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="compensation_details" type="object">
      **Compensation**<br />
      Annual gross salary and pay currency.

      <Expandable title="properties">
        <ResponseField name="salary" type="number">**Yearly Salary**<br />
        The gross annual salary, in the chosen currency.<br />
        Unified field: `yearly_salary`</ResponseField>
        <ResponseField name="currency" type="single_select">**Currency**<br />
        The ISO-4217 currency code. Must match one of the legal entity's allowed currencies.</ResponseField>
      </Expandable>
    </ResponseField>
  </Tab>
</Tabs>


# Employment Hero HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/employmenthero

Employment Hero connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Employment Hero HRIS integration allows you to sync HRIS data between Employment Hero and your application through Kombo's unified API. The tool slug for this connector is `employmenthero`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/29329028481041">
    Step-by-step instructions to connect your Employment Hero account to Kombo.
  </Card>
</CardGroup>

## General Notes

* The Employment Hero account used in the connection flow determines the data which the integration can read (e.g. an employee connecting will not be able to see the organization owner's information). We therefore recommend the owner of the Employment Hero account to connect the integration.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | gender                |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | avatar                |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      <Note>
        Employment Hero's HR API does not include an endpoint to retrieve all possible absence types. Kombo can therefore only read and return absence types of already-existing absences.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | employment\_type    |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | OAuth              |       |
    | API Passthrough    |       |
    | Scope Testing      |       |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
    | Employment History |       |
    | Group Types        |       |
    | TEAM               |       |
  </Tab>
</Tabs>


# Microsoft Entra ID HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/entraid

Microsoft Entra ID connector for Kombo's HRIS API

The Microsoft Entra ID HRIS integration allows you to sync HRIS data between Microsoft Entra ID and your application through Kombo's unified API. The tool slug for this connector is `entraid`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/20372742922897">
    Step-by-step instructions to connect your Microsoft Entra ID account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | avatar                |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee">
      <Note>
        Azure / entra requires a password to be set when creating a user. The user has to use the password on his initial sign-in and will be forced to change the password once signed in. The work\_email field is required. The domain of the submitted email has to be one of the verified domains in the organization.
      </Note>

      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | job\_title              |       |
      | home\_address.street\_1 |       |
      | home\_address.city      |       |
      | home\_address.zip\_code |       |
      | home\_address.country   |       |
      | date\_of\_birth         |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | OAuth                 |       |
    | API Passthrough       |       |
    | Additional Scopes     |       |
    | Custom Field Explorer |       |
    | Employees             |       |
    | Connection Guide      |       |
    | Prerequisites         |       |
    | Group Types           |       |
    | DEPARTMENT            |       |
    | COST\_CENTER          |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Info>
      Some **optional** form fields are referencing the following data models:

      * Groups

      Consider enabling these in your [scope configuration](/hris/features/scopes).
    </Info>

    <ResponseField name="firstName" type="text">**First Name**<br />
    The first name of the employee<br />
    Unified field: `first_name`</ResponseField>
    <ResponseField name="lastName" type="text">**Last Name**<br />
    The last name of the employee<br />
    Unified field: `last_name`</ResponseField>
    <ResponseField name="workEmail" type="text">**Work Email**<br />
    The email address of the employee<br />
    Unified field: `work_email`</ResponseField>
    <ResponseField name="password" type="text">**Password**<br />
    Azure / entra requires a password to be set when creating a user. The user has to use the password on his initial sign-in and will be forced to change the password once signed in.</ResponseField>
    <ResponseField name="businessPhones" type="text">**Business Phones**<br />
    The telephone numbers for the user.<br />
    Unified field: `mobile_phone_number`</ResponseField>
    <ResponseField name="mobilePhone" type="text">**Mobile Phone Number**<br />
    The mobile phone number of the employee<br />
    Unified field: `mobile_phone_number`</ResponseField>
    <ResponseField name="faxNumber" type="text">**Fax Number**<br />
    The fax number of the user.</ResponseField>

    <ResponseField name="otherMails" type="array">
      **Other Mails**<br />
      A list of additional email addresses for the user; for example: \['[bob@contoso.com](mailto:bob@contoso.com)', '[Robert@fabrikam.com](mailto:Robert@fabrikam.com)']. This cannot contain accent characters.

      <Expandable title="items">
        <ResponseField name="Item" type="text" />
      </Expandable>
    </ResponseField>

    <ResponseField name="city" type="text">**City**<br />
    The city in which the user is located.<br />
    Unified field: `home_address.city`</ResponseField>
    <ResponseField name="country" type="text">**Country or Region**<br />
    The country or region in which the user is located; for example, US or UK.<br />
    Unified field: `home_address.country`</ResponseField>
    <ResponseField name="postalCode" type="text">**Postal Code**<br />
    The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code.<br />
    Unified field: `home_address.zip_code`</ResponseField>
    <ResponseField name="state" type="text">**State**<br />
    The state or province in the user's address.<br />
    Unified field: `home_address.state`</ResponseField>
    <ResponseField name="streetAddress" type="text">**Street Address**<br />
    The street address of the user's place of business.<br />
    Unified field: `home_address.street_1`</ResponseField>
    <ResponseField name="officeLocation" type="text">**Office Location**<br />
    The office location in the user's place of business.</ResponseField>
    <ResponseField name="companyName" type="text">**Company Name**<br />
    The company name which the user is associated. This property can be useful for describing the company that an external user comes from.</ResponseField>
    <ResponseField name="department" type="text">**Department**<br />
    The name for the department in which the user works.</ResponseField>
    <ResponseField name="employeeId" type="text">**Employee ID**<br />
    The employee identifier assigned to the user by the organization.</ResponseField>
    <ResponseField name="employeeHireDate" type="date">**Start Date**<br />
    Start date of the employee. Also considered to be the hire date<br />
    Unified field: `start_date`</ResponseField>
    <ResponseField name="employeeType" type="single_select">**Employee Type**<br />
    Captures the type of employment for the user.</ResponseField>
    <ResponseField name="jobTitle" type="text">**Job Title**<br />
    The user's job title.<br />
    Unified field: `job_title`</ResponseField>

    <ResponseField name="employeeOrgData" type="object">
      **Employee Organization Data**<br />
      Represents organization data (for example, division and costCenter).

      <Expandable title="properties">
        <ResponseField name="costCenter" type="single_select">**Cost Center**<br />
        The cost center associated with the user.<br />
        References `/v1/hris/groups?types=COST_CENTER`</ResponseField>
        <ResponseField name="division" type="single_select">**Division**<br />
        The name of the division in which the user works.<br />
        References `/v1/hris/groups?types=DEPARTMENT`</ResponseField>
      </Expandable>
    </ResponseField>
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Current Microsoft Entra ID integration (recommended for new connections)

For **Microsoft Entra ID**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Microsoft Azure AD" icon="https://storage.googleapis.com/kombo-assets/integrations/azuread/icon.svg" href="/hris/connectors/azuread">
    Legacy Azure AD integration. Microsoft rebranded Azure AD to Entra ID. Both variants work, but consider using Entra ID for new connections
  </Card>
</CardGroup>

<Note>You can only use one variant at a time.</Note>


# Eurécia HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/eurecia

Eurécia connector for Kombo's HRIS API

The Eurécia HRIS integration allows you to sync HRIS data between Eurécia and your application through Kombo's unified API. The tool slug for this connector is `eurecia`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/24073440546321-Eur%C3%A9cia-How-do-I-link-my-account">
    Step-by-step instructions to connect your Eurécia account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | name                  |       |
      | unit                  |       |
      | half\_days\_supported |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_half\_day    |       |
      | end\_half\_day      |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | pay\_currency       |       |
      | effective\_date     |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Time Off Balances">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | type\_id            |       |
      | balance             |       |
      | balance\_unit       |       |
      | used                |       |
      | used\_unit          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | API Passthrough    |       |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
    | Group Types        |       |
    | DEPARTMENT         |       |
  </Tab>
</Tabs>


# Factorial HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/factorial

Factorial connector for Kombo's HRIS API

The Factorial HRIS integration allows you to sync HRIS data between Factorial and your application through Kombo's unified API. The tool slug for this connector is `factorial`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/18743884123409">
    Step-by-step instructions to connect your Factorial account to Kombo.
  </Card>

  <Card title="Sandbox Environment" icon="flask" href="https://factorialhr.com/get-started">
    Access the Factorial sandbox environment for testing and development.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      <Note>
        We don't get the actual `employment_status` from the Factorial API, only the start and termination dates. Therefore, we infer the status based on those. We don't get the actual employment\_type from Factorial but just the working\_hours. Therefore, we calculate the type based on that.
      </Note>

      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | name                  |       |
      | unit                  |       |
      | half\_days\_supported |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_half\_day    |       |
      | end\_half\_day      |       |
      | unit                |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create absence">
      | Input Field       | Notes |
      | ----------------- | ----- |
      | employee\_id      |       |
      | absence\_type\_id |       |
      | start\_date       |       |
      | end\_date         |       |
      | start\_half\_day  |       |
      | end\_half\_day    |       |
      | amount            |       |
      | employee\_note    |       |
    </Accordion>

    <Accordion title="Delete absence">
      | Input Field | Notes |
      | ----------- | ----- |
      | absence\_id |       |
    </Accordion>

    <Accordion title="Create employee">
      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | gender                  |       |
      | home\_address.street\_1 |       |
      | home\_address.street\_2 |       |
      | home\_address.city      |       |
      | home\_address.state     |       |
      | home\_address.zip\_code |       |
      | home\_address.country   |       |
      | date\_of\_birth         |       |
      | mobile\_phone\_number   |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | OAuth              |       |
    | API Passthrough    |       |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
    | Employment History |       |
    | Group Types        |       |
    | TEAM               |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Factorial

For **Factorial**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Factorial ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/factorial/icon.svg" href="/ats/connectors/factorial">
    Factorial for the ATS category
  </Card>
</CardGroup>


# Fourth HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/fourth

Fourth connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Fourth HRIS integration allows you to sync HRIS data between Fourth and your application through Kombo's unified API. The tool slug for this connector is `fourth`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/38728787663121-FourthHR-How-do-I-link-my-account">
    Step-by-step instructions to connect your Fourth account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | gender                |       |
      | ethnicity             |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | work\_location\_id    |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | API Passthrough       |       |
    | Delta Syncs           |       |
    | Custom Field Explorer |       |
    | Employees             |       |
    | Employments           |       |
    | Connection Guide      |       |
    | Group Types           |       |
    | DEPARTMENT            |       |
  </Tab>
</Tabs>


# Google Workspace HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/googleworkspace

Google Workspace connector for Kombo's HRIS API

The Google Workspace HRIS integration allows you to sync HRIS data between Google Workspace and your application through Kombo's unified API. The tool slug for this connector is `googleworkspace`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/15719650405521">
    Step-by-step instructions to connect your Google Workspace account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | address             |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | gender                |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | avatar                |       |
      | work\_location\_id    |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | parent\_id          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee">
      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | gender                  |       |
      | job\_title              |       |
      | home\_address.street\_1 |       |
      | home\_address.street\_2 |       |
      | home\_address.city      |       |
      | home\_address.state     |       |
      | home\_address.zip\_code |       |
      | home\_address.country   |       |
      | date\_of\_birth         |       |
      | mobile\_phone\_number   |       |
      | start\_date             |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | OAuth              |       |
    | API Passthrough    |       |
    | Additional Scopes  |       |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Locate Admin       |       |
    | Create credentials |       |
    | Group Types        |       |
    | TEAM               |       |
    | DEPARTMENT         |       |
    | COST\_CENTER       |       |
  </Tab>
</Tabs>


# Gusto HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/gusto

Gusto connector for Kombo's HRIS API

<Note>This connector requires a partnership with Gusto. Please contact us to get access.</Note>

The Gusto HRIS integration allows you to sync HRIS data between Gusto and your application through Kombo's unified API. The tool slug for this connector is `gusto`.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | employment\_type    |       |
      | effective\_date     |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee">
      <Note>
        Gusto requires a personal email address to create an employee. This personal email address needs to be submitted through the `work_email` field. Gusto requires an input for which company to add an employee to. Most instances we see have just one company. We will default to the first company we find if `legal_entity_id` is not provided in the request body.
      </Note>

      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | gender                  |       |
      | job\_title              |       |
      | home\_address.street\_1 |       |
      | home\_address.city      |       |
      | home\_address.zip\_code |       |
      | home\_address.country   |       |
      | date\_of\_birth         |       |
      | start\_date             |       |
      | legal\_entity\_id       |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature         | Notes |
    | --------------- | ----- |
    | OAuth           |       |
    | API Passthrough |       |
    | Group Types     |       |
    | DEPARTMENT      |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Info>
      Some **required** form fields are referencing the following data models:

      * Legal Entities

      Consider enabling these in your [scope configuration](/hris/features/scopes).
    </Info>

    <ResponseField name="first_name" type="text">**First Name**<br />
    The first name of the employee<br />
    Unified field: `first_name`</ResponseField>
    <ResponseField name="middle_initial" type="text">**Middle Initial**</ResponseField>
    <ResponseField name="last_name" type="text">**Last Name**<br />
    The last name of the employee<br />
    Unified field: `last_name`</ResponseField>
    <ResponseField name="email" type="text">**Private Email**<br />
    The private email address of the employee<br />
    Unified field: `private_email`</ResponseField>
    <ResponseField name="work_email" type="text">**Work Email**<br />
    The email address of the employee<br />
    Unified field: `work_email`</ResponseField>
    <ResponseField name="preferred_first_name" type="text">**Preferred First Name**</ResponseField>
    <ResponseField name="self_onboarding" type="checkbox">**Self Onboarding**<br />
    If true, employee is expected to self-onboard. If false, payroll admin will enter onboarding information.</ResponseField>
    <ResponseField name="ssn" type="text">**SSN**</ResponseField>
    <ResponseField name="date_of_birth" type="date">**Date of Birth**<br />
    The employee's date of birth<br />
    Unified field: `date_of_birth`</ResponseField>
    <ResponseField name="company_id" type="single_select">**Legal Entity ID**<br />
    The Kombo ID of the legal entity the employee should be in<br />
    Unified field: `legal_entity_id`<br />
    References `/v1/hris/legal-entities?remote_model=legal_entity`</ResponseField>
  </Tab>
</Tabs>


# Hailey HR HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/haileyhr

Hailey HR connector for Kombo's HRIS API

The Hailey HR HRIS integration allows you to sync HRIS data between Hailey HR and your application through Kombo's unified API. The tool slug for this connector is `haileyhr`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/18742611341969">
    Step-by-step instructions to connect your Hailey HR account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      <Note>
        We do not expose the personal identity number for HaileyHR.
      </Note>

      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | gender                |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_half\_day    |       |
      | end\_half\_day      |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      <Note>
        Hailey HR does not expose the job title of an employee's historical employments. We're mapping the employee's current job title into the `job_title` field.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | custom\_fields      |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | API Passthrough    |       |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
    | Group Types        |       |
    | TEAM               |       |
    | DEPARTMENT         |       |
    | COST\_CENTER       |       |
  </Tab>
</Tabs>


# Hansalog HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/hansalog

Hansalog connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Hansalog HRIS integration allows you to sync HRIS data between Hansalog and your application through Kombo's unified API. The tool slug for this connector is `hansalog`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/37916802902161-Hansalog-How-do-I-link-my-account">
    Step-by-step instructions to connect your Hansalog account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes                                                                                                                                               |
      | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
      | id                    |                                                                                                                                                     |
      | remote\_id            |                                                                                                                                                     |
      | changed\_at           |                                                                                                                                                     |
      | remote\_deleted\_at   |                                                                                                                                                     |
      | employee\_number      |                                                                                                                                                     |
      | first\_name           |                                                                                                                                                     |
      | last\_name            |                                                                                                                                                     |
      | nationality           |                                                                                                                                                     |
      | display\_full\_name   |                                                                                                                                                     |
      | job\_title            |                                                                                                                                                     |
      | work\_email           |                                                                                                                                                     |
      | personal\_email       |                                                                                                                                                     |
      | mobile\_phone\_number |                                                                                                                                                     |
      | ssn                   |                                                                                                                                                     |
      | tax\_id               |                                                                                                                                                     |
      | gender                |                                                                                                                                                     |
      | marital\_status       | We infer marital status from the `Steuerklasse` field in the `EmployeeMainData` response. Steuerklasse 3, 4, and 5 are married, 1 and 2 are single. |
      | employment\_status    |                                                                                                                                                     |
      | weekly\_hours         |                                                                                                                                                     |
      | legal\_entity\_id     |                                                                                                                                                     |
      | manager\_id           |                                                                                                                                                     |
      | home\_address         |                                                                                                                                                     |
      | bank\_accounts        |                                                                                                                                                     |
      | date\_of\_birth       |                                                                                                                                                     |
      | start\_date           |                                                                                                                                                     |
      | termination\_date     |                                                                                                                                                     |
      | custom\_fields        |                                                                                                                                                     |
      | integration\_fields   |                                                                                                                                                     |
      | remote\_data          |                                                                                                                                                     |
    </Accordion>

    <Accordion title="Groups">
      <Note>
        Unless "Sync departments from the organizational hierarchy" is enabled, we infer groups from the `Abteilung` field of the employee to form the department.
      </Note>

      | Field               | Notes                                                                                                                                                     |
      | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
      | id                  |                                                                                                                                                           |
      | remote\_id          |                                                                                                                                                           |
      | changed\_at         |                                                                                                                                                           |
      | remote\_deleted\_at |                                                                                                                                                           |
      | name                |                                                                                                                                                           |
      | type                | Hansalog's org entity `Type` field (e.g. Bereich, Hauptabteilung) doesn't map cleanly to Kombo's DEPARTMENT/TEAM/COST\_CENTER — we default to DEPARTMENT. |
      | parent\_id          |                                                                                                                                                           |
      | remote\_data        |                                                                                                                                                           |
    </Accordion>

    <Accordion title="Employee Document Categories">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Add document to employee">
      | Input Field            | Notes |
      | ---------------------- | ----- |
      | employee\_id           |       |
      | category\_id           |       |
      | document.name          |       |
      | document.content\_type |       |
      | document.data\_url     |       |
      | document.data          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | API Passthrough  |       |
    | Connection Guide |       |
    | Group Types      |       |
    | DEPARTMENT       |       |
  </Tab>
</Tabs>


# HeavenHR HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/heavenhr

HeavenHR connector for Kombo's HRIS API

The HeavenHR HRIS integration allows you to sync HRIS data between HeavenHR and your application through Kombo's unified API. The tool slug for this connector is `heavenhr`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/20587609783313">
    Step-by-step instructions to connect your HeavenHR account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_number    |       |
      | first\_name         |       |
      | last\_name          |       |
      | job\_title          |       |
      | work\_email         |       |
      | personal\_email     |       |
      | gender              |       |
      | employment\_status  |       |
      | employment\_type    |       |
      | weekly\_hours       |       |
      | work\_location\_id  |       |
      | legal\_entity\_id   |       |
      | home\_address       |       |
      | date\_of\_birth     |       |
      | start\_date         |       |
      | termination\_date   |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | name                  |       |
      | half\_days\_supported |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | effective\_date     |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | API Passthrough    |       |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
    | Group Types        |       |
    | DEPARTMENT         |       |
    | COST\_CENTER       |       |
  </Tab>
</Tabs>


# HiBob HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/hibob

HiBob connector for Kombo's HRIS API

The HiBob HRIS integration allows you to sync HRIS data between HiBob and your application through Kombo's unified API. The tool slug for this connector is `hibob`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/15410713576337-How-do-I-link-my-HiBob-account-">
    Step-by-step instructions to connect your HiBob account to Kombo.
  </Card>
</CardGroup>

## General Notes

* OAuth is supported and is required to list your app on the HiBob Marketplace. You can enable OAuth in the integration Settings tab by entering your HiBob Developer Portal credentials there.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | ethnicity             |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | avatar                |       |
      | work\_location\_id    |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | unit                |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | approver\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_half\_day    |       |
      | end\_half\_day      |       |
      | start\_time         |       |
      | end\_time           |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
    </Accordion>

    <Accordion title="Time Off Balances">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | type\_id            |       |
      | balance             |       |
      | balance\_unit       |       |
      | used                |       |
      | used\_unit          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee Document Categories">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create absence">
      <Note>
        Specifying absence status might not work consistently for all absence types
      </Note>

      | Input Field       | Notes |
      | ----------------- | ----- |
      | employee\_id      |       |
      | absence\_type\_id |       |
      | status            |       |
      | start\_date       |       |
      | end\_date         |       |
      | start\_half\_day  |       |
      | end\_half\_day    |       |
      | employee\_note    |       |
    </Accordion>

    <Accordion title="Delete absence">
      | Input Field | Notes |
      | ----------- | ----- |
      | absence\_id |       |
    </Accordion>

    <Accordion title="Create employee">
      <Note>
        HiBob requires a start date for the employee. If `start_date` is not provided, we will use the current date. HiBob requires a work site for the employee. We use the first one we find in the system if `location_id` is not provided in the request body
      </Note>

      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | gender                  |       |
      | job\_title              |       |
      | home\_address.street\_1 |       |
      | home\_address.street\_2 |       |
      | home\_address.city      |       |
      | home\_address.state     |       |
      | home\_address.zip\_code |       |
      | date\_of\_birth         |       |
      | mobile\_phone\_number   |       |
      | start\_date             |       |
      | location\_id            |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>

    <Accordion title="Add document to employee">
      | Input Field            | Notes |
      | ---------------------- | ----- |
      | employee\_id           |       |
      | category\_id           |       |
      | document.name          |       |
      | document.content\_type |       |
      | document.data\_url     |       |
      | document.data          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes                                                |
    | --------------------- | ---------------------------------------------------- |
    | OAuth                 |                                                      |
    | API Passthrough       |                                                      |
    | Scope Testing         |                                                      |
    | Per Model Tests       |                                                      |
    | Per Field Tests       | The individual field detection might be inconsistent |
    | Delta Syncs           |                                                      |
    | Custom Field Explorer |                                                      |
    | Employees             |                                                      |
    | Absence Types         |                                                      |
    | Connection Guide      |                                                      |
    | Prerequisites         |                                                      |
    | Employment History    |                                                      |
    | Group Types           |                                                      |
    | DEPARTMENT            |                                                      |
    | COST\_CENTER          |                                                      |
  </Tab>

  <Tab title="Create Employee with Form">
    <Note>
      You can use the Regular API or the Hire API to create employees in HiBob. The Regular API creates employees directly in the system. With the Hire API, employees are created as new hires and need to be manually approved in HiBob's dashboard.
    </Note>

    This integration supports multiple employee creation forms for different use cases:

    <Tabs>
      <Tab title="hire-api">
        <ResponseField name="firstName" type="text">**First Name**<br />
        The first name of the employee<br />
        Unified field: `first_name`</ResponseField>
        <ResponseField name="surname" type="text">**Last Name**<br />
        The last name of the employee<br />
        Unified field: `last_name`</ResponseField>
        <ResponseField name="email" type="text">**Private Email**<br />
        The private email address of the employee<br />
        Unified field: `private_email`</ResponseField>

        <ResponseField name="work" type="object">
          **Work**

          <Expandable title="properties">
            <ResponseField name="site" type="single_select">**Site**<br />
            The employee's site.</ResponseField>
            <ResponseField name="startDate" type="date">**Start Date**<br />
            Start date of the employee. Also considered to be the hire date<br />
            Unified field: `start_date`</ResponseField>
            <ResponseField name="title" type="text">**Title**</ResponseField>
            <ResponseField name="department" type="single_select">**Department**</ResponseField>
            <ResponseField name="reportsTo" type="text">**Manager email (reportsTo)**<br />
            Manager's email address</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="financial" type="object">
          **Financial**

          <Expandable title="properties">
            <ResponseField name="employmentContract" type="single_select">**Employment contract**</ResponseField>
            <ResponseField name="employmentType" type="single_select">**Employment type**</ResponseField>
            <ResponseField name="payPeriod" type="single_select">**Pay period**</ResponseField>
            <ResponseField name="salary" type="number">**Salary**</ResponseField>
            <ResponseField name="salaryCurrency" type="single_select">**Salary currency**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="documents" type="array">
          **Documents**<br />
          They will be uploaded to the employee's "Confidential" folder in HiBob.

          <Expandable title="items">
            <ResponseField name="Item" type="file" />
          </Expandable>
        </ResponseField>

        <ResponseField name="customFields" type="object">
          **Custom fields**

          <Expandable title="properties">
            <ResponseField name="text" type="array">
              **Text fields**

              <Expandable title="items">
                <ResponseField name="id" type="text">**ID**<br />
                A unique identifier of the field. Ensure this field has a unique ID to maintain data integrity.</ResponseField>
                <ResponseField name="displayName" type="text">**Display name**<br />
                The name that will be shown in Bob's UI during field mapping</ResponseField>
                <ResponseField name="value" type="text">**Value**</ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="number" type="array">
              **Number fields**

              <Expandable title="items">
                <ResponseField name="id" type="text">**ID**<br />
                A unique identifier of the field. Ensure this field has a unique ID to maintain data integrity.</ResponseField>
                <ResponseField name="displayName" type="text">**Display name**<br />
                The name that will be shown in Bob's UI during field mapping</ResponseField>
                <ResponseField name="value" type="number">**Value**</ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="date" type="array">
              **Date fields**

              <Expandable title="items">
                <ResponseField name="id" type="text">**ID**<br />
                A unique identifier of the field. Ensure this field has a unique ID to maintain data integrity.</ResponseField>
                <ResponseField name="displayName" type="text">**Display name**<br />
                The name that will be shown in Bob's UI during field mapping</ResponseField>
                <ResponseField name="value" type="date">**Value**</ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="boolean" type="array">
              **Boolean fields**

              <Expandable title="items">
                <ResponseField name="id" type="text">**ID**<br />
                A unique identifier of the field. Ensure this field has a unique ID to maintain data integrity.</ResponseField>
                <ResponseField name="displayName" type="text">**Display name**<br />
                The name that will be shown in Bob's UI during field mapping</ResponseField>
                <ResponseField name="value" type="checkbox">**Value**</ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="currency" type="array">
              **Currency fields**

              <Expandable title="items">
                <ResponseField name="id" type="text">**ID**<br />
                A unique identifier of the field. Ensure this field has a unique ID to maintain data integrity.</ResponseField>
                <ResponseField name="displayName" type="text">**Display name**<br />
                The name that will be shown in Bob's UI during field mapping</ResponseField>
                <ResponseField name="amount" type="number">**Amount**</ResponseField>
                <ResponseField name="currency" type="single_select">**Currency**</ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="multilist" type="array">
              **Multilist fields**

              <Expandable title="items">
                <ResponseField name="id" type="text">**ID**<br />
                A unique identifier of the field. Ensure this field has a unique ID to maintain data integrity.</ResponseField>
                <ResponseField name="displayName" type="text">**Display name**<br />
                The name that will be shown in Bob's UI during field mapping</ResponseField>

                <ResponseField name="values" type="array">
                  **Values**

                  <Expandable title="items">
                    <ResponseField name="Item" type="text" />
                  </Expandable>
                </ResponseField>
              </Expandable>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="recruiterEmails" type="array">
          **Recruiter emails**

          <Expandable title="items">
            <ResponseField name="Item" type="text" />
          </Expandable>
        </ResponseField>
      </Tab>

      <Tab title="regular">
        <Info>
          Some **optional** form fields are referencing the following data models:

          * Employees

          Consider enabling these in your [scope configuration](/hris/features/scopes).
        </Info>

        <Warning>
          This form may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
        </Warning>

        <ResponseField name="firstName" type="text">**First Name**<br />
        The first name of the employee<br />
        Unified field: `first_name`</ResponseField>
        <ResponseField name="surname" type="text">**Last Name**<br />
        The last name of the employee<br />
        Unified field: `last_name`</ResponseField>
        <ResponseField name="fullName" type="text">**Full name**</ResponseField>
        <ResponseField name="displayName" type="text">**Display name**</ResponseField>
        <ResponseField name="secondName" type="text">**Middle name**</ResponseField>
        <ResponseField name="avatarUrl" type="text">**Avatar URL**</ResponseField>

        <ResponseField name="custom" type="object">
          **Custom**

          <Expandable title="properties">
            <Warning>
              This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
            </Warning>
          </Expandable>
        </ResponseField>

        <ResponseField name="email" type="text">**Private Email**<br />
        The private email address of the employee<br />
        Unified field: `private_email`</ResponseField>
        <ResponseField name="id" type="single_select">**ID**<br />
        References `/v1/hris/employees?remote_model=employee`</ResponseField>
        <ResponseField name="companyId" type="number">**Company id**</ResponseField>
        <ResponseField name="creationDateTime" type="text">**Creation timestamp**</ResponseField>
        <ResponseField name="coverImageUrl" type="text">**Cover image URL**</ResponseField>

        <ResponseField name="financial" type="object">
          **Financial**

          <Expandable title="properties">
            <ResponseField name="passportNumber" type="text">**Passport number**</ResponseField>
            <ResponseField name="identificationNumber" type="text">**National ID**</ResponseField>
            <ResponseField name="accountName" type="text">**Account name**</ResponseField>
            <ResponseField name="routingNumber" type="text">**Routing number**</ResponseField>
            <ResponseField name="accountnumber" type="text">**Account number**</ResponseField>
            <ResponseField name="bankName" type="text">**Bank name**</ResponseField>
            <ResponseField name="bankAccountType" type="single_select">**Bank account type**</ResponseField>
            <ResponseField name="bankAddress" type="text">**Branch address**</ResponseField>
            <ResponseField name="swift" type="text">**SWIFT code**</ResponseField>
            <ResponseField name="iban" type="text">**IBAN**</ResponseField>
            <ResponseField name="sortcode" type="text">**Sort code**</ResponseField>
            <ResponseField name="accountType" type="single_select">**Account type**</ResponseField>
            <ResponseField name="rightToWorkExpiryDate" type="date">**Right to work closest expiry date**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="payroll" type="object">
          **Payroll**

          <Expandable title="properties">
            <Warning>
              This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
            </Warning>

            <ResponseField name="nin" type="text">**NI number**</ResponseField>

            <ResponseField name="employment" type="object">
              **Employment**

              <Expandable title="properties">
                <ResponseField name="activeEffectiveDate" type="date">**Employment effective date**</ResponseField>
                <ResponseField name="contract" type="single_select">**Employment contract**</ResponseField>
                <ResponseField name="type" type="single_select">**Employment type**</ResponseField>
                <ResponseField name="workingPattern" type="text">**Working pattern**</ResponseField>

                <ResponseField name="standardWorkingPattern" type="object">
                  **Standard working pattern**

                  <Expandable title="properties">
                    <ResponseField name="workingPatternId" type="multi_select">**Full time working pattern**</ResponseField>
                  </Expandable>
                </ResponseField>

                <ResponseField name="personalWorkingPatternType" type="single_select">**Personal working pattern**</ResponseField>
                <ResponseField name="hoursInDayNotWorked" type="number">**Hours in days not worked**</ResponseField>
                <ResponseField name="siteWorkingPattern" type="text">**Site working pattern**</ResponseField>
                <ResponseField name="actualWorkingPattern" type="text">**Actual working pattern**</ResponseField>
                <ResponseField name="calendarId" type="multi_select">**Holiday calendar ID**</ResponseField>
                <ResponseField name="salaryPayType" type="single_select">**Salary pay type**</ResponseField>
                <ResponseField name="flsaCode" type="single_select">**FLSA code**</ResponseField>
                <ResponseField name="fte" type="number">**FTE %**</ResponseField>
                <ResponseField name="weeklyHours" type="number">**Weekly hours**</ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="salary" type="object">
              **Salary**

              <Expandable title="properties">
                <ResponseField name="activeEffectiveDate" type="date">**Salary effective date**</ResponseField>

                <ResponseField name="payment" type="object">
                  **Payment**

                  <Expandable title="properties">
                    <ResponseField name="currency" type="text">**Base salary currency code**</ResponseField>
                  </Expandable>
                </ResponseField>

                <ResponseField name="payPeriod" type="single_select">**Salary pay period**</ResponseField>
                <ResponseField name="payFrequency" type="single_select">**Salary pay frequency**</ResponseField>
                <ResponseField name="yearlyPayment" type="number">**Base salary (annual)**<br />
                Unified field: `yearly_salary`</ResponseField>
                <ResponseField name="monthlyPayment" type="number">**Base salary (monthly)**</ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="additionalPensionContribution" type="number">**Additional pension contribution**</ResponseField>
            <ResponseField name="taxCode" type="text">**Tax code**</ResponseField>
            <ResponseField name="timeSinceLastSalaryChange" type="text">**Time since last salary change**</ResponseField>

            <ResponseField name="custom" type="object">
              **Custom**

              <Expandable title="properties">
                <Warning>
                  This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
                </Warning>
              </Expandable>
            </ResponseField>

            <ResponseField name="variable" type="object">
              **Variable**

              <Expandable title="properties">
                <ResponseField name="Bonus" type="object">
                  <Expandable title="properties">
                    <ResponseField name="amount" type="number">**Variable pay Bonus Amount**</ResponseField>
                    <ResponseField name="paymentPeriod" type="single_select">**Variable pay Bonus Pay period**</ResponseField>
                    <ResponseField name="companyPercent" type="number">**Variable pay Bonus % company**</ResponseField>
                    <ResponseField name="departmentPercent" type="number">**Variable pay Bonus % department**</ResponseField>
                    <ResponseField name="individualPercent" type="number">**Variable pay Bonus % individual**</ResponseField>
                  </Expandable>
                </ResponseField>

                <ResponseField name="Commission" type="object">
                  <Expandable title="properties">
                    <ResponseField name="amount" type="number">**Variable pay Commission Amount**</ResponseField>
                    <ResponseField name="paymentPeriod" type="single_select">**Variable pay Commission Pay period**</ResponseField>
                    <ResponseField name="companyPercent" type="number">**Variable pay Commission % company**</ResponseField>
                    <ResponseField name="departmentPercent" type="number">**Variable pay Commission % department**</ResponseField>
                    <ResponseField name="individualPercent" type="number">**Variable pay Commission % individual**</ResponseField>
                  </Expandable>
                </ResponseField>

                <ResponseField name="Executive bonus" type="object">
                  <Expandable title="properties">
                    <ResponseField name="amount" type="number">**Variable pay Executive bonus Amount**</ResponseField>
                    <ResponseField name="paymentPeriod" type="single_select">**Variable pay Executive bonus Pay period**</ResponseField>
                    <ResponseField name="companyPercent" type="number">**Variable pay Executive bonus % company**</ResponseField>
                    <ResponseField name="departmentPercent" type="number">**Variable pay Executive bonus % department**</ResponseField>
                    <ResponseField name="individualPercent" type="number">**Variable pay Executive bonus % individual**</ResponseField>
                  </Expandable>
                </ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="entitlement" type="object">
              **Entitlement**

              <Expandable title="properties">
                <ResponseField name="Childcare vouchers" type="object">
                  <Expandable title="properties">
                    <ResponseField name="amount" type="number">**Entitlement Childcare vouchers Monthly sum**</ResponseField>
                  </Expandable>
                </ResponseField>

                <ResponseField name="Company Car" type="object">
                  **Company car**

                  <Expandable title="properties">
                    <ResponseField name="amount" type="number">**Entitlement Company car Monthly sum**</ResponseField>
                  </Expandable>
                </ResponseField>

                <ResponseField name="Cycle to work" type="object">
                  <Expandable title="properties">
                    <ResponseField name="amount" type="number">**Entitlement Cycle to work Monthly sum**</ResponseField>
                  </Expandable>
                </ResponseField>

                <ResponseField name="Lunch vouchers" type="object">
                  <Expandable title="properties">
                    <ResponseField name="amount" type="number">**Entitlement Lunch vouchers Monthly sum**</ResponseField>
                  </Expandable>
                </ResponseField>

                <ResponseField name="Season ticket loans" type="object">
                  <Expandable title="properties">
                    <ResponseField name="amount" type="number">**Entitlement Season ticket loans Monthly sum**</ResponseField>
                  </Expandable>
                </ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="deduction" type="object">
              **Deduction**

              <Expandable title="properties">
                <ResponseField name="Childcare vouchers" type="object">
                  <Expandable title="properties">
                    <ResponseField name="amount" type="number">**Deduction Childcare vouchers Monthly sum**</ResponseField>
                  </Expandable>
                </ResponseField>

                <ResponseField name="Company Car" type="object">
                  **Company car**

                  <Expandable title="properties">
                    <ResponseField name="amount" type="number">**Deduction Company car Monthly sum**</ResponseField>
                  </Expandable>
                </ResponseField>

                <ResponseField name="Cycle to work" type="object">
                  <Expandable title="properties">
                    <ResponseField name="amount" type="number">**Deduction Cycle to work Monthly sum**</ResponseField>
                  </Expandable>
                </ResponseField>

                <ResponseField name="Lunch vouchers" type="object">
                  <Expandable title="properties">
                    <ResponseField name="amount" type="number">**Deduction Lunch vouchers Monthly sum**</ResponseField>
                  </Expandable>
                </ResponseField>

                <ResponseField name="Season ticket loans" type="object">
                  <Expandable title="properties">
                    <ResponseField name="amount" type="number">**Deduction Season ticket loans Monthly sum**</ResponseField>
                  </Expandable>
                </ResponseField>
              </Expandable>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="identification" type="object">
          **Identification**

          <Expandable title="properties">
            <ResponseField name="ssnSerialNumber" type="text">**SSN last 4 digits**</ResponseField>
            <ResponseField name="ssn" type="text">**SSN**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="work" type="object">
          **Work**

          <Expandable title="properties">
            <Warning>
              This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
            </Warning>

            <ResponseField name="activeEffectiveDate" type="date">**Work effective date**</ResponseField>
            <ResponseField name="employeeIdInCompany" type="number">**Employee ID**</ResponseField>
            <ResponseField name="title" type="single_select">**Job title**</ResponseField>
            <ResponseField name="startDate" type="date">**Start Date**<br />
            Start date of the employee. Also considered to be the hire date<br />
            Unified field: `start_date`</ResponseField>
            <ResponseField name="shortStartDate" type="date">**Work anniversary**</ResponseField>
            <ResponseField name="originalStartDate" type="date">**Original start date**</ResponseField>
            <ResponseField name="durationOfEmployment" type="text">**Accumulated tenure (duration)**</ResponseField>
            <ResponseField name="yearsOfService" type="number">**Accumulated tenure (years)**</ResponseField>
            <ResponseField name="tenureDuration" type="text">**Tenure (duration)**</ResponseField>
            <ResponseField name="tenureDurationYears" type="number">**Tenure (years)**</ResponseField>
            <ResponseField name="tenureYears" type="number">**Work anniversary (years)**</ResponseField>
            <ResponseField name="site" type="single_select">**Site**<br />
            The employee's site.</ResponseField>
            <ResponseField name="siteId" type="multi_select">**Site**</ResponseField>
            <ResponseField name="department" type="single_select">**Department**</ResponseField>
            <ResponseField name="workChangeType" type="single_select">**Change type**</ResponseField>

            <ResponseField name="reportsTo" type="object">
              **Reports to**

              <Expandable title="properties">
                <ResponseField name="email" type="text">**Manager's email**</ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="reportsToIdInCompany" type="number">**Manager's ID**</ResponseField>
            <ResponseField name="manager" type="single_select">**Manager**<br />
            References `/v1/hris/employees?remote_model=employee`</ResponseField>
            <ResponseField name="secondLevelManager" type="single_select">**Second level manager**<br />
            References `/v1/hris/employees?remote_model=employee`</ResponseField>
            <ResponseField name="isManager" type="checkbox">**Is a manager**</ResponseField>
            <ResponseField name="directReports" type="number">**Number of direct reports**</ResponseField>
            <ResponseField name="indirectReports" type="number">**Number of direct and indirect reports**</ResponseField>
            <ResponseField name="daysOfPreviousService" type="number">**Tenure sum of previous lifecycle entries in days**</ResponseField>

            <ResponseField name="custom" type="object">
              **Custom**

              <Expandable title="properties">
                <Warning>
                  This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
                </Warning>
              </Expandable>
            </ResponseField>

            <ResponseField name="workMobile" type="text">**Work mobile**</ResponseField>
            <ResponseField name="workPhone" type="text">**Work phone**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="employee" type="object">
          **Employee**

          <Expandable title="properties">
            <Warning>
              This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
            </Warning>

            <ResponseField name="buddy" type="single_select">**Buddy**<br />
            References `/v1/hris/employees?remote_model=employee`</ResponseField>
            <ResponseField name="hrbp" type="single_select">**HRBP**<br />
            References `/v1/hris/employees?remote_model=employee`</ResponseField>
            <ResponseField name="payrollManager" type="single_select">**Payroll manager**<br />
            References `/v1/hris/employees?remote_model=employee`</ResponseField>
            <ResponseField name="itAdmin" type="single_select">**IT admin**<br />
            References `/v1/hris/employees?remote_model=employee`</ResponseField>
            <ResponseField name="orgLevel" type="single_select">**Org level**</ResponseField>
            <ResponseField name="disabilityStatus" type="single_select">**Disability status**</ResponseField>
            <ResponseField name="veteranStatus" type="multi_select">**Veteran status**</ResponseField>
            <ResponseField name="legalSex" type="single_select">**Legal sex**</ResponseField>
            <ResponseField name="recentLeaveStartDate" type="date">**Recent leave start date**</ResponseField>
            <ResponseField name="recentLeaveEndDate" type="date">**Recent leave end date**</ResponseField>
            <ResponseField name="lastDayOfWork" type="date">**Last day of work**</ResponseField>
            <ResponseField name="ethnicities" type="multi_select">**Ethnicities**</ResponseField>
            <ResponseField name="jobLevelId" type="multi_select">**Job**</ResponseField>
            <ResponseField name="hasPaidPayslip" type="checkbox">**Employee.has paid payslip**</ResponseField>
            <ResponseField name="loanTypes" type="multi_select">**Repaying student or postgraduate loan type**<br />
            Field should be blank if not repaying student loans. If repaying a student loan but unsure of the plan type, select “Plan 1”.</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="personal" type="object">
          **Personal**

          <Expandable title="properties">
            <ResponseField name="communication" type="object">
              **Communication**

              <Expandable title="properties">
                <ResponseField name="slackUsername" type="text">**Slack username**</ResponseField>
                <ResponseField name="skypeUsername" type="text">**Skype username**</ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="honorific" type="single_select">**Prefix**</ResponseField>
            <ResponseField name="pronouns" type="single_select">**Pronouns**</ResponseField>
            <ResponseField name="birthDate" type="date">**Date of birth**</ResponseField>
            <ResponseField name="age" type="number">**Age**</ResponseField>
            <ResponseField name="shortBirthDate" type="date">**Birthday**</ResponseField>
            <ResponseField name="nationality" type="multi_select">**Nationality**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="address" type="object">
          **Address**

          <Expandable title="properties">
            <ResponseField name="line1" type="text">**Address line 1**</ResponseField>
            <ResponseField name="line2" type="text">**Address line 2**</ResponseField>
            <ResponseField name="fullAddress" type="text">**Full address**</ResponseField>
            <ResponseField name="city" type="text">**City**</ResponseField>
            <ResponseField name="postCode" type="text">**Zip Post Postal code**</ResponseField>
            <ResponseField name="country" type="single_select">**Country**</ResponseField>
            <ResponseField name="usaState" type="text">**State Province Region**</ResponseField>
            <ResponseField name="siteAddress1" type="text">**Site address line 1**</ResponseField>
            <ResponseField name="siteAddress2" type="text">**Site address line 2**</ResponseField>
            <ResponseField name="siteCountry" type="single_select">**Site country**</ResponseField>
            <ResponseField name="sitePostalCode" type="text">**Site zip Post Postal code**</ResponseField>
            <ResponseField name="siteCity" type="text">**Site city**</ResponseField>
            <ResponseField name="siteState" type="text">**Site state Province Region**</ResponseField>
            <ResponseField name="activeEffectiveDate" type="date">**Address effective date**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="home" type="object">
          **Home**

          <Expandable title="properties">
            <ResponseField name="familyStatus" type="single_select">**Marital status**</ResponseField>
            <ResponseField name="legalGender" type="single_select">**Gender**</ResponseField>
            <ResponseField name="numberOfKids" type="number">**Number of children**</ResponseField>

            <ResponseField name="spouse" type="object">
              **Spouse**

              <Expandable title="properties">
                <ResponseField name="firstName" type="text">**Spouse's first name**</ResponseField>
                <ResponseField name="surname" type="text">**Spouse's last name**</ResponseField>
                <ResponseField name="birthDate" type="date">**Spouse's birth date**</ResponseField>
                <ResponseField name="shortBirthDate" type="date">**Spouse's birthday**</ResponseField>
                <ResponseField name="gender" type="single_select">**Spouse's gender**</ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="privateEmail" type="text">**Personal email**</ResponseField>
            <ResponseField name="privatePhone" type="text">**Personal phone**</ResponseField>
            <ResponseField name="mobilePhone" type="text">**Personal mobile**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="about" type="object">
          **About**

          <Expandable title="properties">
            <ResponseField name="avatar" type="text">**Profile personalization**</ResponseField>
            <ResponseField name="about" type="text">**About**</ResponseField>

            <ResponseField name="socialData" type="object">
              **Social data**

              <Expandable title="properties">
                <ResponseField name="facebook" type="text">**Social - facebook**</ResponseField>
                <ResponseField name="twitter" type="text">**Social - twitter**</ResponseField>
                <ResponseField name="linkedin" type="text">**Social - linked in**</ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="hobbies" type="multi_select">**Hobbies**</ResponseField>
            <ResponseField name="superpowers" type="multi_select">**Superpowers**</ResponseField>
            <ResponseField name="foodPreferences" type="multi_select">**Food preferences**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="employment" type="object">
          **Employment**

          <Expandable title="properties">
            <Warning>
              This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
            </Warning>

            <ResponseField name="custom" type="object">
              **Custom**

              <Expandable title="properties">
                <Warning>
                  This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
                </Warning>
              </Expandable>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="actualPayment" type="object">
          **Actual payment**

          <Expandable title="properties">
            <ResponseField name="payDate" type="date">**Payment date**</ResponseField>
            <ResponseField name="payType" type="single_select">**Payment type**</ResponseField>
            <ResponseField name="amount" type="number">**Amount**</ResponseField>

            <ResponseField name="change" type="object">
              **Change**

              <Expandable title="properties">
                <ResponseField name="reason" type="text">**Reason**</ResponseField>
                <ResponseField name="changedBy" type="text">**Changed by**</ResponseField>
              </Expandable>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="personalContact" type="object">
          **Personal contact**

          <Expandable title="properties">
            <Warning>
              This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
            </Warning>

            <ResponseField name="custom" type="object">
              **Custom**

              <Expandable title="properties">
                <Warning>
                  This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
                </Warning>
              </Expandable>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="emergency" type="object">
          **Emergency**

          <Expandable title="properties">
            <ResponseField name="firstName" type="text">**Emergency contact's first name**</ResponseField>
            <ResponseField name="secondName" type="text">**Emergency contact's middle name**</ResponseField>
            <ResponseField name="surname" type="text">**Emergency contact's last name**</ResponseField>
            <ResponseField name="relation" type="single_select">**Emergency contact relationship**</ResponseField>
            <ResponseField name="phone" type="text">**Emergency contact's phone number**</ResponseField>
            <ResponseField name="mobilePhone" type="text">**Emergency contact's mobile phone number**</ResponseField>
            <ResponseField name="email" type="text">**Emergency contact's email**</ResponseField>
            <ResponseField name="address" type="text">**Emergency contact's address**</ResponseField>
            <ResponseField name="city" type="text">**Emergency contact's city of residence**</ResponseField>
            <ResponseField name="postCode" type="text">**Emergency contact's post code**</ResponseField>
            <ResponseField name="country" type="single_select">**Emergency contact's country of residence**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="internal" type="object">
          **Internal**

          <Expandable title="properties">
            <ResponseField name="lifecycleStatus" type="single_select">**Lifecycle status**</ResponseField>
            <ResponseField name="status" type="single_select">**Status**</ResponseField>
            <ResponseField name="terminationReason" type="single_select">**Reason for termination**</ResponseField>
            <ResponseField name="terminationDate" type="date">**Termination date**</ResponseField>
            <ResponseField name="periodSinceTermination" type="text">**Period since termination**</ResponseField>
            <ResponseField name="yearsSinceTermination" type="number">**Years since termination**</ResponseField>
            <ResponseField name="notice" type="text">**Notice period**</ResponseField>
            <ResponseField name="probationEndDate" type="date">**Probation end date**</ResponseField>
            <ResponseField name="terminationType" type="single_select">**Leave and termination type**</ResponseField>
            <ResponseField name="currentActiveStatusStartDate" type="date">**Current active lifecycle start date**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="state" type="single_select">**State**</ResponseField>
        <ResponseField name="creationDate" type="date">**Creation date**</ResponseField>

        <ResponseField name="userData" type="object">
          **User data**

          <Expandable title="properties">
            <Warning>
              This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
            </Warning>

            <ResponseField name="custom" type="object">
              **Custom**

              <Expandable title="properties">
                <Warning>
                  This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
                </Warning>
              </Expandable>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="eeo" type="object">
          **Eeo**

          <Expandable title="properties">
            <Warning>
              This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
            </Warning>

            <ResponseField name="ethnicity" type="single_select">**Ethnicity**</ResponseField>
            <ResponseField name="jobCategory" type="single_select">**Job category**</ResponseField>

            <ResponseField name="custom" type="object">
              **Custom**

              <Expandable title="properties">
                <Warning>
                  This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
                </Warning>
              </Expandable>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="peopleAnalytics" type="object">
          **People analytics**

          <Expandable title="properties">
            <ResponseField name="kidsRiskIndicator" type="single_select">**Kids risk indicator**</ResponseField>
            <ResponseField name="ageRiskIndicator" type="single_select">**Age risk indicator**</ResponseField>
            <ResponseField name="isManagerRiskIndicator" type="single_select">**Is manager risk indicator**</ResponseField>
            <ResponseField name="numWithSameTitleRiskIndicator" type="single_select">**Number of people with the same title risk indicator**</ResponseField>
            <ResponseField name="teamSizeRiskIndicator" type="single_select">**Team size risk indicator**</ResponseField>
            <ResponseField name="yearsWithCurrentTitleRiskIndicator" type="single_select">**Years with current title risk indicator**</ResponseField>
            <ResponseField name="yearsWithRecentSalaryRiskIndicator" type="single_select">**Years with recent salary risk indicator**</ResponseField>
            <ResponseField name="managerTenureRiskIndicator" type="single_select">**Manager tenure risk indicator**</ResponseField>
            <ResponseField name="numOfDirectReportsRiskIndicator" type="single_select">**Number of direct reports risk indicator**</ResponseField>
            <ResponseField name="teamRecentTurnoverRiskIndicator" type="single_select">**Team recent turnover risk indicator**</ResponseField>
            <ResponseField name="timeoffFrequencyRiskIndicator" type="single_select">**Timeoff frequency risk indicator**</ResponseField>
            <ResponseField name="tenureRankRiskIndicator" type="single_select">**Tenure rank risk indicator**</ResponseField>
            <ResponseField name="recentManagerChangeRiskIndicator" type="single_select">**Recent manager change risk indicator**</ResponseField>
            <ResponseField name="lowRiskCounter" type="number">**Number of 'low risk' indicators**</ResponseField>
            <ResponseField name="someRiskCounter" type="number">**Number of 'some risk' indicators**</ResponseField>
            <ResponseField name="atRiskCounter" type="number">**Number of 'at risk' indicators**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="temporaryAddress" type="object">
          **Temporary address**

          <Expandable title="properties">
            <ResponseField name="line1" type="text">**Temporary address line 1**</ResponseField>
            <ResponseField name="line2" type="text">**Temporary address line 2**</ResponseField>
            <ResponseField name="city" type="text">**Temporary city**</ResponseField>
            <ResponseField name="usaState" type="text">**Temporary state Province Region**</ResponseField>
            <ResponseField name="country" type="single_select">**Temporary country**</ResponseField>
            <ResponseField name="postCode" type="text">**Temporary zip Post Postal code**</ResponseField>
          </Expandable>
        </ResponseField>
      </Tab>
    </Tabs>
  </Tab>
</Tabs>


# HoorayHR HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/hoorayhr

HoorayHR connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The HoorayHR HRIS integration allows you to sync HRIS data between HoorayHR and your application through Kombo's unified API. The tool slug for this connector is `hoorayhr`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/41545388188305-HoorayHR-HRIS-How-to-connect-your-account">
    Step-by-step instructions to connect your HoorayHR account to Kombo.
  </Card>
</CardGroup>

## General Notes

* HoorayHR only allows a single sandbox connection at a time. Disconnect the existing sandbox integration in HoorayHR before connecting a new one.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Employees">
      | Field                 | Notes                                                                                                                                                                                                                                     |
      | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
      | id                    |                                                                                                                                                                                                                                           |
      | remote\_id            |                                                                                                                                                                                                                                           |
      | changed\_at           |                                                                                                                                                                                                                                           |
      | remote\_deleted\_at   |                                                                                                                                                                                                                                           |
      | employee\_number      |                                                                                                                                                                                                                                           |
      | first\_name           |                                                                                                                                                                                                                                           |
      | last\_name            |                                                                                                                                                                                                                                           |
      | nationality           |                                                                                                                                                                                                                                           |
      | display\_full\_name   |                                                                                                                                                                                                                                           |
      | job\_title            |                                                                                                                                                                                                                                           |
      | work\_email           |                                                                                                                                                                                                                                           |
      | personal\_email       |                                                                                                                                                                                                                                           |
      | mobile\_phone\_number |                                                                                                                                                                                                                                           |
      | tax\_id               |                                                                                                                                                                                                                                           |
      | gender                |                                                                                                                                                                                                                                           |
      | marital\_status       |                                                                                                                                                                                                                                           |
      | employment\_status    |                                                                                                                                                                                                                                           |
      | employment\_type      | HoorayHR does not expose an employment type field. We infer it from the work hours and it can be either `FULL_TIME` or `PART_TIME`.                                                                                                       |
      | weekly\_hours         |                                                                                                                                                                                                                                           |
      | manager\_id           | HoorayHR does not expose a direct manager relationship. We infer the manager using the team leader of the smallest team the employee belongs to. Note that an employee can technically have multiple team leaders across different teams. |
      | home\_address         |                                                                                                                                                                                                                                           |
      | bank\_accounts        |                                                                                                                                                                                                                                           |
      | date\_of\_birth       |                                                                                                                                                                                                                                           |
      | start\_date           |                                                                                                                                                                                                                                           |
      | termination\_date     |                                                                                                                                                                                                                                           |
      | remote\_created\_at   |                                                                                                                                                                                                                                           |
      | custom\_fields        |                                                                                                                                                                                                                                           |
      | integration\_fields   |                                                                                                                                                                                                                                           |
      | remote\_data          |                                                                                                                                                                                                                                           |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | name                    |       |
      | unit                    |       |
      | half\_days\_supported   |       |
      | exact\_times\_supported |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_time         |       |
      | end\_time           |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      <Note>
        Only the current employee's job title is exposed as the main employment's job title.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Add document to employee">
      <Note>
        Documents are always uploaded with status `PUBLISHED` so they are immediately visible to the employee. Some HoorayHR categories require a label/tag (for example the built-in "Payslips" category). Kombo does not currently pass a label, so uploads to such categories will be rejected by HoorayHR.
      </Note>

      | Input Field            | Notes |
      | ---------------------- | ----- |
      | employee\_id           |       |
      | category\_id           |       |
      | document.name          |       |
      | document.content\_type |       |
      | document.data\_url     |       |
      | document.data          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | OAuth              |       |
    | API Passthrough    |       |
    | Connection Guide   |       |
    | Employment History |       |
    | Group Types        |       |
    | TEAM               |       |
  </Tab>
</Tabs>


# HR4YOU HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/hr4you

HR4YOU connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The HR4YOU HRIS integration allows you to sync HRIS data between HR4YOU and your application through Kombo's unified API. The tool slug for this connector is `hr4you`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/27216771733393-HR4YOU-Wie-verbinde-ich-meinen-Account">
    Step-by-step instructions to connect your HR4YOU account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | tax\_id               |       |
      | gender                |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | legal\_entity\_id     |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | parent\_id          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee Document Categories">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Add document to employee">
      | Input Field            | Notes |
      | ---------------------- | ----- |
      | employee\_id           |       |
      | category\_id           |       |
      | document.name          |       |
      | document.content\_type |       |
      | document.data\_url     |       |
      | document.data          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | API Passthrough       |       |
    | Custom Field Explorer |       |
    | Employees             |       |
    | Connection Guide      |       |
    | Employment History    |       |
    | Group Types           |       |
    | COST\_CENTER          |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** HR4YOU

For **HR4YOU**, we also offer the following other connector variants:

<CardGroup>
  <Card title="HR4YOU ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/hr4you/icon.svg" href="/ats/connectors/hr4you">
    HR4YOU for the ATS category
  </Card>
</CardGroup>


# HR WORKS HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/hrworks

HR WORKS connector for Kombo's HRIS API

The HR WORKS HRIS integration allows you to sync HRIS data between HR WORKS and your application through Kombo's unified API. The tool slug for this connector is `hrworks`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/15064269328145">
    Step-by-step instructions to connect your HR WORKS account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | avatar                |       |
      | work\_location\_id    |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | name                    |       |
      | unit                    |       |
      | half\_days\_supported   |       |
      | exact\_times\_supported |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_half\_day    |       |
      | end\_half\_day      |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | type\_id            |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | employment\_type    |       |
      | effective\_date     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | parent\_id          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Time Off Balances">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | type\_id            |       |
      | balance             |       |
      | balance\_unit       |       |
      | used                |       |
      | used\_unit          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee Document Categories">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create absence">
      | Input Field       | Notes |
      | ----------------- | ----- |
      | employee\_id      |       |
      | absence\_type\_id |       |
      | status            |       |
      | start\_date       |       |
      | end\_date         |       |
      | start\_half\_day  |       |
      | end\_half\_day    |       |
      | employee\_note    |       |
      | start\_time       |       |
      | end\_time         |       |
    </Accordion>

    <Accordion title="Delete absence">
      | Input Field | Notes |
      | ----------- | ----- |
      | absence\_id |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>

    <Accordion title="Add document to employee">
      <Note>
        The maximum file size allowed by HR Works' API is 10MB
      </Note>

      | Input Field            | Notes |
      | ---------------------- | ----- |
      | employee\_id           |       |
      | category\_id           |       |
      | document.name          |       |
      | document.content\_type |       |
      | document.data\_url     |       |
      | document.data          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | API Passthrough    |       |
    | Scope Testing      |       |
    | Per Model Tests    |       |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
    | Group Types        |       |
    | DEPARTMENT         |       |
    | COST\_CENTER       |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Note>
      The behavior of this action depends on the creation method selected during setup. With "Onboarding", an onboarding document is created that the new employee can complete. With "Direct", the employee record is created directly in HR WORKS (requires a Person ID and Personnel Number).
    </Note>

    This integration supports multiple employee creation forms for different use cases:

    <Tabs>
      <Tab title="direct">
        <Info>
          Some **required** form fields are referencing the following data models:

          * Groups

          Consider enabling these in your [scope configuration](/hris/features/scopes).
        </Info>

        <ResponseField name="personId" type="text">**Person ID**<br />
        The user/login ID for the new employee. Must be unique in HR WORKS.</ResponseField>
        <ResponseField name="personnelNumber" type="text">**Personnel Number**<br />
        The personnel number for the new employee. Must be unique in HR WORKS.</ResponseField>
        <ResponseField name="firstName" type="text">**First Name**<br />
        The first name of the employee<br />
        Unified field: `first_name`</ResponseField>
        <ResponseField name="lastName" type="text">**Last Name**<br />
        The last name of the employee<br />
        Unified field: `last_name`</ResponseField>
        <ResponseField name="joinDate" type="date">**Start Date**<br />
        Start date of the employee. Also considered to be the hire date<br />
        Unified field: `start_date`</ResponseField>
        <ResponseField name="organizationUnitNumber" type="single_select">**Organization Unit**<br />
        The organization unit the new employee will be assigned to.<br />
        References `/v1/hris/groups?types=DEPARTMENT`</ResponseField>
        <ResponseField name="email" type="text">**Work Email**<br />
        The business email address of the employee.<br />
        Unified field: `work_email`</ResponseField>
        <ResponseField name="gender" type="single_select">**Gender**<br />
        The gender of the employee<br />
        Unified field: `gender`</ResponseField>
        <ResponseField name="birthday" type="date">**Date of Birth**<br />
        The employee's date of birth<br />
        Unified field: `date_of_birth`</ResponseField>
        <ResponseField name="nationality" type="text">**Nationality**<br />
        The nationality of the new employee (three-letter country code, e.g. DEU).<br />
        Unified field: `nationality`</ResponseField>

        <ResponseField name="address" type="object">
          **Address**

          <Expandable title="properties">
            <ResponseField name="street" type="text">**Street 1**<br />
            The street address of the employee<br />
            Unified field: `home_address.street_1`</ResponseField>
            <ResponseField name="street_number" type="text">**Street Number**</ResponseField>
            <ResponseField name="zip_code" type="text">**ZIP Code**<br />
            The ZIP code of the employee<br />
            Unified field: `home_address.zip_code`</ResponseField>
            <ResponseField name="city" type="text">**City**<br />
            The city of the employee<br />
            Unified field: `home_address.city`</ResponseField>
            <ResponseField name="country" type="text">**Country**<br />
            The country of the address (three-letter country code, e.g. DEU).<br />
            Unified field: `home_address.country`</ResponseField>
          </Expandable>
        </ResponseField>
      </Tab>

      <Tab title="onboarding">
        <Info>
          Some **required** form fields are referencing the following data models:

          * Groups

          Consider enabling these in your [scope configuration](/hris/features/scopes).
        </Info>

        <ResponseField name="privateEmail" type="text">**Private Email**<br />
        The private email address of the employee<br />
        Unified field: `private_email`</ResponseField>
        <ResponseField name="firstName" type="text">**First Name**<br />
        The first name of the employee<br />
        Unified field: `first_name`</ResponseField>
        <ResponseField name="lastName" type="text">**Last Name**<br />
        The last name of the employee<br />
        Unified field: `last_name`</ResponseField>
        <ResponseField name="joinDate" type="date">**Start Date**<br />
        Start date of the employee. Also considered to be the hire date<br />
        Unified field: `start_date`</ResponseField>
        <ResponseField name="organizationUnitNumber" type="single_select">**Organization Unit**<br />
        The organization unit the new employee will be assigned to. Determines the assigned country.<br />
        References `/v1/hris/groups?types=DEPARTMENT`</ResponseField>
        <ResponseField name="gender" type="single_select">**Gender**<br />
        The gender of the employee<br />
        Unified field: `gender`</ResponseField>
        <ResponseField name="birthday" type="date">**Date of Birth**<br />
        The employee's date of birth<br />
        Unified field: `date_of_birth`</ResponseField>
        <ResponseField name="nationality" type="text">**Nationality**<br />
        The nationality of the new employee (three-letter country code, e.g. DEU).<br />
        Unified field: `nationality`</ResponseField>
        <ResponseField name="maritalStatus" type="single_select">**Marital Status**</ResponseField>

        <ResponseField name="address" type="object">
          **Address**

          <Expandable title="properties">
            <ResponseField name="street" type="text">**Street 1**<br />
            The street address of the employee<br />
            Unified field: `home_address.street_1`</ResponseField>
            <ResponseField name="street_number" type="text">**Street Number**</ResponseField>
            <ResponseField name="zip_code" type="text">**ZIP Code**<br />
            The ZIP code of the employee<br />
            Unified field: `home_address.zip_code`</ResponseField>
            <ResponseField name="city" type="text">**City**<br />
            The city of the employee<br />
            Unified field: `home_address.city`</ResponseField>
            <ResponseField name="country" type="text">**Country**<br />
            The country of the address (three-letter country code, e.g. DEU).<br />
            Unified field: `home_address.country`</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="languageCode" type="single_select">**Language**<br />
        Determines the GUI language of the onboarding tool. Defaults to the language of the assigned organization unit.</ResponseField>
      </Tab>
    </Tabs>
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** HR WORKS

For **HR WORKS**, we also offer the following other connector variants:

<CardGroup>
  <Card title="HR WORKS ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/hrworks/icon.svg" href="/ats/connectors/hrworks">
    HR WORKS for the ATS category
  </Card>
</CardGroup>


# Humaans HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/humaans

Humaans connector for Kombo's HRIS API

The Humaans HRIS integration allows you to sync HRIS data between Humaans and your application through Kombo's unified API. The tool slug for this connector is `humaans`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/18398704242705">
    Step-by-step instructions to connect your Humaans account to Kombo.
  </Card>

  <Card title="Sandbox Environment" icon="flask" href="https://docs.google.com/forms/d/e/1FAIpQLSfvsENhiZgum1DTEsqM3-LSJaBM6Ee2e3zfW71YtW112iAGyw/viewform">
    Access the Humaans sandbox environment for testing and development.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | tax\_id               |       |
      | gender                |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | name                  |       |
      | unit                  |       |
      | half\_days\_supported |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | approver\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_half\_day    |       |
      | end\_half\_day      |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Time Off Balances">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | type\_id            |       |
      | balance             |       |
      | balance\_unit       |       |
      | used                |       |
      | used\_unit          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee">
      <Note>
        Humaans requires a location to be set for the employee. We set it to to the first location in the system by default. You can change it by setting the `location_id` the request body.
      </Note>

      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | gender                  |       |
      | job\_title              |       |
      | home\_address.street\_1 |       |
      | home\_address.city      |       |
      | home\_address.state     |       |
      | home\_address.zip\_code |       |
      | home\_address.country   |       |
      | date\_of\_birth         |       |
      | mobile\_phone\_number   |       |
      | nationality             |       |
      | start\_date             |       |
      | location\_id            |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes                                                                                                                                                                                                                                                                                                                                                                   |
    | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | API Passthrough    |                                                                                                                                                                                                                                                                                                                                                                         |
    | Scope Testing      |                                                                                                                                                                                                                                                                                                                                                                         |
    | Per Model Tests    |                                                                                                                                                                                                                                                                                                                                                                         |
    | Per Field Tests    | The Humaans API returns null values both if the API does not have permissions to access the field, and if the field simply does not have a value. The permission test therefore only checks for the presence of very common fields (e.g. birthday) where it is safe to assume that a null value is due to lack of permissions rather than due to a value not being set. |
    | Connection Guide   |                                                                                                                                                                                                                                                                                                                                                                         |
    | Prerequisites      |                                                                                                                                                                                                                                                                                                                                                                         |
    | Create credentials |                                                                                                                                                                                                                                                                                                                                                                         |
    | Group Types        |                                                                                                                                                                                                                                                                                                                                                                         |
    | TEAM               |                                                                                                                                                                                                                                                                                                                                                                         |
    | DEPARTMENT         |                                                                                                                                                                                                                                                                                                                                                                         |
  </Tab>

  <Tab title="Create Employee with Form">
    <Note>
      Employment end date requires a leaving reason.
    </Note>

    <Info>
      Some **required** form fields are referencing the following data models:

      * Locations

      Additionally, there are some **optional** form fields that reference:

      * Employees

      Consider enabling these in your [scope configuration](/hris/features/scopes).
    </Info>

    <ResponseField name="email" type="text">**Work Email**<br />
    Work email address for the employee. Must be unique in Humaans.<br />
    Unified field: `work_email`</ResponseField>
    <ResponseField name="firstName" type="text">**First Name**<br />
    The first name of the employee<br />
    Unified field: `first_name`</ResponseField>
    <ResponseField name="lastName" type="text">**Last Name**<br />
    The last name of the employee<br />
    Unified field: `last_name`</ResponseField>
    <ResponseField name="locationId" type="single_select">**Location**<br />
    The Kombo ID of the location the employee should be in<br />
    Unified field: `location_id`<br />
    References `/v1/hris/locations?remote_model=location`</ResponseField>
    <ResponseField name="employmentStartDate" type="date">**Start Date**<br />
    Start date of the employee. Also considered to be the hire date<br />
    Unified field: `start_date`</ResponseField>

    <ResponseField name="jobRole" type="object">
      **Job Role**

      <Expandable title="properties">
        <ResponseField name="jobTitle" type="text">**Job Title**<br />
        The title of the position this person is working in<br />
        Unified field: `job_title`</ResponseField>
        <ResponseField name="department" type="text">**Department**</ResponseField>
        <ResponseField name="reportingTo" type="single_select">**Manager**<br />
        References `/v1/hris/employees?remote_model=employee`</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="middleName" type="text">**Middle Name**</ResponseField>
    <ResponseField name="preferredName" type="text">**Preferred Name**</ResponseField>
    <ResponseField name="pronouns" type="text">**Pronouns**</ResponseField>
    <ResponseField name="gender" type="single_select">**Gender**<br />
    The gender of the employee<br />
    Unified field: `gender`</ResponseField>
    <ResponseField name="birthday" type="date">**Date of Birth**<br />
    The employee's date of birth<br />
    Unified field: `date_of_birth`</ResponseField>
    <ResponseField name="isBirthdayHidden" type="checkbox">**Hide Birthday**<br />
    If enabled, the birthday will be hidden from others.</ResponseField>
    <ResponseField name="personalEmail" type="text">**Private Email**<br />
    The private email address of the employee<br />
    Unified field: `private_email`</ResponseField>
    <ResponseField name="phoneNumber" type="text">**Mobile Phone Number**<br />
    The mobile phone number of the employee<br />
    Unified field: `mobile_phone_number`</ResponseField>
    <ResponseField name="personalPhoneNumber" type="text">**Home Phone Number**<br />
    The home phone number of the employee<br />
    Unified field: `home_phone_number`</ResponseField>
    <ResponseField name="isWorkEmailHidden" type="checkbox">**Hide Work Email**<br />
    If enabled, hides the work email inside Humaans.</ResponseField>
    <ResponseField name="address" type="text">**Street 1**<br />
    The street address of the employee<br />
    Unified field: `home_address.street_1`</ResponseField>
    <ResponseField name="city" type="text">**City**<br />
    The city of the employee<br />
    Unified field: `home_address.city`</ResponseField>
    <ResponseField name="state" type="text">**State**<br />
    The state of the employee<br />
    Unified field: `home_address.state`</ResponseField>
    <ResponseField name="postcode" type="text">**ZIP Code**<br />
    The ZIP code of the employee<br />
    Unified field: `home_address.zip_code`</ResponseField>
    <ResponseField name="countryCode" type="text">**Country**<br />
    ISO country code (e.g. US, GB).<br />
    Unified field: `home_address.country`</ResponseField>
    <ResponseField name="remoteCity" type="text">**Remote City**</ResponseField>
    <ResponseField name="remoteCountryCode" type="text">**Remote Country Code**<br />
    ISO country code for the remote location (e.g. US). Not required for on-site employees.</ResponseField>
    <ResponseField name="nationality" type="text">**Nationality**</ResponseField>

    <ResponseField name="spokenLanguages" type="array">
      **Spoken Languages**

      <Expandable title="items">
        <ResponseField name="Item" type="text" />
      </Expandable>
    </ResponseField>

    <ResponseField name="foodAllergies" type="array">
      **Food Allergies**

      <Expandable title="items">
        <ResponseField name="Item" type="text" />
      </Expandable>
    </ResponseField>

    <ResponseField name="bio" type="text">**Bio**</ResponseField>
    <ResponseField name="linkedIn" type="text">**LinkedIn**</ResponseField>
    <ResponseField name="twitter" type="text">**Twitter**</ResponseField>
    <ResponseField name="github" type="text">**GitHub**</ResponseField>
    <ResponseField name="firstWorkingDay" type="date">**First Working Day**<br />
    First day at work. Defaults to the employment start date if omitted.</ResponseField>
    <ResponseField name="probationEndDate" type="date">**Probation End Date**<br />
    Must be after the start date.</ResponseField>
    <ResponseField name="employeeId" type="text">**Employee ID**</ResponseField>
    <ResponseField name="contractType" type="single_select">**Contract Type**</ResponseField>
    <ResponseField name="employmentEndDate" type="date">**Employment End Date**<br />
    Must be after the first working day. Requires a leaving reason.</ResponseField>
    <ResponseField name="leavingReason" type="single_select">**Leaving Reason**</ResponseField>
    <ResponseField name="leavingNote" type="text">**Leaving Note**</ResponseField>
    <ResponseField name="taxId" type="text">**Tax ID**</ResponseField>
    <ResponseField name="taxCode" type="text">**Tax Code**</ResponseField>
    <ResponseField name="payrollProvider" type="text">**Payroll Provider**</ResponseField>

    <ResponseField name="workingDays" type="array">
      **Working Days**<br />
      List of days the employee is scheduled to work. Defaults to Monday–Friday when omitted.

      <Expandable title="items">
        <ResponseField name="day" type="single_select">**Day**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="teams" type="array">
      **Teams**

      <Expandable title="items">
        <ResponseField name="name" type="text">**Team Name**</ResponseField>
      </Expandable>
    </ResponseField>
  </Tab>
</Tabs>


# Insperity HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/insperity

Insperity connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Insperity HRIS integration allows you to sync HRIS data between Insperity and your application through Kombo's unified API. The tool slug for this connector is `insperity`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/38957895631377-Insperity-HRIS-How-do-I-link-my-account">
    Step-by-step instructions to connect your Insperity account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | gender                |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | unit                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
    </Accordion>

    <Accordion title="Time Off Balances">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | type\_id            |       |
      | balance             |       |
      | balance\_unit       |       |
      | used                |       |
      | used\_unit          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee">
      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | gender                  |       |
      | job\_title              |       |
      | home\_address.street\_1 |       |
      | home\_address.city      |       |
      | home\_address.state     |       |
      | home\_address.zip\_code |       |
      | date\_of\_birth         |       |
      | mobile\_phone\_number   |       |
      | start\_date             |       |
      | location\_id            |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | API Passthrough       |       |
    | Scope Testing         |       |
    | Per Model Tests       |       |
    | Delta Syncs           |       |
    | Custom Field Explorer |       |
    | Employees             |       |
    | Employments           |       |
    | Connection Guide      |       |
    | Group Types           |       |
    | DEPARTMENT            |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Info>
      Some **optional** form fields are referencing the following data models:

      * Employees

      Consider enabling these in your [scope configuration](/hris/features/scopes).
    </Info>

    <ResponseField name="person" type="object">
      **Person**

      <Expandable title="properties">
        <ResponseField name="firstName" type="text">**First Name**<br />
        The first name of the employee<br />
        Unified field: `first_name`</ResponseField>
        <ResponseField name="lastName" type="text">**Last Name**<br />
        The last name of the employee<br />
        Unified field: `last_name`</ResponseField>
        <ResponseField name="dateOfBirth" type="date">**Date of Birth**<br />
        Unified field: `date_of_birth`</ResponseField>
        <ResponseField name="middleName" type="text">**Middle Name**</ResponseField>
        <ResponseField name="gender" type="single_select">**Gender**<br />
        The gender of the employee<br />
        Unified field: `gender`</ResponseField>
        <ResponseField name="employeeStatus" type="single_select">**Employee Status**</ResponseField>
        <ResponseField name="leaveStartDate" type="date">**Leave Start Date**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="communication" type="object">
      **Communication**

      <Expandable title="properties">
        <ResponseField name="addresses" type="array">
          **Addresses**

          <Expandable title="items">
            <ResponseField name="useCode" type="single_select">**Use Code**</ResponseField>
            <ResponseField name="addressLine" type="text">**Address Line**</ResponseField>
            <ResponseField name="city" type="text">**City**</ResponseField>
            <ResponseField name="state" type="single_select">**State**</ResponseField>
            <ResponseField name="postalCode" type="text">**Postal Code**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="emails" type="array">
          **Emails**

          <Expandable title="items">
            <ResponseField name="emailAddress" type="text">**Email Address**</ResponseField>
            <ResponseField name="useCode" type="single_select">**Use Code**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="phones" type="array">
          **Phones**

          <Expandable title="items">
            <ResponseField name="number" type="text">**Mobile Phone Number**<br />
            The mobile phone number of the employee<br />
            Unified field: `mobile_phone_number`</ResponseField>
            <ResponseField name="useCode" type="single_select">**Use Code**</ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="position" type="object">
      **Position**

      <Expandable title="properties">
        <ResponseField name="workersCompensationCode" type="single_select">**Workers Compensation Code**</ResponseField>
        <ResponseField name="jobFunctionID" type="single_select">**Job Function**</ResponseField>
        <ResponseField name="jobTitle" type="text">**Job Title**</ResponseField>
        <ResponseField name="isMinister" type="single_select">**Is Minister?**</ResponseField>
        <ResponseField name="isFicaExempt" type="single_select">**Is Fica Exempt?**</ResponseField>
        <ResponseField name="supervisorID" type="single_select">**Supervisor**<br />
        References `/v1/hris/employees?remote_model=employee`</ResponseField>
        <ResponseField name="departmentID" type="single_select">**Department**</ResponseField>
        <ResponseField name="isExemptFromSocialSecurityIndicator" type="single_select">**Is Exempt From Social Security Indicator?**</ResponseField>
        <ResponseField name="jobCosting" type="multi_select">**Job Costing**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="employment" type="object">
      **Employment**

      <Expandable title="properties">
        <ResponseField name="isUnionMember" type="single_select">**Is Union Member?**</ResponseField>
        <ResponseField name="employeeAgreementCategory" type="single_select">**Employee Agreement Category**</ResponseField>
        <ResponseField name="ownerStatus" type="single_select">**Owner Status**</ResponseField>
        <ResponseField name="jobDuty" type="single_select">**Job Duty**</ResponseField>
        <ResponseField name="jobCategoryID" type="single_select">**Job Category**</ResponseField>
        <ResponseField name="willWorkMultiStates" type="single_select">**Will Work Multi States?**</ResponseField>
        <ResponseField name="willWorkInternational" type="single_select">**Will Work International?**</ResponseField>
        <ResponseField name="primaryInternationalCountry" type="text">**Primary International Country**</ResponseField>
        <ResponseField name="willTravelInternational" type="single_select">**Will Travel International?**</ResponseField>
        <ResponseField name="hireDate" type="date">**Hire Date**</ResponseField>
        <ResponseField name="insperityHireDate" type="date">**Insperity Hire Date**</ResponseField>
        <ResponseField name="ptoEffectiveDate" type="date">**PTO Effective Date**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="compensation" type="object">
      **Compensation**

      <Expandable title="properties">
        <ResponseField name="classification" type="single_select">**Classification**</ResponseField>
        <ResponseField name="temporaryIndicator" type="single_select">**Temporary Indicator**</ResponseField>
        <ResponseField name="temporaryStatusEndDate" type="date">**Temporary Status End Date**</ResponseField>
        <ResponseField name="isExemptFromOvertime" type="single_select">**Is Exempt From Overtime?**</ResponseField>
        <ResponseField name="isPaidTips" type="single_select">**Is Paid Tips?**</ResponseField>
        <ResponseField name="isPaidPiecework" type="single_select">**Is Paid Piecework?**</ResponseField>
        <ResponseField name="pieceWorkBasis" type="single_select">**Piece Work Basis**</ResponseField>
        <ResponseField name="pieceWorkRate" type="text">**Piece Work Rate**</ResponseField>
        <ResponseField name="isPaidSalary" type="single_select">**Is Paid Salary?**</ResponseField>
        <ResponseField name="salaryBasis" type="single_select">**Salary Basis**</ResponseField>
        <ResponseField name="salaryRate" type="text">**Salary Rate**</ResponseField>
        <ResponseField name="isPaidHourly" type="single_select">**Is Paid Hourly?**</ResponseField>
        <ResponseField name="hourlyrate" type="text">**Hourly Rate**</ResponseField>
        <ResponseField name="isPaidCommission" type="single_select">**Is Paid Commission?**</ResponseField>
        <ResponseField name="isCommissionDraw" type="single_select">**Is Commission Draw?**</ResponseField>
        <ResponseField name="commissionDrawRate" type="text">**Commission Draw Rate**</ResponseField>
        <ResponseField name="isAllowanceProvided" type="single_select">**Is Allowance Provided?**</ResponseField>
        <ResponseField name="allowanceCarAmount" type="text">**Allowance Car Amount**</ResponseField>
        <ResponseField name="allowanceCarPayFrequency" type="single_select">**Allowance Car Pay Frequency**</ResponseField>
        <ResponseField name="allowanceOther1Amount" type="text">**Allowance Other 1 Amount**</ResponseField>
        <ResponseField name="allowanceOther1PayFrequencyAllowanceFrequency" type="single_select">**Allowance Other 1 Pay Frequency Allowance Frequency**</ResponseField>
        <ResponseField name="allowanceOther1Description" type="text">**Allowance Other 1 Description**</ResponseField>
        <ResponseField name="allowanceOther2Amount" type="text">**Allowance Other 2 Amount**</ResponseField>
        <ResponseField name="allowanceOther2PayFrequencyAllowanceFrequency" type="single_select">**Allowance Other 2 Pay Frequency Allowance Frequency**</ResponseField>
        <ResponseField name="allowanceOther2Description" type="text">**Allowance Other 2 Description**</ResponseField>
      </Expandable>
    </ResponseField>
  </Tab>
</Tabs>


# IRIS Cascade HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/iriscascade

IRIS Cascade connector for Kombo's HRIS API

The IRIS Cascade HRIS integration allows you to sync HRIS data between IRIS Cascade and your application through Kombo's unified API. The tool slug for this connector is `iriscascade`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/23873684846225-IRIS-Cascade-ATS-How-do-I-link-my-account">
    Step-by-step instructions to connect your IRIS Cascade account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | tax\_id               |       |
      | gender                |       |
      | ethnicity             |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | avatar                |       |
      | work\_location\_id    |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | name                    |       |
      | unit                    |       |
      | half\_days\_supported   |       |
      | exact\_times\_supported |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_half\_day    |       |
      | end\_half\_day      |       |
      | amount              |       |
      | unit                |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | parent\_id          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Time Off Balances">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | type\_id            |       |
      | balance             |       |
      | balance\_unit       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | API Passthrough       |       |
    | Delta Syncs           |       |
    | Custom Field Explorer |       |
    | Employees             |       |
    | Connection Guide      |       |
    | Prerequisites         |       |
    | Group Types           |       |
    | DEPARTMENT            |       |
    | COST\_CENTER          |       |
  </Tab>
</Tabs>


# iTrent HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/itrent

iTrent connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The iTrent HRIS integration allows you to sync HRIS data between iTrent and your application through Kombo's unified API. The tool slug for this connector is `itrent`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/41402798604945">
    Step-by-step instructions to connect your iTrent account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Employees">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | nationality         |       |
      | display\_full\_name |       |
      | job\_title          |       |
      | work\_email         |       |
      | personal\_email     |       |
      | ssn                 |       |
      | gender              |       |
      | marital\_status     |       |
      | employment\_type    |       |
      | weekly\_hours       |       |
      | manager\_id         |       |
      | home\_address       |       |
      | date\_of\_birth     |       |
      | start\_date         |       |
      | termination\_date   |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | employment\_type    |       |
      | effective\_date     |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | Scope Testing    |       |
    | Connection Guide |       |
    | Group Types      |       |
    | DEPARTMENT       |       |
  </Tab>
</Tabs>


# Kenjo HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/kenjo

Kenjo connector for Kombo's HRIS API

The Kenjo HRIS integration allows you to sync HRIS data between Kenjo and your application through Kombo's unified API. The tool slug for this connector is `kenjo`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/22386241891857">
    Step-by-step instructions to connect your Kenjo account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | first\_name           |       |
      | last\_name            |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | gender                |       |
      | employment\_status    |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | pay\_currency       |       |
      | effective\_date     |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | API Passthrough    |       |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
    | Group Types        |       |
    | TEAM               |       |
    | DEPARTMENT         |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Info>
      Some **required** form fields are referencing the following data models:

      * Legal Entities

      Additionally, there are some **optional** form fields that reference:

      * Employees
      * Groups
      * Locations

      Consider enabling these in your [scope configuration](/hris/features/scopes).
    </Info>

    <ResponseField name="account" type="object">
      **Account**

      <Expandable title="properties">
        <ResponseField name="email" type="text">**Work Email**<br />
        The email address of the employee<br />
        Unified field: `work_email`</ResponseField>
        <ResponseField name="language" type="single_select">**Language**</ResponseField>
        <ResponseField name="externalId" type="text">**External ID**<br />
        A unique external identifier for the employee. Must be unique across all employees in the tenant.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="personal" type="object">
      **Personal**

      <Expandable title="properties">
        <ResponseField name="firstName" type="text">**First Name**<br />
        The first name of the employee<br />
        Unified field: `first_name`</ResponseField>
        <ResponseField name="lastName" type="text">**Last Name**<br />
        The last name of the employee<br />
        Unified field: `last_name`</ResponseField>
        <ResponseField name="displayName" type="text">**Display Name**</ResponseField>
        <ResponseField name="gender" type="single_select">**Gender**<br />
        The gender of the employee<br />
        Unified field: `gender`</ResponseField>
        <ResponseField name="birthdate" type="date">**Date of Birth**<br />
        The employee's date of birth<br />
        Unified field: `date_of_birth`</ResponseField>
        <ResponseField name="nationality" type="single_select">**Nationality**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="work" type="object">
      **Work**

      <Expandable title="properties">
        <ResponseField name="companyId" type="single_select">**Company**<br />
        The legal entity the employee belongs to<br />
        Unified field: `legal_entity_id`<br />
        References `/v1/hris/legal-entities?remote_model=legal_entity`</ResponseField>
        <ResponseField name="officeId" type="single_select">**Office**<br />
        Unified field: `location_id`<br />
        References `/v1/hris/locations?remote_model=location`</ResponseField>
        <ResponseField name="departmentId" type="single_select">**Department**<br />
        References `/v1/hris/groups?types=DEPARTMENT`</ResponseField>
        <ResponseField name="startDate" type="date">**Start Date**<br />
        Start date of the employee. Also considered to be the hire date<br />
        Unified field: `start_date`</ResponseField>
        <ResponseField name="jobTitle" type="text">**Job Title**<br />
        The title of the position this person is working in<br />
        Unified field: `job_title`</ResponseField>
        <ResponseField name="workPhone" type="text">**Work Phone**</ResponseField>
        <ResponseField name="workMobile" type="text">**Work Mobile**</ResponseField>
        <ResponseField name="isAssistant" type="checkbox">**Is Assistant**<br />
        Allow to indicate if the employee has or not the assistant role.</ResponseField>
        <ResponseField name="probationPeriodEnd" type="date">**Probation Period End**</ResponseField>
        <ResponseField name="contractEnd" type="date">**Contract End**</ResponseField>
        <ResponseField name="reportsToId" type="single_select">**Reports To**<br />
        The Kenjo employee the new employee reports to. Can be an active or inactive user, but cannot be the employee being created or someone already reporting to them.<br />
        References `/v1/hris/employees?remote_model=employee`</ResponseField>
        <ResponseField name="weeklyHours" type="number">**Weekly Hours**<br />
        The number of hours the employee works per week. Combined with the work schedule, this determines the day hours. Must be at least 1.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="workSchedule" type="object">
      **Work Schedule**

      <Expandable title="properties">
        <ResponseField name="mondayWorkingDay" type="checkbox">**Monday Working Day**</ResponseField>
        <ResponseField name="tuesdayWorkingDay" type="checkbox">**Tuesday Working Day**</ResponseField>
        <ResponseField name="wednesdayWorkingDay" type="checkbox">**Wednesday Working Day**</ResponseField>
        <ResponseField name="thursdayWorkingDay" type="checkbox">**Thursday Working Day**</ResponseField>
        <ResponseField name="fridayWorkingDay" type="checkbox">**Friday Working Day**</ResponseField>
        <ResponseField name="saturdayWorkingDay" type="checkbox">**Saturday Working Day**</ResponseField>
        <ResponseField name="sundayWorkingDay" type="checkbox">**Sunday Working Day**</ResponseField>
        <ResponseField name="trackAttendance" type="checkbox">**Track Attendance**<br />
        Activate or deactivate attendance tracking for the employee.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="address" type="object">
      **Address**

      <Expandable title="properties">
        <ResponseField name="street" type="text">**Street 1**<br />
        The street address of the employee<br />
        Unified field: `home_address.street_1`</ResponseField>
        <ResponseField name="postalCode" type="text">**ZIP Code**<br />
        The ZIP code of the employee<br />
        Unified field: `home_address.zip_code`</ResponseField>
        <ResponseField name="city" type="text">**City**<br />
        The city of the employee<br />
        Unified field: `home_address.city`</ResponseField>
        <ResponseField name="country" type="single_select">**Country**<br />
        Unified field: `home_address.country`</ResponseField>
        <ResponseField name="houseNumber" type="text">**House Number**</ResponseField>
        <ResponseField name="additionalAddress" type="text">**Street 2**<br />
        The street address of the employee<br />
        Unified field: `home_address.street_2`</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="financial" type="object">
      **Financial**

      <Expandable title="properties">
        <ResponseField name="accountHolderName" type="text">**Account Holder Name**</ResponseField>
        <ResponseField name="bankName" type="text">**Bank Name**</ResponseField>
        <ResponseField name="accountNumber" type="text">**Account Number**</ResponseField>
        <ResponseField name="iban" type="text">**IBAN**</ResponseField>
        <ResponseField name="swiftCode" type="text">**SWIFT Code**</ResponseField>
        <ResponseField name="nationalId" type="text">**National ID**</ResponseField>
        <ResponseField name="passport" type="text">**Passport**</ResponseField>
        <ResponseField name="nationalInsuranceNumber" type="text">**National Insurance Number**</ResponseField>
        <ResponseField name="taxCode" type="text">**Tax Code**</ResponseField>
        <ResponseField name="taxIdentificationNumber" type="text">**Tax Identification Number**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="home" type="object">
      **Home**

      <Expandable title="properties">
        <ResponseField name="maritalStatus" type="single_select">**Marital Status**</ResponseField>
        <ResponseField name="spouseFirstName" type="text">**Spouse First Name**</ResponseField>
        <ResponseField name="spouseLastName" type="text">**Spouse Last Name**</ResponseField>
        <ResponseField name="spouseBirthdate" type="date">**Spouse Birthdate**</ResponseField>
        <ResponseField name="spouseGender" type="single_select">**Spouse Gender**</ResponseField>
        <ResponseField name="personalEmail" type="text">**Private Email**<br />
        The private email address of the employee<br />
        Unified field: `private_email`</ResponseField>
        <ResponseField name="personalPhone" type="text">**Home Phone Number**<br />
        The home phone number of the employee<br />
        Unified field: `home_phone_number`</ResponseField>
        <ResponseField name="personalMobile" type="text">**Mobile Phone Number**<br />
        The mobile phone number of the employee<br />
        Unified field: `mobile_phone_number`</ResponseField>

        <ResponseField name="children" type="array">
          **Children**

          <Expandable title="items">
            <ResponseField name="childFirstName" type="text">**First Name**</ResponseField>
            <ResponseField name="childLastName" type="text">**Last Name**</ResponseField>
            <ResponseField name="childBirthdate" type="date">**Birthdate**</ResponseField>
            <ResponseField name="childGender" type="single_select">**Gender**</ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="emergency" type="object">
      **Emergency**

      <Expandable title="properties">
        <ResponseField name="emergencyFirstName" type="text">**Emergency First Name**</ResponseField>
        <ResponseField name="emergencyMiddleName" type="text">**Emergency Middle Name**</ResponseField>
        <ResponseField name="emergencyLastName" type="text">**Emergency Last Name**</ResponseField>
        <ResponseField name="relation" type="single_select">**Relation**</ResponseField>
        <ResponseField name="emergencyPhoneNumber" type="text">**Emergency Phone Number**</ResponseField>
        <ResponseField name="emergencyMobileNumber" type="text">**Emergency Mobile Number**</ResponseField>
      </Expandable>
    </ResponseField>
  </Tab>
</Tabs>


# Tellent HR HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/kiwihr

Tellent HR connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Tellent HR HRIS integration allows you to sync HRIS data between Tellent HR and your application through Kombo's unified API. The tool slug for this connector is `kiwihr`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/27617050162193-Tellent-HR-How-do-I-link-my-account">
    Step-by-step instructions to connect your Tellent HR account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | gender                |       |
      | employment\_status    |       |
      | weekly\_hours         |       |
      | work\_location\_id    |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | Connection Guide   |       |
    | Create credentials |       |
  </Tab>
</Tabs>


# Lattice HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/lattice

Lattice connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Lattice HRIS integration allows you to sync HRIS data between Lattice and your application through Kombo's unified API. The tool slug for this connector is `lattice`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/36109473272977-Lattice-How-do-I-link-my-account">
    Step-by-step instructions to connect your Lattice account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
    </Accordion>

    <Accordion title="Performance Review Cycles">
      | Field                       | Notes |
      | --------------------------- | ----- |
      | id                          |       |
      | remote\_id                  |       |
      | changed\_at                 |       |
      | remote\_deleted\_at         |       |
      | name                        |       |
      | review\_period\_start\_date |       |
      | remote\_data                |       |
    </Accordion>

    <Accordion title="Performance Reviews">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | review\_cycle\_id   |       |
      | reviewee\_id        |       |
      | reviewer\_id        |       |
      | type                |       |
      | summary\_rating     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | OAuth              |       |
    | API Passthrough    |       |
    | Connection Guide   |       |
    | Employment History |       |
    | Group Types        |       |
    | DEPARTMENT         |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Info>
      Some **optional** form fields are referencing the following data models:

      * Employees

      Consider enabling these in your [scope configuration](/hris/features/scopes).
    </Info>

    <Warning>
      This form may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
    </Warning>

    <ResponseField name="personal" type="object">
      **Personal Information**

      <Expandable title="properties">
        <Warning>
          This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
        </Warning>

        <ResponseField name="preferred_first_name" type="text">**Preferred first name**</ResponseField>
        <ResponseField name="preferred_last_name" type="text">**Preferred last name**</ResponseField>
        <ResponseField name="legal_first_name" type="text">**Legal first name**<br />
        Unified field: `first_name`</ResponseField>
        <ResponseField name="legal_middle_name" type="text">**Legal middle name**</ResponseField>
        <ResponseField name="legal_last_name" type="text">**Legal last name**<br />
        Unified field: `last_name`</ResponseField>
        <ResponseField name="company_employee_id" type="text">**Employee ID**</ResponseField>
        <ResponseField name="birthdate" type="date">**Birthdate**<br />
        Unified field: `date_of_birth`</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="role_details" type="object">
      **Role Details**

      <Expandable title="properties">
        <Warning>
          This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
        </Warning>

        <ResponseField name="manager" type="single_select">**Manager**<br />
        References `/v1/hris/employees?remote_model=employee`</ResponseField>
        <ResponseField name="department" type="single_select">**Department**</ResponseField>
        <ResponseField name="job_title" type="text">**Job title**<br />
        Unified field: `job_title`</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="demographic" type="object">
      **Demographic Information**

      <Expandable title="properties">
        <ResponseField name="binary_sex" type="single_select">**Binary sex**</ResponseField>
        <ResponseField name="gender_identity" type="single_select">**Gender identity**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="sensitive_data" type="object">
      **Sensitive Data**

      <Expandable title="properties">
        <ResponseField name="ssn" type="text">**SSN**<br />
        Enter numbers only (no dashes or spaces)</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="contact_information" type="object">
      **Contact Information**

      <Expandable title="properties">
        <ResponseField name="personal_email" type="text">**Personal email**<br />
        Unified field: `private_email`</ResponseField>
        <ResponseField name="work_email" type="text">**Work email**</ResponseField>
        <ResponseField name="phone_number" type="text">**Phone number**<br />
        Unified field: `mobile_phone_number`</ResponseField>
        <ResponseField name="address_line_1" type="text">**Address line 1**</ResponseField>
        <ResponseField name="address_line_2" type="text">**Address line 2**</ResponseField>
        <ResponseField name="address_city" type="text">**Address city**</ResponseField>
        <ResponseField name="address_state" type="single_select">**Address state**</ResponseField>
        <ResponseField name="address_country" type="single_select">**Address country**</ResponseField>
        <ResponseField name="address_postal_code" type="text">**Address postal code**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="employment_details" type="object">
      **Employment Details**

      <Expandable title="properties">
        <ResponseField name="employment_type" type="single_select">**Employment type**</ResponseField>
        <ResponseField name="start_date" type="date">**Start date**<br />
        Unified field: `start_date`</ResponseField>
        <ResponseField name="termination_date" type="date">**Termination date**</ResponseField>
        <ResponseField name="termination_type" type="single_select">**Termination type**</ResponseField>
        <ResponseField name="termination_reason" type="single_select">**Termination reason**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="pay_types" type="object">
      **Pay Types**

      <Expandable title="properties">
        <ResponseField name="base_pay_amount" type="number">**Base pay amount**</ResponseField>
        <ResponseField name="base_pay_currency" type="single_select">**Base pay currency**</ResponseField>
        <ResponseField name="base_pay_effective_at" type="date">**Base pay effective date**</ResponseField>
        <ResponseField name="base_pay_payment_type" type="single_select">**Base payment type**</ResponseField>
        <ResponseField name="base_pay_schedule" type="single_select">**Base pay schedule**</ResponseField>
      </Expandable>
    </ResponseField>
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Legacy Lattice HRIS API variant (deprecated). Lattice has deprecated their HRIS API. Please migrate to the Lattice Talent variant for continued support

For **Lattice**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Lattice Talent" icon="https://storage.googleapis.com/kombo-assets/integrations/latticetalent/icon.svg" href="/hris/connectors/latticetalent">
    Recommended variant using the Lattice Talent API with API key authentication. This is the replacement for the deprecated HRIS API
  </Card>
</CardGroup>

<Note>Multiple variants can be used within your Kombo environment at the same time.</Note>


# Lattice Talent HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/latticetalent

Lattice Talent connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Lattice Talent HRIS integration allows you to sync HRIS data between Lattice Talent and your application through Kombo's unified API. The tool slug for this connector is `latticetalent`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/43223520466577-How-do-I-link-my-Lattice-account">
    Step-by-step instructions to connect your Lattice Talent account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Employees">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | job\_title          |       |
      | work\_email         |       |
      | gender              |       |
      | manager\_id         |       |
      | date\_of\_birth     |       |
      | start\_date         |       |
      | remote\_created\_at |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Performance Review Cycles">
      | Field                       | Notes |
      | --------------------------- | ----- |
      | id                          |       |
      | remote\_id                  |       |
      | changed\_at                 |       |
      | remote\_deleted\_at         |       |
      | name                        |       |
      | review\_period\_start\_date |       |
      | remote\_data                |       |
    </Accordion>

    <Accordion title="Performance Reviews">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | review\_cycle\_id   |       |
      | reviewee\_id        |       |
      | reviewer\_id        |       |
      | type                |       |
      | summary\_rating     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | API Passthrough  |       |
    | Connection Guide |       |
    | Group Types      |       |
    | DEPARTMENT       |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Recommended variant using the Lattice Talent API with API key authentication. This is the replacement for the deprecated HRIS API

For **Lattice Talent**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Lattice" icon="https://storage.googleapis.com/kombo-assets/integrations/lattice/icon.svg" href="/hris/connectors/lattice">
    Legacy Lattice HRIS API variant (deprecated). Lattice has deprecated their HRIS API. Please migrate to the Lattice Talent variant for continued support
  </Card>
</CardGroup>

<Note>Multiple variants can be used within your Kombo environment at the same time.</Note>


# Leapsome HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/leapsome

Leapsome connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Leapsome HRIS integration allows you to sync HRIS data between Leapsome and your application through Kombo's unified API. The tool slug for this connector is `leapsome`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/30303286926225-Leapsome-How-do-I-link-my-account">
    Step-by-step instructions to connect your Leapsome account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | display\_full\_name |       |
      | job\_title          |       |
      | work\_email         |       |
      | employment\_status  |       |
      | employment\_type    |       |
      | weekly\_hours       |       |
      | work\_location\_id  |       |
      | manager\_id         |       |
      | start\_date         |       |
      | termination\_date   |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | name                    |       |
      | unit                    |       |
      | half\_days\_supported   |       |
      | exact\_times\_supported |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_half\_day    |       |
      | end\_half\_day      |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Performance Review Cycles">
      | Field                       | Notes |
      | --------------------------- | ----- |
      | id                          |       |
      | remote\_id                  |       |
      | changed\_at                 |       |
      | remote\_deleted\_at         |       |
      | name                        |       |
      | review\_period\_start\_date |       |
      | remote\_data                |       |
    </Accordion>

    <Accordion title="Performance Reviews">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | review\_cycle\_id   |       |
      | reviewee\_id        |       |
      | reviewer\_id        |       |
      | type                |       |
      | summary\_rating     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee">
      | Input Field | Notes |
      | ----------- | ----- |
      | first\_name |       |
      | last\_name  |       |
      | work\_email |       |
      | job\_title  |       |
      | start\_date |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | API Passthrough  |       |
    | Connection Guide |       |
    | Prerequisites    |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <ResponseField name="userName" type="text">**Work Email**<br />
    The work email address of the employee. This is used as the userName in Leapsome.<br />
    Unified field: `work_email`</ResponseField>
    <ResponseField name="givenName" type="text">**First Name**<br />
    The first name of the employee<br />
    Unified field: `first_name`</ResponseField>
    <ResponseField name="familyName" type="text">**Last Name**<br />
    The last name of the employee<br />
    Unified field: `last_name`</ResponseField>
    <ResponseField name="displayName" type="text">**Display Name**</ResponseField>
    <ResponseField name="title" type="text">**Job Title**<br />
    The title of the position this person is working in<br />
    Unified field: `job_title`</ResponseField>
    <ResponseField name="startDate" type="date">**Start Date**<br />
    Start date of the employee. Also considered to be the hire date<br />
    Unified field: `start_date`</ResponseField>
    <ResponseField name="birthday" type="date">**Date of Birth**<br />
    The employee's date of birth<br />
    Unified field: `date_of_birth`</ResponseField>
    <ResponseField name="gender" type="single_select">**Gender**<br />
    The gender of the employee<br />
    Unified field: `gender`</ResponseField>
    <ResponseField name="department" type="text">**Department**</ResponseField>
    <ResponseField name="division" type="text">**Division**</ResponseField>
    <ResponseField name="costCenter" type="text">**Cost Center**</ResponseField>
    <ResponseField name="level" type="text">**Level**<br />
    The job level or seniority (e.g., "Senior Engineer").</ResponseField>
    <ResponseField name="employmentType" type="single_select">**Employment Type**</ResponseField>
    <ResponseField name="location" type="text">**Location**<br />
    The work location of the employee (e.g., "Berlin").</ResponseField>
    <ResponseField name="photoUrl" type="text">**Photo URL**<br />
    A publicly accessible URL to the employee photo. Leapsome will fetch the image from this URL.</ResponseField>
  </Tab>
</Tabs>


# Loket HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/loket

Loket connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Loket HRIS integration allows you to sync HRIS data between Loket and your application through Kombo's unified API. The tool slug for this connector is `loket`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/32836609621521-Loket-How-do-I-link-my-account">
    Step-by-step instructions to connect your Loket account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | tax\_id               |       |
      | gender                |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | avatar                |       |
      | legal\_entity\_id     |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | OAuth            |       |
    | API Passthrough  |       |
    | Connection Guide |       |
    | Prerequisites    |       |
    | Group Types      |       |
    | DEPARTMENT       |       |
  </Tab>
</Tabs>


# Lucca HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/lucca

Lucca connector for Kombo's HRIS API

The Lucca HRIS integration allows you to sync HRIS data between Lucca and your application through Kombo's unified API. The tool slug for this connector is `lucca`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/19686865697681">
    Step-by-step instructions to connect your Lucca account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      <Note>
        Access to employee work locations in Lucca requires that your customer has the "Timmi Office" module enabled. This is a paid module of Lucca so your customer might not have it enabled. Please co-ordinate with your customer around this expectation.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes                                                                                                                                                                                                                                                                              |
      | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
      | id                    |                                                                                                                                                                                                                                                                                    |
      | remote\_id            |                                                                                                                                                                                                                                                                                    |
      | changed\_at           |                                                                                                                                                                                                                                                                                    |
      | remote\_deleted\_at   |                                                                                                                                                                                                                                                                                    |
      | employee\_number      |                                                                                                                                                                                                                                                                                    |
      | first\_name           |                                                                                                                                                                                                                                                                                    |
      | last\_name            |                                                                                                                                                                                                                                                                                    |
      | nationality           |                                                                                                                                                                                                                                                                                    |
      | display\_full\_name   |                                                                                                                                                                                                                                                                                    |
      | job\_title            |                                                                                                                                                                                                                                                                                    |
      | work\_email           |                                                                                                                                                                                                                                                                                    |
      | personal\_email       |                                                                                                                                                                                                                                                                                    |
      | mobile\_phone\_number |                                                                                                                                                                                                                                                                                    |
      | ssn                   |                                                                                                                                                                                                                                                                                    |
      | gender                |                                                                                                                                                                                                                                                                                    |
      | employment\_status    |                                                                                                                                                                                                                                                                                    |
      | employment\_type      | The employment type of an employee can only be retrieved from the `applicationData.fullTimeEquivalent` which belongs to the "Pagga-Remuneration" module. To minimize the scopes your customer has to grant, this module is not requested unless you are syncing compensation data. |
      | avatar                |                                                                                                                                                                                                                                                                                    |
      | work\_location\_id    |                                                                                                                                                                                                                                                                                    |
      | legal\_entity\_id     |                                                                                                                                                                                                                                                                                    |
      | manager\_id           |                                                                                                                                                                                                                                                                                    |
      | home\_address         |                                                                                                                                                                                                                                                                                    |
      | bank\_accounts        |                                                                                                                                                                                                                                                                                    |
      | date\_of\_birth       |                                                                                                                                                                                                                                                                                    |
      | start\_date           |                                                                                                                                                                                                                                                                                    |
      | termination\_date     |                                                                                                                                                                                                                                                                                    |
      | remote\_created\_at   |                                                                                                                                                                                                                                                                                    |
      | custom\_fields        |                                                                                                                                                                                                                                                                                    |
      | integration\_fields   |                                                                                                                                                                                                                                                                                    |
      | remote\_data          |                                                                                                                                                                                                                                                                                    |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | name                    |       |
      | half\_days\_supported   |       |
      | exact\_times\_supported |       |
    </Accordion>

    <Accordion title="Absences">
      <Note>
        Leave requests can be approved by multiple people. We take the latest approver.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | approver\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_half\_day    |       |
      | end\_half\_day      |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_created\_at |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | parent\_id          |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | API Passthrough       |       |
    | Scope Testing         |       |
    | Per Model Tests       |       |
    | Custom Field Explorer |       |
    | Employees             |       |
    | Employments           |       |
    | Connection Guide      |       |
    | Prerequisites         |       |
    | Create credentials    |       |
    | Group Types           |       |
    | DEPARTMENT            |       |
  </Tab>
</Tabs>


# Mirus HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/mirus

Mirus connector for Kombo's HRIS API

The Mirus HRIS integration allows you to sync HRIS data between Mirus and your application through Kombo's unified API. The tool slug for this connector is `mirus`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/29854715403921">
    Step-by-step instructions to connect your Mirus account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | job\_title            |       |
      | work\_email           |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | employment\_status    |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
    | Group Types        |       |
    | COST\_CENTER       |       |
  </Tab>
</Tabs>


# Namely HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/namely

Namely connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Namely HRIS integration allows you to sync HRIS data between Namely and your application through Kombo's unified API. The tool slug for this connector is `namely`.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature       | Notes |
    | ------------- | ----- |
    | Scope Testing |       |
    | Group Types   |       |
    | TEAM          |       |
    | DEPARTMENT    |       |
  </Tab>
</Tabs>


# Nibelis HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/nibelis

Nibelis connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Nibelis HRIS integration allows you to sync HRIS data between Nibelis and your application through Kombo's unified API. The tool slug for this connector is `nibelis`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/26669340875921-Nibelis-How-do-I-link-my-account">
    Step-by-step instructions to connect your Nibelis account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | Scope Testing      |       |
    | Per Model Tests    |       |
    | Connection Guide   |       |
    | Create credentials |       |
  </Tab>
</Tabs>


# Nmbrs HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/nmbrs

Nmbrs connector for Kombo's HRIS API

The Nmbrs HRIS integration allows you to sync HRIS data between Nmbrs and your application through Kombo's unified API. The tool slug for this connector is `nmbrs`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/16969080424081-How-do-I-link-my-Nmbrs-account-">
    Step-by-step instructions to connect your Nmbrs account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes                                                                                                                                                                                                                                                             |
      | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
      | id                    |                                                                                                                                                                                                                                                                   |
      | remote\_id            |                                                                                                                                                                                                                                                                   |
      | changed\_at           |                                                                                                                                                                                                                                                                   |
      | remote\_deleted\_at   |                                                                                                                                                                                                                                                                   |
      | employee\_number      |                                                                                                                                                                                                                                                                   |
      | first\_name           |                                                                                                                                                                                                                                                                   |
      | last\_name            |                                                                                                                                                                                                                                                                   |
      | display\_full\_name   |                                                                                                                                                                                                                                                                   |
      | job\_title            |                                                                                                                                                                                                                                                                   |
      | work\_email           |                                                                                                                                                                                                                                                                   |
      | personal\_email       |                                                                                                                                                                                                                                                                   |
      | mobile\_phone\_number |                                                                                                                                                                                                                                                                   |
      | ssn                   |                                                                                                                                                                                                                                                                   |
      | gender                |                                                                                                                                                                                                                                                                   |
      | marital\_status       |                                                                                                                                                                                                                                                                   |
      | employment\_status    |                                                                                                                                                                                                                                                                   |
      | employment\_type      |                                                                                                                                                                                                                                                                   |
      | work\_location\_id    |                                                                                                                                                                                                                                                                   |
      | legal\_entity\_id     |                                                                                                                                                                                                                                                                   |
      | manager\_id           | In Nmbrs managers are not necessarily employees. We will connect them based on their email address (falling back to matching by employee number, or by name if advanced matching is enabled) but when we can't find a matching employee the manager will be null. |
      | home\_address         |                                                                                                                                                                                                                                                                   |
      | bank\_accounts        |                                                                                                                                                                                                                                                                   |
      | date\_of\_birth       |                                                                                                                                                                                                                                                                   |
      | start\_date           |                                                                                                                                                                                                                                                                   |
      | termination\_date     |                                                                                                                                                                                                                                                                   |
      | remote\_created\_at   |                                                                                                                                                                                                                                                                   |
      | custom\_fields        |                                                                                                                                                                                                                                                                   |
      | integration\_fields   |                                                                                                                                                                                                                                                                   |
      | remote\_data          |                                                                                                                                                                                                                                                                   |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee Document Categories">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee">
      <Note>
        Nmbrs requires a company to be set for the employee. Most instances we see have just one company. We will default to the first company we find if `legal_entity_id` is not provided in the request body.
      </Note>

      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | gender                  |       |
      | home\_address.street\_1 |       |
      | home\_address.city      |       |
      | home\_address.state     |       |
      | home\_address.zip\_code |       |
      | home\_address.country   |       |
      | date\_of\_birth         |       |
      | mobile\_phone\_number   |       |
      | start\_date             |       |
      | legal\_entity\_id       |       |
    </Accordion>

    <Accordion title="Add document to employee">
      | Input Field            | Notes |
      | ---------------------- | ----- |
      | employee\_id           |       |
      | category\_id           |       |
      | document.name          |       |
      | document.content\_type |       |
      | document.data\_url     |       |
      | document.data          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | API Passthrough    |       |
    | Scope Testing      |       |
    | Per Model Tests    |       |
    | Per Field Tests    |       |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
    | Group Types        |       |
    | DEPARTMENT         |       |
  </Tab>
</Tabs>


# Officient HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/officient

Officient connector for Kombo's HRIS API

The Officient HRIS integration allows you to sync HRIS data between Officient and your application through Kombo's unified API. The tool slug for this connector is `officient`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/24094126426385-Officient-How-do-I-link-my-account">
    Step-by-step instructions to connect your Officient account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | first\_name           |       |
      | last\_name            |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | avatar                |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | name                  |       |
      | half\_days\_supported |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | start\_time         |       |
      | end\_time           |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | Scope Testing      |       |
    | Connection Guide   |       |
    | Create credentials |       |
    | Group Types        |       |
    | TEAM               |       |
  </Tab>
</Tabs>


# Okta HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/okta

Okta connector for Kombo's HRIS API

The Okta HRIS integration allows you to sync HRIS data between Okta and your application through Kombo's unified API. The tool slug for this connector is `okta`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/17889314378897">
    Step-by-step instructions to connect your Okta account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | employment\_status    |       |
      | avatar                |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee">
      <Note>
        When an employee is created, an email is sent to the user with an activation token that the user can use to complete the activation process
      </Note>

      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | job\_title              |       |
      | home\_address.street\_1 |       |
      | home\_address.city      |       |
      | home\_address.zip\_code |       |
      | home\_address.country   |       |
      | mobile\_phone\_number   |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | API Passthrough       |       |
    | Additional Scopes     |       |
    | Webhook Subscriptions |       |
    | Automatic Setup       |       |
    | Delta Syncs           |       |
    | Connection Guide      |       |
    | Prerequisites         |       |
    | Create credentials    |       |
  </Tab>
</Tabs>


# Oracle HCM HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/oraclehcm

Oracle HCM connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Oracle HCM HRIS integration allows you to sync HRIS data between Oracle HCM and your application through Kombo's unified API. The tool slug for this connector is `oraclehcm`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/21048576776209-Oracle-HCM-How-do-I-link-my-account-">
    Step-by-step instructions to connect your Oracle HCM account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | ethnicity             |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | name                    |       |
      | unit                    |       |
      | half\_days\_supported   |       |
      | exact\_times\_supported |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_time         |       |
      | end\_time           |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Timesheets">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | started\_at         |       |
      | ended\_at           |       |
      | payable\_hours      |       |
      | approval\_status    |       |
      | comment             |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Performance Review Cycles">
      | Field                       | Notes |
      | --------------------------- | ----- |
      | id                          |       |
      | remote\_id                  |       |
      | changed\_at                 |       |
      | remote\_deleted\_at         |       |
      | name                        |       |
      | review\_period\_start\_date |       |
      | remote\_data                |       |
    </Accordion>

    <Accordion title="Performance Reviews">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | review\_cycle\_id   |       |
      | reviewee\_id        |       |
      | reviewer\_id        |       |
      | type                |       |
      | summary\_comment    |       |
      | summary\_rating     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Skill Proficiency Scales">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | scale               |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Skills">
      | Field                  | Notes |
      | ---------------------- | ----- |
      | id                     |       |
      | remote\_id             |       |
      | changed\_at            |       |
      | remote\_deleted\_at    |       |
      | name                   |       |
      | proficiency\_scale\_id |       |
      | remote\_data           |       |
    </Accordion>

    <Accordion title="Skill Rating Providers">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee Skill Proficiency Ratings">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | employee\_id         |       |
      | skill\_id            |       |
      | proficiency          |       |
      | rating\_source       |       |
      | rating\_provider\_id |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee">
      <Note>
        Oracle HCM requires `legal_entity_id`, `start_date` and `nationality` when creating employees. Please provide it in the request body. Oracle HCM requires a business unit and a department to be assigned when creating employees. Please provide it in the request body via the `remote_fields`.
      </Note>

      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | job\_title              |       |
      | home\_address.street\_1 |       |
      | home\_address.street\_2 |       |
      | home\_address.city      |       |
      | home\_address.state     |       |
      | home\_address.zip\_code |       |
      | home\_address.country   |       |
      | date\_of\_birth         |       |
      | mobile\_phone\_number   |       |
      | nationality             |       |
      | start\_date             |       |
      | legal\_entity\_id       |       |
      | location\_id            |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>

    <Accordion title="Upsert employee skill proficiency rating">
      <Note>
        Oracle HCM can assign a skill to an employee but not rate it, so a submitted `proficiency` is rejected.
      </Note>

      | Input Field           | Notes |
      | --------------------- | ----- |
      | employee\_id          |       |
      | skill\_id             |       |
      | rating.rating\_source |       |
      | rating.proficiency    |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | API Passthrough  |       |
    | Scope Testing    |       |
    | Connection Guide |       |
    | Group Types      |       |
    | TEAM             |       |
    | DEPARTMENT       |       |
    | COST\_CENTER     |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Info>
      Some **required** form fields are referencing the following data models:

      * Groups
      * Legal Entities

      Additionally, there are some **optional** form fields that reference:

      * Employees

      Consider enabling these in your [scope configuration](/hris/features/scopes).
    </Info>

    <ResponseField name="CorrespondenceLanguage" type="single_select">**Correspondence Language**<br />
    Preferred language for communication. Valid values are defined in the commonLookupsLOV.</ResponseField>
    <ResponseField name="BloodType" type="single_select">**Blood Type**<br />
    Blood type of the person. Valid values are defined in the commonLookupsLOV.</ResponseField>
    <ResponseField name="DateOfBirth" type="date">**Date of Birth**<br />
    Date of birth of the person.</ResponseField>
    <ResponseField name="DateOfDeath" type="date">**Date of Death**<br />
    Date of death of the person.</ResponseField>
    <ResponseField name="CountryOfBirth" type="single_select">**Country of Birth**<br />
    Country of birth of the person. Valid values are defined in the hcmCountriesLOV.</ResponseField>
    <ResponseField name="RegionOfBirth" type="text">**Region of Birth**<br />
    Region of birth of the person.</ResponseField>
    <ResponseField name="TownOfBirth" type="text">**Town of Birth**<br />
    Town of birth of the person.</ResponseField>
    <ResponseField name="ApplicantNumber" type="text">**Applicant Number**<br />
    Applicant number in the external application.</ResponseField>

    <ResponseField name="addresses" type="object">
      **Addresses**<br />
      The addresses resource is a child of the workers resource. It provides all the addresses of a worker as of the specified date. By default, the current date is retained.

      <Expandable title="properties">
        <ResponseField name="AddressLine1" type="text">**Address Line 1**<br />
        First line of the primary mail address.</ResponseField>
        <ResponseField name="AddressLine2" type="text">**Address Line 2**<br />
        Second line of the primary mail address.</ResponseField>
        <ResponseField name="AddressLine3" type="text">**Address Line 3**<br />
        Third line of the primary mail address.</ResponseField>
        <ResponseField name="AddressLine4" type="text">**Address Line 4**<br />
        Fourth line of the primary mail address.</ResponseField>
        <ResponseField name="TownOrCity" type="text">**Town or City**<br />
        Town or city in which the address is located.</ResponseField>
        <ResponseField name="Region1" type="text">**Region 1**<br />
        Primary region in which the address is located.</ResponseField>
        <ResponseField name="Region2" type="text">**Region 2**<br />
        Secondary region within the primary region.</ResponseField>
        <ResponseField name="Region3" type="text">**Region 3**<br />
        Additional secondary region within the primary region.</ResponseField>
        <ResponseField name="Country" type="single_select">Country in which the address is located. Valid values are defined in the hcmCountriesLov.</ResponseField>
        <ResponseField name="PostalCode" type="text">**Postal Code**<br />
        Postal code of the primary mail address.</ResponseField>
        <ResponseField name="LongPostalCode" type="text">**Long Postal Code**<br />
        Long postal code of the primary mail address.</ResponseField>
        <ResponseField name="AddlAddressAttribute1" type="text">**Additional Address Attribute 1**<br />
        Additional address column used by localizations.</ResponseField>
        <ResponseField name="AddlAddressAttribute2" type="text">**Additional Address Attribute 2**<br />
        Additional address column used by localizations.</ResponseField>
        <ResponseField name="AddlAddressAttribute3" type="text">**Additional Address Attribute 3**<br />
        Additional address column used by localizations.</ResponseField>
        <ResponseField name="AddlAddressAttribute4" type="text">**Additional Address Attribute 4**<br />
        Additional address column used by localizations.</ResponseField>
        <ResponseField name="AddlAddressAttribute5" type="text">**Additional Address Attribute 5**<br />
        Additional address column used by localizations.</ResponseField>
        <ResponseField name="Building" type="text">Building information associated with the address.</ResponseField>
        <ResponseField name="FloorNumber" type="text">**Floor Number**<br />
        Floor number associated with the building.</ResponseField>
        <ResponseField name="AddressType" type="single_select">**Type**<br />
        Type of address. Valid values are defined in the commonLookupsLOV.</ResponseField>
        <ResponseField name="ValidationStatusCode" type="text">**Validation Status Code**<br />
        Level of accuracy of an address, as determined by an address provider.</ResponseField>
        <ResponseField name="Provider" type="text">Company that has validated the address.</ResponseField>
        <ResponseField name="Longitude" type="number">Distance between the prime meridian and an address located to its east or west, expressed in degrees and minutes.</ResponseField>
        <ResponseField name="Latitude" type="number">Distance between the equator and an address located to its north or south, expressed in degrees and minutes.</ResponseField>
        <ResponseField name="ValidateAddressFlag" type="checkbox">**Validate Address Flag**<br />
        Indicates whether the address is sent for validation. Valid values are true and false. The default value is false.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="citizenships" type="object">
      **Citizenships**<br />
      The citizenships resource is a child of the workers resource. It provides all the citizenships of a worker as of the specified date. By default, the current date is retained.

      <Expandable title="properties">
        <ResponseField name="Citizenship" type="single_select">Citizenship legislation code. Valid values are defined in the hcmCountriesLov.</ResponseField>
        <ResponseField name="FromDate" type="date">**From Date**<br />
        Date from when the citizenship is valid.</ResponseField>
        <ResponseField name="ToDate" type="date">**To Date**<br />
        Date until when the citizenship is valid.</ResponseField>
        <ResponseField name="CitizenshipStatus" type="single_select">**Citizenship Status**<br />
        Status of the citizenship. Valid values are defined in the commonLookupsLOV.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="disabilities" type="object">
      **Disabilities**<br />
      The disabilities resource is a child of the workers resource. It provides all the worker disabilities as of the specified date. By default, the current date is retained.

      <Expandable title="properties">
        <ResponseField name="LegislationCode" type="single_select">**Country**<br />
        Legislation code for the disability. Valid values are defined in the hcmCountriesLov.</ResponseField>
        <ResponseField name="QuotaFTE" type="number">**FTE**<br />
        Person's full time equivalency.</ResponseField>
        <ResponseField name="Status" type="single_select">Status of the person's disability.</ResponseField>
        <ResponseField name="Reason" type="single_select">Reason for the person's disability.</ResponseField>
        <ResponseField name="Degree" type="number">Extent to which the disability impacts the person's abilities.</ResponseField>
        <ResponseField name="SelfDisclosedType" type="text">**Self-Disclosed Disability**<br />
        Type of disability disclosed by the worker. Used explicitly for the Japanese, United Kingdom, and United States legislation.</ResponseField>
        <ResponseField name="DisclosureDate" type="date">**Disclosure Date**<br />
        Date on which the disability has been disclosed by the worker. Used explicitly for the Japanese, United Kingdom, and United States legislation.</ResponseField>
        <ResponseField name="AccommodationRequest" type="text">**Reasonable Accommodation Request**<br />
        Request for accommodation.</ResponseField>
        <ResponseField name="RegistrationDate" type="date">**Registration Date**<br />
        Date on which the disability was registered with the disability organization.</ResponseField>
        <ResponseField name="RegistrationExpDate" type="date">**Expiration Date**<br />
        Expiration date of the disability registration.</ResponseField>
        <ResponseField name="RegistrationId" type="text">**Registration ID**<br />
        Identification detail given to the person by the disability organization.</ResponseField>
        <ResponseField name="OrganizationId" type="number">**Disability Organization**<br />
        Unique identifier of the organization.</ResponseField>
        <ResponseField name="Description" type="text">Description of the person's disability.</ResponseField>
        <ResponseField name="WorkRestriction" type="text">**Work Restrictions**<br />
        Details of any work restrictions due to the disability.</ResponseField>

        <ResponseField name="attachments" type="object">
          **Attachments**<br />
          The attachments resource is used to view, create, and update attachments.

          <Expandable title="properties">
            <ResponseField name="DatatypeCode" type="text">**Type**<br />
            A value that indicates the data type.</ResponseField>
            <ResponseField name="FileName" type="text">**File Name**<br />
            The file name of the attachment.</ResponseField>
            <ResponseField name="DmFolderPath" type="text">**Dm Folder Path**<br />
            The folder path from which the attachment is created.</ResponseField>
            <ResponseField name="DmDocumentId" type="text">**Dm Document Id**<br />
            The document ID from which the attachment is created.</ResponseField>
            <ResponseField name="DmVersionNumber" type="text">**Dm Version Number**<br />
            The document version number from which the attachment is created.</ResponseField>
            <ResponseField name="Url" type="text">The URL of a web page type attachment.</ResponseField>
            <ResponseField name="CategoryName" type="text">**Category**<br />
            The category of the attachment.</ResponseField>
            <ResponseField name="Uri" type="text">The URI of a Topology Manager type attachment.</ResponseField>
            <ResponseField name="FileUrl" type="text">**File Url**<br />
            The URI of the file.</ResponseField>
            <ResponseField name="UploadedText" type="text">**Uploaded Text**<br />
            The text content for a new text attachment.</ResponseField>
            <ResponseField name="UploadedFileContentType" type="text">**Uploaded File Content Type**<br />
            The content type of the attachment.</ResponseField>
            <ResponseField name="UploadedFileLength" type="number">**File Size**<br />
            The size of the attachment file.</ResponseField>
            <ResponseField name="UploadedFileName" type="text">**Uploaded File Name**<br />
            The name to assign to a new attachment file.</ResponseField>
            <ResponseField name="ContentRepositoryFileShared" type="checkbox">**Shared**<br />
            Indicates whether the attachment is shared</ResponseField>
            <ResponseField name="Title" type="text">The title of the attachment.</ResponseField>
            <ResponseField name="Description" type="text">The description of the attachment.</ResponseField>
            <ResponseField name="ErrorStatusCode" type="text">**Error Status Code**<br />
            The error code, if any, for the attachment.</ResponseField>
            <ResponseField name="ErrorStatusMessage" type="text">**Error Status Message**<br />
            The error message, if any, for the attachment.</ResponseField>
            <ResponseField name="AsyncTrackerId" type="text">**Asynchronous Upload Tracker Id**<br />
            Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.</ResponseField>
            <ResponseField name="DownloadInfo" type="text">JSON object represented as a string containing information used to programmatically retrieve a file attachment.</ResponseField>
            <ResponseField name="PostProcessingAction" type="text">**Post Processing Action**<br />
            The name of the action that can be performed after an attachment is uploaded.</ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="driverLicenses" type="object">
      **Driver Licenses**<br />
      The driverLicenses resource is a child of the workers resource. It provides all the driver licenses of a worker as of the specified date. By default, the current date is retained.

      <Expandable title="properties">
        <ResponseField name="LicenseType" type="single_select">**License Type**<br />
        Type of license. Valid values are defined in the commonLookupsLOV.</ResponseField>
        <ResponseField name="IssuingCountry" type="single_select">**Issuing Country**<br />
        Country in which the driver's license was issued. Valid values are defined in the hcmCountriesLov.</ResponseField>
        <ResponseField name="LicenseNumber" type="text">**License Number**<br />
        Driver's license number.</ResponseField>
        <ResponseField name="IssuingAuthority" type="text">**Issuing Authority**<br />
        Issuing authority of the driver's license.</ResponseField>
        <ResponseField name="IssuingLocation" type="text">**Place of Issue**<br />
        Location where the driver's license was issued.</ResponseField>
        <ResponseField name="FromDate" type="date">**From Date**<br />
        Date from when the driver's license is valid.</ResponseField>
        <ResponseField name="ToDate" type="date">**To Date**<br />
        Date until when the driver's license is valid.</ResponseField>
        <ResponseField name="NumberOfPoints" type="number">**Number of Points**<br />
        Number of penalty points on the license.</ResponseField>
        <ResponseField name="Violations" type="number">Number of violations on the license.</ResponseField>
        <ResponseField name="LicenseSuspendedFlag" type="checkbox">**License Suspended**<br />
        Indicates whether the driver's license is suspended.</ResponseField>
        <ResponseField name="SuspendedFromDate" type="date">**Suspended-from Date**<br />
        Start date of suspension period, if any.</ResponseField>
        <ResponseField name="SuspendedToDate" type="date">**Suspension-to Date**<br />
        End date of suspension period, if any.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="emails" type="object">
      **Emails**<br />
      The emails resource is a child of the workers resource. It provides all the emails of a worker as of the specified date. By default, the current date is retained.

      <Expandable title="properties">
        <ResponseField name="EmailType" type="single_select">**Type**<br />
        Type of email such as work, personal, and so on. Valid values are defined in the commonLookupsLOV.</ResponseField>
        <ResponseField name="EmailAddress" type="text">**Email**<br />
        Email address of the person.</ResponseField>
        <ResponseField name="ToDate" type="date">**To Date**<br />
        Date until when the email address is valid.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="ethnicities" type="object">
      **Ethnicities**<br />
      The ethnicities resource is a child of the workers resource. It provides all the ethnicities of a worker as of the specified date. By default, the current date is retained.

      <Expandable title="properties">
        <ResponseField name="PrimaryFlag" type="checkbox">**Primary**<br />
        Indicates whether the ethnicity is the primary ethnicity record for the person.</ResponseField>
        <ResponseField name="LegislationCode" type="single_select">**Country**<br />
        Legislation code of the ethnicity. Valid values are defined in the hcmCountriesLov.</ResponseField>
        <ResponseField name="Ethnicity" type="single_select">Person's ethnicity. Valid values are defined in the commonLookupsLOV.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="externalIdentifiers" type="object">
      **External Identifiers**<br />
      The externalIdentifiers resource is a child of the workers resource. It provides all the external identifiers of a worker as of the specified date. By default, the current date is retained.

      <Expandable title="properties">
        <ResponseField name="ExternalIdentifierSequence" type="number">**Sequence**<br />
        Sequence of the external identifier.</ResponseField>
        <ResponseField name="ExternalIdentifierNumber" type="text">**Identifier**<br />
        External identifier number.</ResponseField>
        <ResponseField name="ExternalIdentifierType" type="single_select">**Identifier Type**<br />
        Type of external identifier, such as Third-Party Payroll ID. Valid values are defined in the commonLookupsLOV.</ResponseField>
        <ResponseField name="AssignmentId" type="number">**Assignment ID**<br />
        Unique identifier of the assignment to which this external identifier relates.</ResponseField>
        <ResponseField name="Comments" type="text">**Identifier Comments**<br />
        Comments for the external identifier.</ResponseField>
        <ResponseField name="AssignmentNumber" type="text">**Assignment Number**<br />
        Assignment number to which the external identifier belongs.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="legislativeInfo" type="object">
      **Legislative Information**<br />
      The legislativeInfo resource is a child of the workers resource. It provides the legislative information of a worker as of the specified date. By default, the current date is retained.

      <Expandable title="properties">
        <ResponseField name="LegislationCode" type="single_select">**Country**<br />
        Legislation code. Valid values are defined in the hcmCountriesLov.</ResponseField>
        <ResponseField name="Gender" type="single_select">Gender of the person. Valid values are defined in the commonLookupsLOV.</ResponseField>
        <ResponseField name="MaritalStatus" type="single_select">**Marital Status**<br />
        Marital status of the person. Valid values are defined in the commonLookupsLOV.</ResponseField>
        <ResponseField name="MaritalStatusChangeDate" type="date">**Marital Status Change Date**<br />
        Date from when the marital status came into effect.</ResponseField>
        <ResponseField name="HighestEducationLevel" type="single_select">**Highest Education Level**<br />
        Legislation-specific value that identifies the person's highest education level. Valid values are defined in the commonLookupsLOV.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="messages" type="object">
      **Messages**<br />
      The messages resource is a child of the workers resource. It provides all the available messages of a worker.

      <Expandable title="properties">
        <ResponseField name="MessageContent" type="text">**Notification**<br />
        Content of the message notification.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="names" type="object">
      **Names**<br />
      The names resource is a child of the workers resource. It provides all the names of a worker as of the specified date. By default, the current date is retained.

      <Expandable title="properties">
        <ResponseField name="LegislationCode" type="single_select">**Country**<br />
        Legislation code. Valid values are defined in the hcmCountriesLov.</ResponseField>
        <ResponseField name="LastName" type="text">**Last Name**<br />
        Person's last name.</ResponseField>
        <ResponseField name="FirstName" type="text">**First Name**<br />
        Person's first name.</ResponseField>
        <ResponseField name="Title" type="single_select">Person salutation such as Mr., Ms., and so on. Valid values are defined in the commonLookupsLOV.</ResponseField>
        <ResponseField name="PreNameAdjunct" type="text">**Prefix**<br />
        Part of the name added before a person's first name.</ResponseField>
        <ResponseField name="Suffix" type="text">Part of the name appended to a person's last name such as Jr., III, and so on.</ResponseField>
        <ResponseField name="MiddleNames" type="text">**Middle Names**<br />
        Person's middle name.</ResponseField>
        <ResponseField name="Honors" type="text">Higher qualification appended to a person's name such as PhD.</ResponseField>
        <ResponseField name="KnownAs" type="text">**Known As**<br />
        Person's preferred name.</ResponseField>
        <ResponseField name="PreviousLastName" type="text">**Previous Last Name**<br />
        Person's previous last name.</ResponseField>
        <ResponseField name="MilitaryRank" type="text">**Military Rank**<br />
        Person's military rank.</ResponseField>
        <ResponseField name="NameInformation1" type="text">**Name Information 1**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation2" type="text">**Name Information 2**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation3" type="text">**Name Information 3**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation4" type="text">**Name Information 4**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation5" type="text">**Name Information 5**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation6" type="text">**Name Information 6**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation7" type="text">**Name Information 7**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation8" type="text">**Name Information 8**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation9" type="text">**Name Information 9**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation10" type="text">**Name Information 10**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation11" type="text">**Name Information 11**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation12" type="text">**Name Information 12**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation13" type="text">**Name Information 13**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation14" type="text">**Name Information 14**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation15" type="text">**Name Information 15**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation16" type="text">**Name Information 16**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation17" type="text">**Name Information 17**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation18" type="text">**Name Information 18**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation19" type="text">**Name Information 19**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation20" type="text">**Name Information 20**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation21" type="text">**Name Information 21**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation22" type="text">**Name Information 22**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation23" type="text">**Name Information 23**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation24" type="text">**Name Information 24**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation25" type="text">**Name Information 25**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation26" type="text">**Name Information 26**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation27" type="text">**Name Information 27**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation28" type="text">**Name Information 28**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation29" type="text">**Name Information 29**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="NameInformation30" type="text">**Name Information 30**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalLegislationCode" type="single_select">**Country**<br />
        Legislation code of the local language. Valid values are defined in the hcmCountriesLov.</ResponseField>
        <ResponseField name="LocalLastName" type="text">**Last Name**<br />
        Person's last name in local language.</ResponseField>
        <ResponseField name="LocalFirstName" type="text">**First Name**<br />
        Person's first name in local language.</ResponseField>
        <ResponseField name="LocalTitle" type="single_select">**Title**<br />
        Person's salutation such as Mr., Ms., and so on in local language. Valid values are defined in the commonLookupsLOV.</ResponseField>
        <ResponseField name="LocalPreNameAdjunct" type="text">**Prefix**<br />
        Part of the name added before a person's first name in local language.</ResponseField>
        <ResponseField name="LocalSuffix" type="text">**Suffix**<br />
        Part of the name appended to a person's last name such as Jr., III, and so on, in local language.</ResponseField>
        <ResponseField name="LocalMiddleNames" type="text">**Middle Names**<br />
        Person's middle name in local language.</ResponseField>
        <ResponseField name="LocalHonors" type="text">**Honors**<br />
        Higher qualification appended to a person's name such as PhD in local language.</ResponseField>
        <ResponseField name="LocalKnownAs" type="text">**Known As**<br />
        Person's preferred name in local language.</ResponseField>
        <ResponseField name="LocalPreviousLastName" type="text">**Previous Last Name**<br />
        Person's previous last name in local language.</ResponseField>
        <ResponseField name="LocalMilitaryRank" type="text">**Military Rank**<br />
        Person's military rank in local language.</ResponseField>
        <ResponseField name="LocalNameLanguage" type="text">**Local-Name Language**<br />
        Local language of the name. This isn't required for global names. If you're creating a local name, you must provide the language code.</ResponseField>
        <ResponseField name="LocalNameInformation1" type="text">**Name Information 1**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation2" type="text">**Name Information 2**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation3" type="text">**Name Information 3**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation4" type="text">**Name Information 4**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation5" type="text">**Name Information 5**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation6" type="text">**Name Information 6**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation7" type="text">**Name Information 7**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation8" type="text">**Name Information 8**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation9" type="text">**Name Information 9**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation10" type="text">**Name Information 10**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation11" type="text">**Name Information 11**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation12" type="text">**Name Information 12**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation13" type="text">**Name Information 13**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation14" type="text">**Name Information 14**<br />
        Additional name attribute reserved for Oracle Development for legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation15" type="text">**Name Information 15**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation16" type="text">**Name Information 16**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation17" type="text">**Name Information 17**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation18" type="text">**Name Information 18**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation19" type="text">**Name Information 19**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation20" type="text">**Name Information 20**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation21" type="text">**Name Information 21**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation22" type="text">**Name Information 22**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation23" type="text">**Name Information 23**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation24" type="text">**Name Information 24**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation25" type="text">**Name Information 25**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation26" type="text">**Name Information 26**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation27" type="text">**Name Information 27**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation28" type="text">**Name Information 28**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation29" type="text">**Name Information 29**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
        <ResponseField name="LocalNameInformation30" type="text">**Name Information 30**<br />
        Additional name attribute reserved for customer legislation-specific name requirements as defined in the person name style definition.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="nationalIdentifiers" type="object">
      **National Identifiers**<br />
      The nationalIdentifiers resource is a child of the workers resource. It provides all the national identifiers of a worker as of the specified date. By default, the current date is retained.

      <Expandable title="properties">
        <ResponseField name="LegislationCode" type="single_select">**Country**<br />
        Legislation code of the national identifier. Valid values are defined in the hcmCountriesLov.</ResponseField>
        <ResponseField name="NationalIdentifierType" type="single_select">**National ID Type**<br />
        Type of national identifier. Valid values are defined in the commonLookupsLOV.</ResponseField>
        <ResponseField name="NationalIdentifierNumber" type="text">**National ID**<br />
        National identification number.</ResponseField>
        <ResponseField name="IssueDate" type="date">**Issue Date**<br />
        Issue date of the national identifier.</ResponseField>
        <ResponseField name="ExpirationDate" type="date">**Expiration Date**<br />
        Expiration date of the national identifier.</ResponseField>
        <ResponseField name="PlaceOfIssue" type="text">**Place of Issue**<br />
        Place where the national identifier was issued.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="otherCommunicationAccounts" type="object">
      **Other Communication Accounts**<br />
      The otherCommunicationAccounts resource is a child of the workers resource. It provides all the other communication accounts of a worker as of the specified date. By default, the current date is retained.

      <Expandable title="properties">
        <ResponseField name="Provider" type="single_select">Provider of the account such as Facebook and Twitter. Valid values are defined in the commonLookupsLOV.</ResponseField>
        <ResponseField name="AccountName" type="text">**Account Name**<br />
        Name of the account.</ResponseField>
        <ResponseField name="EndDate" type="date">**To Date**<br />
        End date of the account.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="passports" type="object">
      **Passports**<br />
      The passports resource is a child of the workers resource. It provides all worker of a worker as of the specified date. By default, the current date is retained.

      <Expandable title="properties">
        <ResponseField name="IssuingCountry" type="single_select">**Issuing Country**<br />
        Country in which the passport was issued. Valid values are defined in the hcmCountriesLov.</ResponseField>
        <ResponseField name="PassportType" type="single_select">**Type**<br />
        Type or category of the passport. Valid values are defined in the commonLookupsLOV.</ResponseField>
        <ResponseField name="PassportNumber" type="text">**Number**<br />
        Passport number of the person.</ResponseField>
        <ResponseField name="IssuingAuthority" type="text">**Issuing Authority**<br />
        Issuing authority for the passport.</ResponseField>
        <ResponseField name="IssueDate" type="date">**Issue Date**<br />
        Issue date of the passport.</ResponseField>
        <ResponseField name="ExpirationDate" type="date">**Expiration Date**<br />
        Expiration date of the passport.</ResponseField>
        <ResponseField name="IssuingLocation" type="text">**Issuing Location**<br />
        Location where the passport was issued.</ResponseField>
        <ResponseField name="Profession" type="text">Profession of the passport holder.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="phones" type="object">
      **Phones**<br />
      The phones resource is a child of the workers resource. It provides all the phones of a worker as of the specified date. By default, the current date is retained.

      <Expandable title="properties">
        <ResponseField name="PhoneType" type="single_select">**Type**<br />
        Type of phone such as Work, Home, and so on. Valid values are defined in the commonLookupsLOV.</ResponseField>
        <ResponseField name="LegislationCode" type="single_select">**Country**<br />
        Phone legislation code.</ResponseField>
        <ResponseField name="CountryCodeNumber" type="text">**Country Code**<br />
        Country code of the phone number. Valid values are defined in the hcmCountriesLov.</ResponseField>
        <ResponseField name="AreaCode" type="text">**Area Code**<br />
        Area code of the phone number.</ResponseField>
        <ResponseField name="PhoneNumber" type="text">**Number**<br />
        Phone number of various phone types such as Work, Home, and so on.</ResponseField>
        <ResponseField name="Extension" type="text">Extension number for the phone.</ResponseField>
        <ResponseField name="ToDate" type="date">**To Date**<br />
        Date until when the phone number is valid.</ResponseField>
        <ResponseField name="Validity" type="single_select">Time of day when a person can be reached at a specific phone number.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="photos" type="object">
      **Photos**<br />
      The photo resource is a child of the workers resource. It provides the all photos of a worker as of the specified date. By default, the current date is retained.

      <Expandable title="properties">
        <ResponseField name="PrimaryFlag" type="checkbox">**Primary**<br />
        Indicates whether the image is primary.</ResponseField>
        <ResponseField name="PhotoType" type="text">**Type**<br />
        Type of photo such as Profile or Cover. Valid values are defined in the commonLookupsLOV.</ResponseField>
        <ResponseField name="PhotoName" type="text">**Photo Name**<br />
        Name of the image file.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="religions" type="object">
      **Religions**<br />
      The religions resource is a child of the workers resource. It provides all the religions of a worker as of the specified date. By default, the current date is retained.

      <Expandable title="properties">
        <ResponseField name="LegislationCode" type="single_select">**Country**<br />
        Religion legislation code. Valid values are defined in the hcmCountriesLov.</ResponseField>
        <ResponseField name="PrimaryFlag" type="checkbox">**Primary**<br />
        Indicates whether the religion is the person's primary religion for this legislation.</ResponseField>
        <ResponseField name="Religion" type="single_select">Religion of the person. Valid values are defined in the commonLookupsLOV.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="visasPermits" type="object">
      **Visa Permits**<br />
      The visasPermits resource is a child of the workers resource. It provides all the visas and permits of a worker as of the specified date. By default, the current date is retained.

      <Expandable title="properties">
        <ResponseField name="IssuingCountry" type="single_select">**Issuing Country**<br />
        Country in which the visa or permit was issued. Valid values are defined in the hcmCountriesLov.</ResponseField>
        <ResponseField name="VisaPermitType" type="single_select">**Type**<br />
        Visa or permit type. Valid values are defined in the commonLookupsLOV.</ResponseField>
        <ResponseField name="VisaPermitCategory" type="text">**Category**<br />
        Category of the visa or permit. Valid values are defined in the commonLookupsLOV.</ResponseField>
        <ResponseField name="VisaPermitNumber" type="text">**Number**<br />
        Visa or permit number.</ResponseField>
        <ResponseField name="VisaPermitStatus" type="single_select">**Status**<br />
        Indicates if the visa or permit is current. Valid values are defined in the commonLookupsLOV.</ResponseField>
        <ResponseField name="IssuingAuthority" type="text">**Issuing Authority**<br />
        Issuing authority for the visa or permit.</ResponseField>
        <ResponseField name="IssuingLocation" type="text">**Place of Issue**<br />
        Location where the visa or permit was issued.</ResponseField>
        <ResponseField name="IssueDate" type="date">**Issue Date**<br />
        Date of issue of the visa or permit.</ResponseField>
        <ResponseField name="EntryDate" type="date">**Entry Date**<br />
        Entry date of the person into the country.</ResponseField>
        <ResponseField name="ExpirationDate" type="date">**Expiration Date**<br />
        Expiration date of the visa or permit.</ResponseField>
        <ResponseField name="VisaPermitStatusDate" type="date">**Status Change Date**<br />
        Date from when the permit status is effective.</ResponseField>
        <ResponseField name="Profession" type="text">Profession of the visa or permit holder.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="workRelationships" type="object">
      **Work Relationships**<br />
      The workRelationships resource is a child of the workers resource. It provides all the work relationships of a worker as of the specified date. By default, the current date is retained.

      <Expandable title="properties">
        <ResponseField name="LegalEntityId" type="single_select">**Legal Entity ID**<br />
        Unique identifier for the legal entity of the work relationship.<br />
        References `/v1/hris/legal-entities?remote_model=legal_entity`</ResponseField>
        <ResponseField name="WorkerType" type="single_select">**Worker Type**<br />
        Worker type for the period of service such as Employee (E), Contingent Worker (C), Pending Worker (P), or Nonworker (N). Valid values are defined in the commonLookupsLOV.</ResponseField>
        <ResponseField name="PrimaryFlag" type="checkbox">**Primary**<br />
        Indicates whether the work relationship is the primary work relationship for the worker. Valid values are Yes and No.</ResponseField>
        <ResponseField name="LegalEmployerSeniorityDate" type="date">**Seniority Date**<br />
        Date on which a person's legal-employer service of a particular type, such as employee, contingent worker, or nonworker, is based.</ResponseField>
        <ResponseField name="EnterpriseSeniorityDate" type="date">**Enterprise Seniority Date**<br />
        Adjusted service date. For example, for a rehire who was part of an acquisition, all plans might use the original hire date if rehired within 90 days of termination. However, a 401k plan might use the adjusted service date which was originally populated upon acquisition.</ResponseField>
        <ResponseField name="OnMilitaryServiceFlag" type="checkbox">**On Military Service**<br />
        Indicates whether the person is on military service.</ResponseField>
        <ResponseField name="WorkerNumber" type="text">**Worker Number**<br />
        Unique identifier for the worker.</ResponseField>
        <ResponseField name="ReadyToConvertFlag" type="checkbox">**Include for Automatic Conversion**<br />
        Indicates whether the pending worker is ready to be converted to the proposed worker type.</ResponseField>
        <ResponseField name="ProjectedTerminationDate" type="date">**Projected Termination Date**<br />
        Projected last date of employment for the period of service.</ResponseField>

        <ResponseField name="assignments" type="object">
          **Assignments**<br />
          The assignments resource is a child of the workRelationships resource. It provides all the worker assignments as of the specified date. By default, the current date is retained.

          <Expandable title="properties">
            <ResponseField name="AssignmentNumber" type="text">**Assignment Number**<br />
            Unique identifier for the assignment.</ResponseField>
            <ResponseField name="AssignmentName" type="text">**Business Title**<br />
            Business title of the worker assignment.</ResponseField>
            <ResponseField name="ActionCode" type="single_select">**Action Code**<br />
            Action being performed for this assignment, such as, Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV.</ResponseField>
            <ResponseField name="ReasonCode" type="single_select">**Reason Code**<br />
            Reason for the action being performed on the record. Valid values are defined in the actionReasonsLOV.</ResponseField>
            <ResponseField name="BusinessUnitId" type="single_select">**Business Unit ID**<br />
            Unique identifier for the business unit of the assignment.<br />
            References `/v1/hris/groups?types=TEAM`</ResponseField>
            <ResponseField name="BusinessUnitName" type="single_select">**Business Unit**<br />
            Name of the business unit for the worker assignment. Valid values are defined in the hcmBusinesUnitsLOV.</ResponseField>
            <ResponseField name="AssignmentStatusTypeCode" type="single_select">**Assignment Status Code**<br />
            Code for the assignment status type.</ResponseField>
            <ResponseField name="UserPersonTypeId" type="number">**User Person Type ID**<br />
            Unique identifier for the user person type.</ResponseField>
            <ResponseField name="UserPersonType" type="single_select">**User Person Type**<br />
            User-defined value that identifies the person type such as employee or contingent worker. Valid values are defined in the personTypesLOV.</ResponseField>
            <ResponseField name="ProposedUserPersonTypeId" type="text">**Proposed User Person Type ID**<br />
            Unique identifier for the proposed user person type.</ResponseField>
            <ResponseField name="ProposedUserPersonType" type="single_select">**Proposed Person Type**<br />
            Code of the proposed user person type. Valid values are defined in the personTypesLOV.</ResponseField>
            <ResponseField name="ProjectedStartDate" type="date">**Projected Start Date**<br />
            Expected start date for applicants. This value is required for pending workers.</ResponseField>
            <ResponseField name="ProjectedEndDate" type="date">**Projected End Date**<br />
            Date when the assignment is expected to end.</ResponseField>
            <ResponseField name="PrimaryAssignmentFlag" type="checkbox">**Primary Assignment**<br />
            Indicates whether the current assignment is primary for the work relationship. Valid values are true or false.</ResponseField>
            <ResponseField name="PositionId" type="number">**Position ID**<br />
            Unique identifier for the worker's position.</ResponseField>
            <ResponseField name="PositionCode" type="single_select">**Position Code**<br />
            Code for the worker's position.</ResponseField>
            <ResponseField name="SynchronizeFromPositionFlag" type="checkbox">**Synchronize from Position**<br />
            Indicates whether attributes from the position can be overridden on the assignment when using position synchronization. Valid values are true or false.</ResponseField>
            <ResponseField name="JobId" type="number">**Job ID**<br />
            Unique identifier for the worker's job.</ResponseField>
            <ResponseField name="JobCode" type="single_select">**Job Code**<br />
            Code for the worker's job. Valid values are defined in the jobsLov.</ResponseField>
            <ResponseField name="GradeId" type="number">**Grade ID**<br />
            Unique identifier for the worker's grade.</ResponseField>
            <ResponseField name="GradeCode" type="single_select">**Grade Code**<br />
            Code of the assignment grade. Valid values are defined in the gradesLov.</ResponseField>
            <ResponseField name="GradeLadderId" type="number">**Grade Ladder ID**<br />
            Unique identifier for the grade ladder used for benefits.</ResponseField>
            <ResponseField name="GradeLadderName" type="single_select">**Grade Ladder**<br />
            Name of the grade ladder used for benefits. Valid values are defined in the gradeLaddersLov.</ResponseField>
            <ResponseField name="GradeStepEligibilityFlag" type="checkbox">**Include in Grade Step Progression**<br />
            Indicates whether the assignment is eligible for grade-step progression. Valid values are true or false.</ResponseField>
            <ResponseField name="DepartmentId" type="number">**Department ID**<br />
            Unique identifier for the worker's department.</ResponseField>
            <ResponseField name="DepartmentName" type="single_select">**Department**<br />
            Name of the department for the worker assignment. Valid values are defined in the departmentsLov.</ResponseField>
            <ResponseField name="ReportingEstablishmentId" type="number">**Reporting Establishment ID**<br />
            Unique identifier for the reporting establishment.</ResponseField>
            <ResponseField name="ReportingEstablishmentName" type="single_select">**Reporting Establishment**<br />
            Name of the reporting establishment. Valid values are defined in the reportingEstablishmentsLOV.</ResponseField>
            <ResponseField name="LocationId" type="number">**Location ID**<br />
            Unique identifier for the worker's location.</ResponseField>
            <ResponseField name="LocationCode" type="single_select">**Location Code**<br />
            Code for the worker's location.</ResponseField>
            <ResponseField name="WorkAtHomeFlag" type="checkbox">**Working at Home**<br />
            Indicates whether the worker works at home for the assignment.</ResponseField>
            <ResponseField name="AssignmentCategory" type="single_select">**Assignment Category**<br />
            User-defined category for the assignment such as full-time, permanent, and so on. Valid values are defined in the commonLookupsLOV.</ResponseField>
            <ResponseField name="WorkerCategory" type="single_select">**Worker Category**<br />
            Category of the worker such as blue collar, civil servant, and so on. Valid values are defined in the commonLookupsLOV.</ResponseField>
            <ResponseField name="PermanentTemporary" type="single_select">**Regular or Temporary**<br />
            Indicates whether the worker is regular or temporary. Valid values are defined in the commonLookupsLOV.</ResponseField>
            <ResponseField name="FullPartTime" type="single_select">**Full Time or Part Time**<br />
            Indicates whether the worker works full-time or part-time. Valid values are defined in the commonLookupsLOV.</ResponseField>
            <ResponseField name="ManagerFlag" type="checkbox">**Working as a Manager**<br />
            Indicates whether the worker is a manager.</ResponseField>
            <ResponseField name="HourlySalariedCode" type="single_select">**Hourly Paid or Salaried**<br />
            Identifies whether the assignment is paid by the hour or by a salary. Either maintained at the assignment level or employment or placement terms but not both. Valid values are defined in the commonLookupsLOV.</ResponseField>
            <ResponseField name="NormalHours" type="number">**Working Hours**<br />
            Normal working hours, such as 37.5. Specify with the Frequency attribute.</ResponseField>
            <ResponseField name="Frequency" type="single_select">Frequency of normal working hours such as week or month. Specify with the NormalHours attribute. Valid values are defined in the commonLookupsLOV.</ResponseField>
            <ResponseField name="StartTime" type="text">**Start Time**<br />
            Normal start time for the working day.</ResponseField>
            <ResponseField name="EndTime" type="text">**End Time**<br />
            Normal end time for the working day.</ResponseField>
            <ResponseField name="SeniorityBasis" type="single_select">**Basis for Seniority Calculation**<br />
            Basis for calculating seniority for the person. Valid values are defined in the commonLookupsLOV.</ResponseField>
            <ResponseField name="ProbationPeriod" type="number">**Probation Period**<br />
            Duration of the probation period. Specify with the ProbationPeriodUnit attribute.</ResponseField>
            <ResponseField name="ProbationPeriodUnit" type="single_select">**Probation Unit**<br />
            Unit of measure for the probation period. Specify with the ProbationPeriod attribute. Valid values are defined in the commonLookupsLOV.</ResponseField>
            <ResponseField name="ProbationEndDate" type="date">**Probation End Date**<br />
            End date of the probation period.</ResponseField>
            <ResponseField name="NoticePeriod" type="number">**Notice Period**<br />
            Notice period for the assignment. Specify with the NoticePeriodUOM attribute.</ResponseField>
            <ResponseField name="NoticePeriodUOM" type="text">**Notice Period Units**<br />
            Unit of measure for the notice period. Specify with the NoticePeriod attribute. Valid values are defined in the commonLookupsLOV.</ResponseField>
            <ResponseField name="WorkTaxAddressId" type="number">**Work Tax Address ID**<br />
            Unique identifier for the address used for taxation purposes. This can be different from the mailing address.</ResponseField>
            <ResponseField name="ExpenseCheckSendToAddress" type="single_select">**Expense Check Send-to Address**<br />
            Determines whether expense checks are sent to the home or office address.</ResponseField>
            <ResponseField name="RetirementAge" type="number">**Retirement Age**<br />
            Age at which the worker is retiring.</ResponseField>
            <ResponseField name="RetirementDate" type="date">**Retirement Date**<br />
            Planned retirement date of the worker.</ResponseField>
            <ResponseField name="LabourUnionMemberFlag" type="checkbox">**Union Member**<br />
            Indicates whether the worker is a labor union member.</ResponseField>
            <ResponseField name="UnionId" type="number">**Union ID**<br />
            Unique identifier of the worker union for the assignment.</ResponseField>
            <ResponseField name="UnionName" type="single_select">**Union**<br />
            Name of the worker union for the assignment. Valid values are defined in the unionsLov.</ResponseField>
            <ResponseField name="BargainingUnitCode" type="single_select">**Bargaining Unit**<br />
            Code for the bargaining unit.</ResponseField>
            <ResponseField name="CollectiveAgreementId" type="number">**Collective Agreement ID**<br />
            Surrogate identifier for the collective agreement.</ResponseField>
            <ResponseField name="CollectiveAgreementName" type="single_select">**Collective Agreement**<br />
            Name for the collective agreement. Valid values are defined in the collectiveAgreementsLov.</ResponseField>
            <ResponseField name="ContractId" type="number">**Contract ID**<br />
            Surrogate identifier for the contract.</ResponseField>
            <ResponseField name="ContractNumber" type="single_select">**Contract Number**<br />
            Number of the contract.</ResponseField>
            <ResponseField name="InternalBuilding" type="text">**Building**<br />
            Building information associated with the work location.</ResponseField>
            <ResponseField name="InternalFloor" type="text">**Floor**<br />
            Floor information associated with the work location.</ResponseField>
            <ResponseField name="InternalOfficeNumber" type="text">**Office Number**<br />
            Office number associated with the work location.</ResponseField>
            <ResponseField name="InternalMailstop" type="text">**Mail Stop**<br />
            Internal mail location.</ResponseField>
            <ResponseField name="DefaultExpenseAccount" type="text">**Default Expense Account**<br />
            Default expense account of the assignment. If the expense account is configured with multiple segments, then provide the concatenated value. Separate the values using the separator configured for the expense account.</ResponseField>
            <ResponseField name="PeopleGroup" type="text">**People Group**<br />
            People Group Key flexfield for the assignment. If people group is configured with multiple segments, provide the concatenated value, separating the values with the separator configured for the People Group Key flexfield.</ResponseField>
            <ResponseField name="StandardWorkingHours" type="number">**Standard Working Hours**<br />
            Standard working hours such as 40.</ResponseField>
            <ResponseField name="StandardFrequency" type="text">**Standard Frequency**<br />
            Frequency of standard working hours such as week or month.</ResponseField>
            <ResponseField name="AdjustedFTE" type="number">**Adjusted FTE**<br />
            Adjusted Full Time Equivalent for the worker assignment.</ResponseField>
            <ResponseField name="AnnualWorkingDuration" type="number">**Annual Working Duration**<br />
            Annual working duration for the worker assignment.</ResponseField>
            <ResponseField name="AnnualWorkingDurationUnits" type="text">**Annual Working Duration Units**<br />
            Description of the annual working duration units.</ResponseField>
            <ResponseField name="AnnualWorkingRatio" type="number">**Annual Working Ratio**<br />
            Annual working ratio for the worker assignment.</ResponseField>
            <ResponseField name="AssignmentStandardFrequency" type="text">**Assignment Standard Working Hours Units**<br />
            Standard frequency for the worker assignment.</ResponseField>
            <ResponseField name="AssignmentStandardWorkingHours" type="number">**Assignment Standard Working Hours**<br />
            Standard working hours for the worker assignment.</ResponseField>
            <ResponseField name="StandardAnnualWorkingDuration" type="number">**Standard Annual Working Duration**<br />
            Standard annual working duration for the worker assignment.</ResponseField>

            <ResponseField name="assignmentsDDF" type="object">
              **assignments D D F**

              <Expandable title="properties">
                <ResponseField name="AssignmentType" type="text">**Assignment Type**</ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="assignmentsDFF" type="object">
              **assignments D F F**

              <Expandable title="properties">
                <ResponseField name="AssignmentType" type="text">**Assignment Type**</ResponseField>
                <ResponseField name="workspaceCategory" type="text">**Workspace Category**</ResponseField>
                <ResponseField name="originalStartDate" type="date">**Original\_Start\_Date**</ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="assignmentsEFF" type="object">
              **assignments E F F**

              <Expandable title="properties">
                <ResponseField name="AssignmentType" type="text">**Assignment Type**</ResponseField>
                <ResponseField name="CategoryCode" type="text">**EFF Context**</ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="gradeSteps" type="object">
              **Grade Steps**<br />
              The gradeSteps resource is a child of the assignments resource. It provides all the assignment grade steps of a worker as of the specified date. By default, the current date is retained.

              <Expandable title="properties">
                <ResponseField name="GradeStepId" type="number">**Grade Step ID**<br />
                Surrogate identifier for the grade step.</ResponseField>
                <ResponseField name="GradeStepName" type="single_select">**Name**<br />
                Name of the grade step. Valid values are defined in the gradeStepNamesLOV.</ResponseField>
                <ResponseField name="ActionCode" type="single_select">**Action Code**<br />
                Action being performed for the assignment such as Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV.</ResponseField>
                <ResponseField name="ReasonCode" type="single_select">**Reason Code**<br />
                Reason for the change.Valid values are defined in the actionReasonsLOV.</ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="managers" type="object">
              **Managers**<br />
              The managers resource is a child of the assignments resource. It provides all the assignment managers of a worker as of the specified date. By default, the current date is retained.

              <Expandable title="properties">
                <ResponseField name="ManagerAssignmentId" type="number">**Assignment ID**<br />
                Surrogate identifier for the assignment supervisor.</ResponseField>
                <ResponseField name="ManagerAssignmentNumber" type="single_select">**Assignment Number**<br />
                Assignment number of the supervisor.<br />
                References `/v1/hris/employees?remote_model=employee`</ResponseField>
                <ResponseField name="ManagerType" type="single_select">**Type**<br />
                Role the supervisor has with regards to the overall organization structure such as functional, project leader, and so on. Valid values are defined in the commonLookupsLOV.</ResponseField>
                <ResponseField name="ActionCode" type="single_select">**Action Code**<br />
                Action being performed on the assignment such as Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV.</ResponseField>
                <ResponseField name="ReasonCode" type="single_select">**Reason Code**<br />
                Reason for the change. Valid values are defined in the actionReasonsLOV.</ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="workMeasures" type="object">
              **Work Measures**<br />
              The workMeasures resource is a child of the assignments resource. It provides all the assignment work measures of a worker as of the specified date. By default, the current date is retained.

              <Expandable title="properties">
                <ResponseField name="Value" type="number">Value of the work measure.</ResponseField>
                <ResponseField name="Unit" type="single_select">Unit of measure. Valid values are defined in the commonLookupsLOV.</ResponseField>
                <ResponseField name="ActionCode" type="single_select">**Action Code**<br />
                Action being performed on the assignment such as Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV.</ResponseField>
                <ResponseField name="ReasonCode" type="single_select">**Reason Code**<br />
                Reason for the change.Valid values are defined in the actionReasonsLOV.</ResponseField>
                <ResponseField name="CalculateWorkmeasureFlag" type="checkbox">**Calculate FTE and Headcount Automatically**<br />
                Indicates whether the full time equivalency (FTE) should be calculated automatically.</ResponseField>
              </Expandable>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="contracts" type="object">
          **Contracts**<br />
          The contracts resource is a child of the workRelationships resource and you can create or edit a contract only with an assignment. The resource provides all the contracts of a worker as of the specified date. By default, the current date is retained.

          <Expandable title="properties">
            <ResponseField name="ContractNumber" type="text">**Contract Number**<br />
            Number of the contract.</ResponseField>
            <ResponseField name="ContractEndDate" type="date">**Contract End Date**<br />
            Date when the contract ends.</ResponseField>
            <ResponseField name="ContractType" type="single_select">**Contract Type**<br />
            Type of the contract.</ResponseField>
            <ResponseField name="Description" type="text">Description of the contract.</ResponseField>
            <ResponseField name="InitialDuration" type="number">**Initial Duration**<br />
            Initial duration of the contract.</ResponseField>
            <ResponseField name="InitialDurationUnits" type="single_select">**Initial Duration Units**<br />
            Unit for the initial duration of the contract.</ResponseField>
            <ResponseField name="ExtensionPeriod" type="number">**Extension Period**<br />
            Extension period of the contract.</ResponseField>
            <ResponseField name="ExtensionPeriodUnits" type="single_select">**Extension Period Units**<br />
            Unit for the extension period of the contract.</ResponseField>
            <ResponseField name="ActionCode" type="text">**Action Code**<br />
            Action code for the employment contract.</ResponseField>
            <ResponseField name="ContractExtensionFlag" type="checkbox">**Contract Extension Flag**<br />
            Indicates whether the contract should be extended. Valid values are Yes and No. The default value is null.</ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="workersDFF" type="object">
      **workers D F F**

      <Expandable title="properties">
        <ResponseField name="employeeRewardsPoints" type="number">**Employee Rewards Points**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="workersEFF" type="object">
      **workers E F F**

      <Expandable title="properties">
        <ResponseField name="CategoryCode" type="text">**Category Code**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="startDate" type="date">**Start Date**<br />
    The start date of the employee</ResponseField>
  </Tab>
</Tabs>


# OysterHR HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/oysterhr

OysterHR connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The OysterHR HRIS integration allows you to sync HRIS data between OysterHR and your application through Kombo's unified API. The tool slug for this connector is `oysterhr`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/27318180023697-Oyster-How-do-I-link-my-account">
    Step-by-step instructions to connect your OysterHR account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
    </Accordion>

    <Accordion title="Employees">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | nationality         |       |
      | display\_full\_name |       |
      | job\_title          |       |
      | work\_email         |       |
      | tax\_id             |       |
      | employment\_status  |       |
      | employment\_type    |       |
      | home\_address       |       |
      | date\_of\_birth     |       |
      | start\_date         |       |
      | termination\_date   |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | OAuth            |       |
    | Connection Guide |       |
    | Prerequisites    |       |
  </Tab>
</Tabs>


# Paychex HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/paychex

Paychex connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Paychex HRIS integration allows you to sync HRIS data between Paychex and your application through Kombo's unified API. The tool slug for this connector is `paychex`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/26672125837969-Paychex-How-do-I-link-my-account">
    Step-by-step instructions to connect your Paychex account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | gender                |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | parent\_id          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | API Passthrough    |       |
    | Scope Testing      |       |
    | Per Model Tests    |       |
    | Connection Guide   |       |
    | Create credentials |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Info>
      Some **optional** form fields are referencing the following data models:

      * Employees
      * Groups
      * Locations

      Consider enabling these in your [scope configuration](/hris/features/scopes).
    </Info>

    <ResponseField name="companyId" type="single_select">**Company**</ResponseField>
    <ResponseField name="employmentType" type="single_select">**Employment Type**</ResponseField>
    <ResponseField name="hireDate" type="date">**Start Date**<br />
    The date which the worker was hired.<br />
    Unified field: `start_date`</ResponseField>
    <ResponseField name="birthDate" type="date">**Date of Birth**<br />
    The employee's date of birth<br />
    Unified field: `date_of_birth`</ResponseField>
    <ResponseField name="exemptionType" type="single_select">**Exemption Type**</ResponseField>
    <ResponseField name="workerType" type="single_select">**Worker Type**</ResponseField>
    <ResponseField name="sex" type="single_select">**Gender**<br />
    The gender of the employee<br />
    Unified field: `gender`</ResponseField>
    <ResponseField name="employeeId" type="text">**Employee ID**</ResponseField>
    <ResponseField name="ethnicityCode" type="single_select">**Ethnicity**</ResponseField>

    <ResponseField name="name" type="object">
      **Name**

      <Expandable title="properties">
        <ResponseField name="givenName" type="text">**First Name**<br />
        The first name of the employee<br />
        Unified field: `first_name`</ResponseField>
        <ResponseField name="familyName" type="text">**Last Name**<br />
        The last name of the employee<br />
        Unified field: `last_name`</ResponseField>
        <ResponseField name="middleName" type="text">**Middle Name**</ResponseField>
        <ResponseField name="preferredName" type="text">**Preferred Name**</ResponseField>
        <ResponseField name="qualificationAffixCode" type="text">**Qualification Affix (e.g., Sr., Jr.)**</ResponseField>
        <ResponseField name="titleAffixCode" type="text">**Title Affix (e.g., Dr., Mr.)**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="legalId" type="object">
      **Legal ID**

      <Expandable title="properties">
        <ResponseField name="legalIdType" type="single_select">**Legal ID Type**</ResponseField>
        <ResponseField name="legalIdValue" type="text">**Legal ID Value**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="job" type="object">
      **Job Details**

      <Expandable title="properties">
        <ResponseField name="jobTitleId" type="single_select">**Job Title ID**</ResponseField>
        <ResponseField name="startDate" type="date">**Start Date**<br />
        Date when this job is available to be assigned to a worker.</ResponseField>
        <ResponseField name="endDate" type="date">**End Date**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="communications" type="object">
      **Communications**

      <Expandable title="properties">
        <ResponseField name="privateEmail" type="text">**Private Email**<br />
        The private email address of the employee<br />
        Unified field: `private_email`</ResponseField>
        <ResponseField name="workEmail" type="text">**Work Email**<br />
        The email address of the employee<br />
        Unified field: `work_email`</ResponseField>

        <ResponseField name="streetAddress" type="object">
          **Street Address**

          <Expandable title="properties">
            <ResponseField name="usageType" type="single_select">**Usage Type**</ResponseField>
            <ResponseField name="streetLineOne" type="text">**Street 1**<br />
            The street address of the employee<br />
            Unified field: `home_address.street_1`</ResponseField>
            <ResponseField name="streetLineTwo" type="text">**Street 2**<br />
            The street address of the employee<br />
            Unified field: `home_address.street_2`</ResponseField>
            <ResponseField name="city" type="text">**City**<br />
            The city of the employee<br />
            Unified field: `home_address.city`</ResponseField>
            <ResponseField name="postalCode" type="text">**ZIP Code**<br />
            The ZIP code of the employee<br />
            Unified field: `home_address.zip_code`</ResponseField>
            <ResponseField name="postalCodeExtension" type="text">**Postal Code Extension (for address type)**</ResponseField>
            <ResponseField name="countrySubdivisionCode" type="text">**State**<br />
            The state of the employee<br />
            Unified field: `home_address.state`</ResponseField>
            <ResponseField name="countryCode" type="single_select">**Country**<br />
            The uppercase two-letter ISO country code (e.g., DE).<br />
            Unified field: `home_address.country`</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="mobilePhone" type="object">
          **Mobile Phone**

          <Expandable title="properties">
            <ResponseField name="usageType" type="single_select">**Usage Type**</ResponseField>
            <ResponseField name="dialCountry" type="text">**Dial Country**<br />
            The country dialing code for a communication number.</ResponseField>
            <ResponseField name="dialArea" type="text">**Dial Area**<br />
            The area code for a communication number.</ResponseField>
            <ResponseField name="dialNumber" type="text">**Dial Number**<br />
            The communication number, not including country dialing or area dialing codes.</ResponseField>
            <ResponseField name="dialExtension" type="text">**Dial Extension**<br />
            The extension of the associated communication number.</ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="clockId" type="text">**Clock ID**<br />
    The clock ID of the worker that can be an identification for other systems.</ResponseField>
    <ResponseField name="laborAssignmentId" type="text">**Labor Assignment ID**</ResponseField>

    <ResponseField name="location" type="object">
      **Location**

      <Expandable title="properties">
        <ResponseField name="locationId" type="single_select">**Location**<br />
        References `/v1/hris/locations?remote_model=location`</ResponseField>
        <ResponseField name="organization" type="single_select">**Organization**<br />
        References `/v1/hris/groups`</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="supervisor" type="single_select">**Supervisor**<br />
    References `/v1/hris/employees?remote_model=employee`</ResponseField>

    <ResponseField name="currentStatus" type="object">
      **Current Status**

      <Expandable title="properties">
        <ResponseField name="statusType" type="single_select">**Status Type**</ResponseField>
        <ResponseField name="statusReason" type="text">**Status Reason**</ResponseField>
      </Expandable>
    </ResponseField>
  </Tab>
</Tabs>


# Paycom HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/paycom

Paycom connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Paycom HRIS integration allows you to sync HRIS data between Paycom and your application through Kombo's unified API. The tool slug for this connector is `paycom`.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | gender                |       |
      | ethnicity             |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Employments">
      <Note>
        Paycom only provides the current employment. Multiple records (e.g. historical employments) are not available via API.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
    </Accordion>

    <Accordion title="Timesheets">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | started\_at         |       |
      | ended\_at           |       |
      | timezone            |       |
      | comment             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | API Passthrough       |       |
    | Scope Testing         |       |
    | Per Model Tests       |       |
    | Delta Syncs           |       |
    | Custom Field Explorer |       |
    | Employees             |       |
    | Group Types           |       |
    | DEPARTMENT            |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Info>
      Some **optional** form fields are referencing the following data models:

      * Locations

      Consider enabling these in your [scope configuration](/hris/features/scopes).
    </Info>

    <ResponseField name="first_name" type="text">**First Name**<br />
    The first name of the employee<br />
    Unified field: `first_name`</ResponseField>
    <ResponseField name="last_name" type="text">**Last Name**<br />
    The last name of the employee<br />
    Unified field: `last_name`</ResponseField>
    <ResponseField name="suffix" type="text">**Suffix**</ResponseField>
    <ResponseField name="middle_name" type="text">**Middle Name**</ResponseField>
    <ResponseField name="preferred_first_name" type="text">**Preferred First Name**</ResponseField>
    <ResponseField name="preferred_last_name" type="text">**Preferred Last Name**</ResponseField>
    <ResponseField name="personal_email" type="text">**Private Email**<br />
    The private email address of the employee<br />
    Unified field: `private_email`</ResponseField>
    <ResponseField name="primary_phone" type="text">**Primary Phone Number**<br />
    The primary phone number including country code, e.g. "+1-415-555-0132"<br />
    Unified field: `mobile_phone_number`</ResponseField>
    <ResponseField name="country_code" type="single_select">**Country Paid In**</ResponseField>
    <ResponseField name="payroll_profile" type="single_select">**Default Payroll Profile**</ResponseField>
    <ResponseField name="employee_type" type="single_select">**Employee Type**</ResponseField>
    <ResponseField name="template_id" type="single_select">**New Hire Template**</ResponseField>
    <ResponseField name="location_id" type="single_select">**Location**<br />
    The Kombo ID of the location the employee should be in<br />
    Unified field: `location_id`<br />
    References `/v1/hris/locations?remote_model=location`</ResponseField>
    <ResponseField name="use_employee_address" type="checkbox">**Use Employee Address**<br />
    Use Employee Address for Work and SUI taxes</ResponseField>
    <ResponseField name="send_invite" type="checkbox">**Send Welcome Invite**</ResponseField>
    <ResponseField name="employee_code" type="text">**New Employee Code**</ResponseField>
    <ResponseField name="ssn" type="text">**SSN**<br />
    Social Security Number</ResponseField>
    <ResponseField name="hire_date" type="date">**Start Date**<br />
    The hire date<br />
    Unified field: `start_date`</ResponseField>
    <ResponseField name="full_or_part_time" type="single_select">**DOL Status**<br />
    Full or Part Time</ResponseField>
    <ResponseField name="pay_type" type="single_select">**Pay Type**</ResponseField>
    <ResponseField name="exempt_status" type="single_select">**Exempt Status**</ResponseField>
    <ResponseField name="salary" type="number">**Salary**</ResponseField>
    <ResponseField name="salary_type" type="single_select">**Salary Period**</ResponseField>
    <ResponseField name="department_code" type="text">**Home Department**</ResponseField>
    <ResponseField name="position_seat" type="single_select">**Position Seat**</ResponseField>
  </Tab>
</Tabs>


# Paycor HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/paycor

Paycor connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Paycor HRIS integration allows you to sync HRIS data between Paycor and your application through Kombo's unified API. The tool slug for this connector is `paycor`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/39182278339089-Paycor-HRIS-How-do-I-link-my-account">
    Step-by-step instructions to connect your Paycor account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      <Note>
        We only expose the "physical" address of a work location from Paycor.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | tax\_id               |       |
      | gender                |       |
      | ethnicity             |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Absences">
      <Note>
        Each day will be an individual absence, because an absence request in Paycor can skip days in the middle of the requested range. We can only sync absences 1 year into the past for Paycor
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | approver\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_time         |       |
      | end\_time           |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes                                   |
      | ------------------- | --------------------------------------- |
      | id                  |                                         |
      | remote\_id          |                                         |
      | changed\_at         |                                         |
      | remote\_deleted\_at |                                         |
      | employee\_id        |                                         |
      | job\_title          | Historical job titles are not supported |
      | pay\_rate           |                                         |
      | pay\_period         |                                         |
      | pay\_currency       |                                         |
      | effective\_date     |                                         |
      | remote\_data        |                                         |
      | custom\_fields      |                                         |
      | integration\_fields |                                         |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | parent\_id          |       |
      | remote\_data        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create absence">
      <Note>
        Our "start\_half\_day", "end\_half\_day", "start\_time" and "end\_time" parameters are only available for single day absence requests in Paycor The amount parameter will be split evenly when the absence request spans mutilple days in Paycor Paycor's API only allows specifying the absence's length in hours. Creating absences with the Kombo 'unit' parameter as `days` will create an an absence with 8h per day. The endpoint will only return absence data for the first day when the absence request spans mutilple days in Paycor.
      </Note>

      | Input Field       | Notes |
      | ----------------- | ----- |
      | employee\_id      |       |
      | absence\_type\_id |       |
      | status            |       |
      | start\_date       |       |
      | end\_date         |       |
      | start\_half\_day  |       |
      | end\_half\_day    |       |
      | amount            |       |
      | unit              |       |
      | employee\_note    |       |
      | start\_time       |       |
      | end\_time         |       |
    </Accordion>

    <Accordion title="Create employee">
      <Note>
        This endpoint will take at least 60s for Paycor due to their API restrictions. It is recommend to increase your timeout accordingly. An Paycor employee will always have the country US and currency USD assigned. legal\_entity\_id, start\_date, home\_address.street\_1, home\_address.zip\_code, remote\_fields.paycor.departmentRemoteId and remote\_fields.paycor.paygroupRemoteId are additional required fields to create an employee in Paycor.
      </Note>

      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | gender                  |       |
      | home\_address.street\_1 |       |
      | home\_address.street\_2 |       |
      | home\_address.city      |       |
      | home\_address.state     |       |
      | home\_address.zip\_code |       |
      | home\_address.country   |       |
      | date\_of\_birth         |       |
      | nationality             |       |
      | start\_date             |       |
      | legal\_entity\_id       |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | OAuth                 |       |
    | API Passthrough       |       |
    | Additional Scopes     |       |
    | Scope Testing         |       |
    | Per Model Tests       |       |
    | Per Field Tests       |       |
    | Custom Field Explorer |       |
    | Employees             |       |
    | Connection Guide      |       |
    | Group Types           |       |
    | DEPARTMENT            |       |
    | COST\_CENTER          |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Info>
      Some **required** form fields are referencing the following data models:

      * Legal Entities

      Additionally, there are some **optional** form fields that reference:

      * Groups
      * Locations

      Consider enabling these in your [scope configuration](/hris/features/scopes).
    </Info>

    <ResponseField name="legalEntityId" type="single_select">**Legal Entity**<br />
    Employee's Legal Entity ID.<br />
    References `/v1/hris/legal-entities?remote_model=legal_entity`</ResponseField>
    <ResponseField name="exportedByEmailAddress" type="text">**Exported By Email Address**<br />
    The email address of the user who exported the employee.</ResponseField>
    <ResponseField name="firstName" type="text">**First Name**<br />
    The first name of the employee<br />
    Unified field: `first_name`</ResponseField>
    <ResponseField name="lastName" type="text">**Last Name**<br />
    The last name of the employee<br />
    Unified field: `last_name`</ResponseField>
    <ResponseField name="preferredName" type="text">**Preferred Name**<br />
    Preferred name of the Person.</ResponseField>
    <ResponseField name="countryCode" type="text">**Country**<br />
    The uppercase two-letter ISO country (e.g., DE)<br />
    Unified field: `home_address.country`</ResponseField>
    <ResponseField name="zip" type="text">**ZIP Code**<br />
    The ZIP code of the employee<br />
    Unified field: `home_address.zip_code`</ResponseField>
    <ResponseField name="state" type="text">**State**<br />
    The state of the employee<br />
    Unified field: `home_address.state`</ResponseField>
    <ResponseField name="city" type="text">**City**<br />
    The city of the employee<br />
    Unified field: `home_address.city`</ResponseField>
    <ResponseField name="address1" type="text">**Street 1**<br />
    The street address of the employee<br />
    Unified field: `home_address.street_1`</ResponseField>
    <ResponseField name="address2" type="text">**Street 2**<br />
    The street address of the employee<br />
    Unified field: `home_address.street_2`</ResponseField>
    <ResponseField name="mobilePhone" type="text">**Mobile Phone Number**<br />
    The mobile phone number of the employee<br />
    Unified field: `mobile_phone_number`</ResponseField>
    <ResponseField name="homePhone" type="text">**Home Phone**<br />
    Home phone number of the employee.</ResponseField>
    <ResponseField name="homeEmailAddress" type="text">**Private Email**<br />
    The private email address of the employee<br />
    Unified field: `private_email`</ResponseField>
    <ResponseField name="gender" type="single_select">**Gender**</ResponseField>
    <ResponseField name="ethnicity" type="single_select">**Ethnicity**</ResponseField>
    <ResponseField name="veteranStatus" type="single_select">**Veteran Status**</ResponseField>
    <ResponseField name="startDate" type="date">**Start Date**<br />
    Date the employement start.<br />
    Unified field: `start_date`</ResponseField>
    <ResponseField name="departmentCode" type="single_select">**Department Code**<br />
    The department code that the employee belongs to.<br />
    References `/v1/hris/groups?types=DEPARTMENT`</ResponseField>
    <ResponseField name="disability" type="single_select">**Disability Status**</ResponseField>
    <ResponseField name="workLocation" type="single_select">**Work Location**<br />
    The name of the Work Location to associate with new hire.<br />
    References `/v1/hris/locations?remote_model=location`</ResponseField>
    <ResponseField name="onboardingGroupName" type="text">**Onboarding Group Name**<br />
    This is the name of Onboarding group that is created at client level (this must be acquired via the UI of Paycor at this time). If OnboardingType is “Invite”, then this field is required or else the Onboarding Employee will be set to awaiting invite, if not passed, then the Onboarding Employee will be set to "AwaitingInvite" and need to be updated via the UI prior to the invite being sent.</ResponseField>
    <ResponseField name="inviteType" type="single_select">**Invite Type**</ResponseField>
    <ResponseField name="workerType" type="single_select">**Worker Type**</ResponseField>
    <ResponseField name="isFullTime" type="checkbox">**Is Full Time**<br />
    Determines if an employee is Full Time or Part Time</ResponseField>
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Paycor

For **Paycor**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Paycor ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/paycor/icon.svg" href="/ats/connectors/paycor">
    Paycor for the ATS category
  </Card>
</CardGroup>


# PayFit Legacy HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/payfit

PayFit connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The PayFit HRIS integration allows you to sync HRIS data between PayFit and your application through Kombo's unified API. The tool slug for this connector is `payfit`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/20233940964241">
    Step-by-step instructions to connect your PayFit account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | name                  |       |
      | unit                  |       |
      | half\_days\_supported |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_half\_day    |       |
      | end\_half\_day      |       |
      | start\_time         |       |
      | end\_time           |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | parent\_id          |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | API Passthrough    |       |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
    | Group Types        |       |
    | TEAM               |       |
    | DEPARTMENT         |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Choose this variant if you want to use the unofficial PayFit API which has a high coverage

For **PayFit**, we also offer the following other connector variants:

<CardGroup>
  <Card title="PayFit Customer" icon="https://storage.googleapis.com/kombo-assets/integrations/payfitcustomer/icon.svg" href="/hris/connectors/payfitcustomer">
    Choose this variant if you want to use the official PayFit API but are not a partner
  </Card>

  <Card title="PayFit Partner" icon="https://storage.googleapis.com/kombo-assets/integrations/payfitpartner/icon.svg" href="/hris/connectors/payfitpartner">
    Choose this variant if you want to use the official PayFit API and you are a partner
  </Card>
</CardGroup>

<Note>You can only use one variant at a time.</Note>


# PayFit Customer HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/payfitcustomer

PayFit connector for Kombo's HRIS API

The PayFit HRIS integration allows you to sync HRIS data between PayFit and your application through Kombo's unified API. The tool slug for this connector is `payfitcustomer`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/24854023357585">
    Step-by-step instructions to connect your PayFit account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | employment\_type    |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | API Passthrough    |       |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
    | Group Types        |       |
    | TEAM               |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Choose this variant if you want to use the official PayFit API but are not a partner

For **PayFit**, we also offer the following other connector variants:

<CardGroup>
  <Card title="PayFit Partner" icon="https://storage.googleapis.com/kombo-assets/integrations/payfitpartner/icon.svg" href="/hris/connectors/payfitpartner">
    Choose this variant if you want to use the official PayFit API and you are a partner
  </Card>

  <Card title="PayFit Legacy" icon="https://storage.googleapis.com/kombo-assets/integrations/payfit/icon.svg" href="/hris/connectors/payfit">
    Choose this variant if you want to use the unofficial PayFit API which has a high coverage
  </Card>
</CardGroup>

<Note>You can only use one variant at a time.</Note>


# PayFit Partner HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/payfitpartner

PayFit connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The PayFit HRIS integration allows you to sync HRIS data between PayFit and your application through Kombo's unified API. The tool slug for this connector is `payfitpartner`.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | employment\_type    |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature         | Notes |
    | --------------- | ----- |
    | OAuth           |       |
    | API Passthrough |       |
    | Group Types     |       |
    | TEAM            |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Choose this variant if you want to use the official PayFit API and you are a partner

For **PayFit**, we also offer the following other connector variants:

<CardGroup>
  <Card title="PayFit Customer" icon="https://storage.googleapis.com/kombo-assets/integrations/payfitcustomer/icon.svg" href="/hris/connectors/payfitcustomer">
    Choose this variant if you want to use the official PayFit API but are not a partner
  </Card>

  <Card title="PayFit Legacy" icon="https://storage.googleapis.com/kombo-assets/integrations/payfit/icon.svg" href="/hris/connectors/payfit">
    Choose this variant if you want to use the unofficial PayFit API which has a high coverage
  </Card>
</CardGroup>

<Note>You can only use one variant at a time.</Note>


# Paylocity HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/paylocity

Paylocity connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Paylocity HRIS integration allows you to sync HRIS data between Paylocity and your application through Kombo's unified API. The tool slug for this connector is `paylocity`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/26665234201617-Paylocity-How-do-I-link-my-account">
    Step-by-step instructions to connect your Paylocity account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Work Locations">
      <Note>
        Work locations are currently derived from employee work addresses and are only available when Paylocity provides a location name.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | ethnicity             |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
    </Accordion>

    <Accordion title="Timesheets">
      | Field                  | Notes |
      | ---------------------- | ----- |
      | id                     |       |
      | remote\_id             |       |
      | changed\_at            |       |
      | remote\_deleted\_at    |       |
      | employee\_id           |       |
      | started\_at            |       |
      | ended\_at              |       |
      | timezone               |       |
      | payable\_hours         |       |
      | unpaid\_break\_minutes |       |
      | breaks                 |       |
      | custom\_fields         |       |
      | integration\_fields    |       |
      | remote\_data           |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee">
      <Note>
        Created Paylocity employees will enter the 'pre-hire' status and be deleted on the next sync. They will reappear after the onboarding process is completed. Valid phone format are: "(###) ###-####" or "###-###-####" or "### ### ####" or "##########" or, if international, starts with "+#", only spaces and digits allowed. Paylocity does not allow specifying the employee's country via API. It will always be set to "US".
      </Note>

      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | gender                  |       |
      | home\_address.street\_1 |       |
      | home\_address.street\_2 |       |
      | home\_address.city      |       |
      | home\_address.state     |       |
      | home\_address.zip\_code |       |
      | date\_of\_birth         |       |
      | mobile\_phone\_number   |       |
      | start\_date             |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | API Passthrough       |       |
    | Scope Testing         |       |
    | Per Model Tests       |       |
    | Per Field Tests       |       |
    | Custom Field Explorer |       |
    | Employees             |       |
    | Connection Guide      |       |
    | Create credentials    |       |
    | Group Types           |       |
    | COST\_CENTER          |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Info>
      Some **required** form fields are referencing the following data models:

      * Legal Entities

      Consider enabling these in your [scope configuration](/hris/features/scopes).
    </Info>

    <ResponseField name="companyId" type="single_select">**Legal Entity**<br />
    Select the legal entity to create the employee for.<br />
    References `/v1/hris/legal-entities?remote_model=legal_entity`</ResponseField>
    <ResponseField name="address1" type="text">**Address 1**<br />
    Employee home 1st address line.<br />
    Unified field: `home_address.street_1`</ResponseField>
    <ResponseField name="address2" type="text">**Address 2**<br />
    Employee home 2nd address line.<br />
    Unified field: `home_address.street_2`</ResponseField>
    <ResponseField name="autoPayType" type="single_select">**Auto Pay Type**<br />
    The type of auto pay for the employee.</ResponseField>
    <ResponseField name="baseRate" type="number">**Base Rate (hourly employees)**<br />
    Employee base rate, used for Hourly employees.</ResponseField>
    <ResponseField name="city" type="text">**City**<br />
    Employee home city.<br />
    Unified field: `home_address.city`</ResponseField>
    <ResponseField name="costCenter1" type="single_select">**Cost Center 1**<br />
    Employer defined location, like branch, division, department, etc.</ResponseField>
    <ResponseField name="costCenter2" type="single_select">**Cost Center 2**<br />
    Employer defined location, like branch, division, department, etc.</ResponseField>
    <ResponseField name="costCenter3" type="single_select">**Cost Center 3**<br />
    Employer defined location, like branch, division, department, etc.</ResponseField>
    <ResponseField name="defaultHours" type="number">**Default Hours**<br />
    Employee default hours consistently worked.</ResponseField>
    <ResponseField name="employeeStatus" type="single_select">**Employee Status**<br />
    Employee current work status.</ResponseField>
    <ResponseField name="employmentType" type="single_select">**Employment Type**<br />
    Employee employment type.</ResponseField>
    <ResponseField name="federalFilingStatus" type="single_select">**Federal Filing Status**<br />
    Employee federal filing status.</ResponseField>
    <ResponseField name="firstName" type="text">**First Name**<br />
    The first name of the employee<br />
    Unified field: `first_name`</ResponseField>
    <ResponseField name="sex" type="single_select">**Sex**<br />
    Employee gender.</ResponseField>
    <ResponseField name="hireDate" type="date">**Hire Date**<br />
    Employee hire date.<br />
    Unified field: `start_date`</ResponseField>
    <ResponseField name="homePhone" type="text">**Home Phone Number**<br />
    Employee home phone number.<br />
    Unified field: `home_phone_number`</ResponseField>
    <ResponseField name="lastName" type="text">**Last Name**<br />
    The last name of the employee<br />
    Unified field: `last_name`</ResponseField>
    <ResponseField name="maritalStatus" type="single_select">**Marital Status**<br />
    Employee marital status.</ResponseField>
    <ResponseField name="personalMobilePhone" type="text">**Mobile Phone Number**<br />
    Employee personal mobile phone number.<br />
    Unified field: `mobile_phone_number`</ResponseField>
    <ResponseField name="payFrequency" type="single_select">**Pay Frequency**<br />
    Employee pay frequency.</ResponseField>
    <ResponseField name="personalEmailAddress" type="text">**Private Email**<br />
    Employee personal email address.<br />
    Unified field: `private_email`</ResponseField>
    <ResponseField name="payType" type="single_select">**Pay Type**<br />
    Employee pay type.</ResponseField>
    <ResponseField name="ratePer" type="single_select">**Rate Per**<br />
    Employee base rate frequency (only used with payType Hourly).</ResponseField>
    <ResponseField name="salary" type="number">**Yearly Salary**<br />
    Employee yearly gross salary (only used with payType Salary).<br />
    Unified field: `yearly_salary`</ResponseField>
    <ResponseField name="state" type="single_select">**State**<br />
    Employee home state.<br />
    Unified field: `home_address.state`</ResponseField>
    <ResponseField name="ssn" type="text">**Social Security Number**<br />
    Employee social security number. Leave it blank if valid social security number not available.</ResponseField>
    <ResponseField name="stateFilingStatus" type="single_select">**State Filing Status**<br />
    Employee state filing status.</ResponseField>
    <ResponseField name="suiState" type="single_select">**SUI State**<br />
    Employee SUI (State Unemployment Insurance) state.</ResponseField>
    <ResponseField name="taxForm" type="single_select">**Tax Form**<br />
    Employee tax form for reporting income.</ResponseField>
    <ResponseField name="taxState" type="single_select">**Tax State**<br />
    Employee tax state.</ResponseField>
    <ResponseField name="userName" type="text">**User Name**<br />
    Employer assigned username to log into Onboarding. Duplicate usernames are not allowed. The username cannot have special characters other than . (period) and \_ (underscore)</ResponseField>
    <ResponseField name="workEmailAddress" type="text">**Work Email Address**<br />
    Employee work email address.<br />
    Unified field: `work_email`</ResponseField>
    <ResponseField name="zip" type="text">**Zip**<br />
    Employee home zip code.<br />
    Unified field: `home_address.zip_code`</ResponseField>
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Paylocity

For **Paylocity**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Paylocity ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/paylocity/icon.svg" href="/ats/connectors/paylocity">
    Paylocity for the ATS category
  </Card>
</CardGroup>


# MHR People First HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/peoplefirst

MHR People First connector for Kombo's HRIS API

The MHR People First HRIS integration allows you to sync HRIS data between MHR People First and your application through Kombo's unified API. The tool slug for this connector is `peoplefirst`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/37260775369105-MHR-People-First-How-do-I-link-my-account">
    Step-by-step instructions to connect your MHR People First account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | avatar                |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | parent\_id          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | API Passthrough  |       |
    | Scope Testing    |       |
    | Connection Guide |       |
    | Group Types      |       |
    | DEPARTMENT       |       |
  </Tab>
</Tabs>


# PeopleHR HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/peoplehr

PeopleHR connector for Kombo's HRIS API

The PeopleHR HRIS integration allows you to sync HRIS data between PeopleHR and your application through Kombo's unified API. The tool slug for this connector is `peoplehr`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/24094325858321-PeopleHR-How-do-I-link-my-account">
    Step-by-step instructions to connect your PeopleHR account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | avatar                |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | name                  |       |
      | half\_days\_supported |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | amount              |       |
      | unit                |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee">
      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | gender                  |       |
      | job\_title              |       |
      | home\_address.street\_1 |       |
      | home\_address.street\_2 |       |
      | home\_address.city      |       |
      | home\_address.state     |       |
      | home\_address.zip\_code |       |
      | home\_address.country   |       |
      | date\_of\_birth         |       |
      | mobile\_phone\_number   |       |
      | nationality             |       |
      | start\_date             |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | API Passthrough    |       |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
    | Group Types        |       |
    | DEPARTMENT         |       |
  </Tab>
</Tabs>


# PeopleXD HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/peoplexd

PeopleXD connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The PeopleXD HRIS integration allows you to sync HRIS data between PeopleXD and your application through Kombo's unified API. The tool slug for this connector is `peoplexd`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/40779981639185-PeopleXD-How-do-I-link-my-account">
    Step-by-step instructions to connect your PeopleXD account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | work\_email           |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | avatar                |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | parent\_id          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | API Passthrough       |       |
    | Scope Testing         |       |
    | Per Model Tests       |       |
    | Per Field Tests       |       |
    | Custom Field Explorer |       |
    | Employees             |       |
    | Connection Guide      |       |
  </Tab>
</Tabs>


# Visma Peple HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/peple

Visma Peple connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Visma Peple HRIS integration allows you to sync HRIS data between Visma Peple and your application through Kombo's unified API. The tool slug for this connector is `peple`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/27954300843409-Visma-Peple-How-do-I-link-my-account">
    Step-by-step instructions to connect your Visma Peple account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | gender                |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | weekly\_hours         |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | employment\_type    |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | parent\_id          |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | API Passthrough  |       |
    | Scope Testing    |       |
    | Connection Guide |       |
    | Prerequisites    |       |
    | Group Types      |       |
    | COST\_CENTER     |       |
  </Tab>
</Tabs>


# Perbility Helix HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/perbilityhelix

Perbility Helix connector for Kombo's HRIS API

<Note>This connector requires a partnership with Perbility Helix. Check out our [partnership guide](https://help.kombo.dev/hc/en-us/articles/43095758773521-Perbility-Helix-How-to-get-your-Partner-Credentials) to learn more.</Note>

The Perbility Helix HRIS integration allows you to sync HRIS data between Perbility Helix and your application through Kombo's unified API. The tool slug for this connector is `perbilityhelix`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/30236083131153-Perbility-Helix-How-do-I-link-my-account">
    Step-by-step instructions to connect your Perbility Helix account to Kombo.
  </Card>

  <Card title="Partnership Guide" icon="handshake" href="https://help.kombo.dev/hc/en-us/articles/43095758773521-Perbility-Helix-How-to-get-your-Partner-Credentials">
    Learn how to become a partner with Perbility Helix to enable this integration.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | job\_title            |       |
      | work\_email           |       |
      | mobile\_phone\_number |       |
      | gender                |       |
      | employment\_status    |       |
      | weekly\_hours         |       |
      | manager\_id           |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | name                    |       |
      | half\_days\_supported   |       |
      | exact\_times\_supported |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_half\_day    |       |
      | end\_half\_day      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | effective\_date     |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | parent\_id          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | Connection Guide |       |
    | Prerequisites    |       |
    | Group Types      |       |
    | DEPARTMENT       |       |
    | COST\_CENTER     |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Perbility Helix

For **Perbility Helix**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Perbility Helix ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/perbilityhelix/icon.svg" href="/ats/connectors/perbilityhelix">
    Perbility Helix for the ATS category
  </Card>
</CardGroup>


# Personio HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/personio

Personio connector for Kombo's HRIS API

The Personio HRIS integration allows you to sync HRIS data between Personio and your application through Kombo's unified API. The tool slug for this connector is `personio`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/16968947636369-How-do-I-link-my-Personio-HRIS-account-">
    Step-by-step instructions to connect your Personio account to Kombo.
  </Card>

  <Card title="Sandbox Environment" icon="flask" href="https://www.personio.com/free-trial/">
    Access the Personio sandbox environment for testing and development.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      <Note>
        The `employment_type` is inferred from the work schedules (e.g., 40h/week -> FULL\_TIME) since Personio's API does not expose information about the `employment_type` otherwise. Although we have not seen any issues with this in-practice, if a Personio instance is unusually configured this may lead to issues with the correct `employment_type` being returned.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_number    |       |
      | first\_name         |       |
      | last\_name          |       |
      | nationality         |       |
      | display\_full\_name |       |
      | job\_title          |       |
      | work\_email         |       |
      | personal\_email     |       |
      | ssn                 |       |
      | gender              |       |
      | marital\_status     |       |
      | employment\_status  |       |
      | employment\_type    |       |
      | weekly\_hours       |       |
      | avatar              |       |
      | work\_location\_id  |       |
      | legal\_entity\_id   |       |
      | manager\_id         |       |
      | home\_address       |       |
      | bank\_accounts      |       |
      | date\_of\_birth     |       |
      | start\_date         |       |
      | termination\_date   |       |
      | remote\_created\_at |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | name                    |       |
      | unit                    |       |
      | half\_days\_supported   |       |
      | exact\_times\_supported |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_half\_day    |       |
      | end\_half\_day      |       |
      | start\_time         |       |
      | end\_time           |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Groups">
      <Note>
        Personio does not support reading all groups via one endpoint.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | parent\_id          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Time Off Balances">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | type\_id            |       |
      | balance             |       |
      | balance\_unit       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Timesheets">
      | Field                  | Notes                                                                                       |
      | ---------------------- | ------------------------------------------------------------------------------------------- |
      | id                     |                                                                                             |
      | remote\_id             |                                                                                             |
      | changed\_at            |                                                                                             |
      | remote\_deleted\_at    |                                                                                             |
      | employee\_id           |                                                                                             |
      | started\_at            |                                                                                             |
      | ended\_at              |                                                                                             |
      | timezone               | We don't receive a timezone from Personio, so we assume a default timezone of Europe/Berlin |
      | unpaid\_break\_minutes |                                                                                             |
      | breaks                 |                                                                                             |
      | approval\_status       |                                                                                             |
      | comment                |                                                                                             |
      | custom\_fields         |                                                                                             |
      | integration\_fields    |                                                                                             |
      | remote\_data           |                                                                                             |
    </Accordion>

    <Accordion title="Employee Document Categories">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create absence">
      | Input Field       | Notes |
      | ----------------- | ----- |
      | employee\_id      |       |
      | absence\_type\_id |       |
      | status            |       |
      | start\_date       |       |
      | end\_date         |       |
      | start\_half\_day  |       |
      | end\_half\_day    |       |
      | employee\_note    |       |
      | start\_time       |       |
      | end\_time         |       |
    </Accordion>

    <Accordion title="Delete absence">
      | Input Field | Notes |
      | ----------- | ----- |
      | absence\_id |       |
    </Accordion>

    <Accordion title="Create employee">
      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | gender                  |       |
      | job\_title              |       |
      | home\_address.street\_1 |       |
      | home\_address.city      |       |
      | home\_address.zip\_code |       |
      | home\_address.country   |       |
      | date\_of\_birth         |       |
      | start\_date             |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>

    <Accordion title="Add document to employee">
      | Input Field            | Notes |
      | ---------------------- | ----- |
      | employee\_id           |       |
      | category\_id           |       |
      | document.name          |       |
      | document.content\_type |       |
      | document.data\_url     |       |
      | document.data          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | API Passthrough       |       |
    | Webhook Subscriptions |       |
    | Automatic Setup       |       |
    | Scope Testing         |       |
    | Per Model Tests       |       |
    | Per Field Tests       |       |
    | Delta Syncs           |       |
    | Custom Field Explorer |       |
    | Employees             |       |
    | Connection Guide      |       |
    | Prerequisites         |       |
    | Create credentials    |       |
    | Group Types           |       |
    | TEAM                  |       |
    | DEPARTMENT            |       |
    | COST\_CENTER          |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Info>
      Some **optional** form fields are referencing the following data models:

      * Employees
      * Groups
      * Locations

      Consider enabling these in your [scope configuration](/hris/features/scopes).
    </Info>

    <Warning>
      This form may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
    </Warning>

    <ResponseField name="email" type="text">**Private Email**<br />
    The private email address of the employee<br />
    Unified field: `private_email`</ResponseField>
    <ResponseField name="first_name" type="text">**First Name**<br />
    The first name of the employee<br />
    Unified field: `first_name`</ResponseField>
    <ResponseField name="last_name" type="text">**Last Name**<br />
    The last name of the employee<br />
    Unified field: `last_name`</ResponseField>
    <ResponseField name="preferred_name" type="text">**Name (preferred)**</ResponseField>
    <ResponseField name="gender" type="single_select">**Gender**<br />
    The gender of the employee<br />
    Unified field: `gender`</ResponseField>
    <ResponseField name="language_code" type="single_select">**Language**<br />
    Main language of the employee.</ResponseField>

    <ResponseField name="employments" type="object">
      **Employment**<br />
      Employment of the employee.

      <Expandable title="properties">
        <ResponseField name="supervisor" type="single_select">**Supervisor**<br />
        The supervisor of the employee.<br />
        References `/v1/hris/employees?remote_model=employee`</ResponseField>
        <ResponseField name="office" type="single_select">**Office**<br />
        The office of the employee.<br />
        Unified field: `location_id`<br />
        References `/v1/hris/locations?remote_model=location`</ResponseField>

        <ResponseField name="org_units" type="object">
          **Org Units**<br />
          All Org Units, i.e. department and team, that are to be associated with the Employment.

          <Expandable title="properties">
            <ResponseField name="department" type="single_select">**Department**<br />
            The department of the employee.<br />
            References `/v1/hris/groups?types=DEPARTMENT`</ResponseField>
            <ResponseField name="team" type="single_select">**Team**<br />
            The team of the employee.<br />
            References `/v1/hris/groups?types=TEAM`</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="legal_entity" type="single_select">**Legal Entity**<br />
        The legal entity of the employee.</ResponseField>
        <ResponseField name="position" type="text">**Position - Title**<br />
        The title of the position.</ResponseField>
        <ResponseField name="employment_start_date" type="date">**Start Date**<br />
        Start date of the employee. Also considered to be the hire date<br />
        Unified field: `start_date`</ResponseField>
        <ResponseField name="type" type="single_select">**Type**<br />
        The type of the employment.</ResponseField>
        <ResponseField name="contract_end_date" type="date">**Contract End Date**<br />
        The end date of the contract.</ResponseField>
        <ResponseField name="probation_period_length" type="number">**Probation Period Length**<br />
        The length of the probation period in months.</ResponseField>
        <ResponseField name="weekly_working_hours" type="number">**Weekly Working Hours**<br />
        The number of hours the employee works per week.</ResponseField>
        <ResponseField name="full_time_weekly_working_hours" type="number">**Full-Time Weekly Working Hours**<br />
        The number of hours per week that is considered full time for the employment.</ResponseField>

        <ResponseField name="cost_centers" type="array">
          **Cost Centers**<br />
          The weight distribution of this employment between different cost centers, using percentages.

          <Expandable title="items">
            <ResponseField name="id" type="single_select">**Cost Center Name**<br />
            References `/v1/hris/groups?types=COST_CENTER`</ResponseField>
            <ResponseField name="weight" type="number">**Weight**<br />
            The weight in percentage assigned to this Cost Center. The total of all Cost Center weights must be 100.</ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="custom_attributes" type="object">
      **Custom Attributes**

      <Expandable title="properties">
        <Warning>
          This object may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
        </Warning>
      </Expandable>
    </ResponseField>
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Personio

For **Personio**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Personio ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/personio/icon.svg" href="/ats/connectors/personio">
    Personio for the ATS category
  </Card>
</CardGroup>


# Planday HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/planday

Planday connector for Kombo's HRIS API

The Planday HRIS integration allows you to sync HRIS data between Planday and your application through Kombo's unified API. The tool slug for this connector is `planday`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/24093430496017-Planday-How-do-I-link-my-account">
    Step-by-step instructions to connect your Planday account to Kombo.
  </Card>

  <Card title="Sandbox Environment" icon="flask" href="https://www.planday.com/signup/">
    Access the Planday sandbox environment for testing and development.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | first\_name           |       |
      | last\_name            |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | employment\_type      |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee">
      <Note>
        Planday requires a department to be assigned when creating employees. Please provide it via the `department_remote_id` field of the `remote_fields`. The `work_email` field is required for creating employees in Planday.
      </Note>

      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | gender                  |       |
      | job\_title              |       |
      | home\_address.street\_1 |       |
      | home\_address.street\_2 |       |
      | home\_address.city      |       |
      | home\_address.zip\_code |       |
      | date\_of\_birth         |       |
      | mobile\_phone\_number   |       |
      | start\_date             |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | OAuth            |       |
    | API Passthrough  |       |
    | Connection Guide |       |
    | Prerequisites    |       |
    | Group Types      |       |
    | TEAM             |       |
    | DEPARTMENT       |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Info>
      Some **required** form fields are referencing the following data models:

      * Groups

      Additionally, there are some **optional** form fields that reference:

      * Groups

      Consider enabling these in your [scope configuration](/hris/features/scopes).
    </Info>

    <ResponseField name="firstName" type="text">**First Name**<br />
    The first name of the employee<br />
    Unified field: `first_name`</ResponseField>
    <ResponseField name="lastName" type="text">**Last Name**<br />
    The last name of the employee<br />
    Unified field: `last_name`</ResponseField>
    <ResponseField name="ssn" type="text">**Ssn**</ResponseField>
    <ResponseField name="zip" type="text">**Zip**<br />
    The ZIP code of the employee<br />
    Unified field: `home_address.zip_code`</ResponseField>
    <ResponseField name="city" type="text">**City**<br />
    The city of the employee<br />
    Unified field: `home_address.city`</ResponseField>
    <ResponseField name="email" type="text">**Email**</ResponseField>
    <ResponseField name="phone" type="text">**Phone**</ResponseField>
    <ResponseField name="phoneCountryCode" type="single_select">**Phone Country Code**</ResponseField>
    <ResponseField name="street1" type="text">**Street1**<br />
    The street address of the employee<br />
    Unified field: `home_address.street_1`</ResponseField>
    <ResponseField name="street2" type="text">**Street2**<br />
    The street address of the employee<br />
    Unified field: `home_address.street_2`</ResponseField>
    <ResponseField name="userName" type="text">**User Name**<br />
    The private email address of the employee<br />
    Unified field: `private_email`</ResponseField>
    <ResponseField name="departments" type="multi_select">**Departments**<br />
    List of Departments associated with the employee</ResponseField>
    <ResponseField name="employeeGroups" type="multi_select">**Employee Groups**</ResponseField>
    <ResponseField name="hiredFrom" type="date">**Hired From**</ResponseField>
    <ResponseField name="birthDate" type="date">**Birth Date**<br />
    The employee's date of birth<br />
    Unified field: `date_of_birth`</ResponseField>
    <ResponseField name="gender" type="single_select">**Gender**<br />
    The gender of the employee<br />
    Unified field: `gender`</ResponseField>
    <ResponseField name="cellPhone" type="text">**Cell Phone**<br />
    The mobile phone number of the employee<br />
    Unified field: `mobile_phone_number`</ResponseField>
    <ResponseField name="cellPhoneCountryCode" type="single_select">**Cell Phone Country Code**</ResponseField>
    <ResponseField name="salaryIdentifier" type="text">**Salary Identifier**</ResponseField>
    <ResponseField name="jobTitle" type="text">**Job Title**</ResponseField>
    <ResponseField name="employeeTypeId" type="single_select">**Employee Type Id**</ResponseField>
    <ResponseField name="primaryDepartmentId" type="single_select">**Primary Department Id**<br />
    Primary department for the employee<br />
    References `/v1/hris/groups?types=DEPARTMENT`</ResponseField>
    <ResponseField name="custom_33545" type="checkbox">**Use tax main card**</ResponseField>

    <ResponseField name="bankAccount" type="object">
      **Bank Account**

      <Expandable title="properties">
        <ResponseField name="accountNumber" type="text">**Account Number**</ResponseField>
        <ResponseField name="registrationNumber" type="text">**Registration Number**</ResponseField>
      </Expandable>
    </ResponseField>
  </Tab>
</Tabs>


# Remote HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/remotecom

Remote connector for Kombo's HRIS API

The Remote HRIS integration allows you to sync HRIS data between Remote and your application through Kombo's unified API. The tool slug for this connector is `remotecom`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/18378241739665">
    Step-by-step instructions to connect your Remote account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | nationality         |       |
      | display\_full\_name |       |
      | job\_title          |       |
      | work\_email         |       |
      | personal\_email     |       |
      | ssn                 |       |
      | tax\_id             |       |
      | gender              |       |
      | marital\_status     |       |
      | employment\_status  |       |
      | employment\_type    |       |
      | weekly\_hours       |       |
      | work\_location\_id  |       |
      | manager\_id         |       |
      | home\_address       |       |
      | bank\_accounts      |       |
      | date\_of\_birth     |       |
      | start\_date         |       |
      | termination\_date   |       |
      | remote\_created\_at |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | approver\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
    </Accordion>

    <Accordion title="Time Off Balances">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | type\_id            |       |
      | balance             |       |
      | balance\_unit       |       |
      | used                |       |
      | used\_unit          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | first\_name           |       |
      | last\_name            |       |
      | work\_email           |       |
      | gender                |       |
      | job\_title            |       |
      | home\_address.country |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | API Passthrough    |       |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
    | Group Types        |       |
    | DEPARTMENT         |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Note>
      Remote.com requires country-specific information for employee creation. The required fields may vary by country.
    </Note>

    <Note>
      The provisional start date must be at least 2 working days from today. The minimum onboarding time varies by country.
    </Note>

    <Note>
      Employees will be created in a "created" state and will need to complete onboarding through Remote.
    </Note>

    <Note>
      You can only create employees in countries where Remote.com offers Employer of Record (EOR) services.
    </Note>

    <Note>
      This form dynamically adapts based on the selected country. Some fields may become required or optional based on country-specific regulations.
    </Note>

    <ResponseField name="country_code" type="single_select">**Country**<br />
    The country where the employee will be hired. Remote.com requires country-specific information for employee creation.</ResponseField>
    <ResponseField name="type" type="single_select">**Type**<br />
    Specify if this is an employee or contractor. Defaults to employee.</ResponseField>
    <ResponseField name="first_name" type="text">**First Name**<br />
    The first name of the employee<br />
    Unified field: `first_name`</ResponseField>
    <ResponseField name="last_name" type="text">**Last Name**<br />
    The last name of the employee<br />
    Unified field: `last_name`</ResponseField>

    <ResponseField name="department" type="object">
      **Department**

      <Expandable title="properties">
        <ResponseField name="id" type="single_select">**Department**<br />
        (Optional) Select a department or create one.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="email" type="text">**Personal email**<br />
    This is how the employee will access their account.<br />
    Unified field: `private_email`</ResponseField>
    <ResponseField name="has_seniority_date" type="single_select">**Does the employee have a seniority date?**<br />
    If the employee started working for your company before being added to Remote, then select Yes.</ResponseField>
    <ResponseField name="job_title" type="text">**Job Title**<br />
    We can hire most roles but there are some we cannot support. This includes licensed roles, blue collar workers, and employees with certain C-level job titles.<br />
    Unified field: `job_title`</ResponseField>

    <ResponseField name="manager" type="object">
      **Manager**

      <Expandable title="properties">
        <ResponseField name="id" type="single_select">**Manager**<br />
        (Optional) The person who will manage this employee day-to-day on the Remote platform.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="provisional_start_date" type="date">**Provisional start date**<br />
    The minimum onboarding time for United states is 2 working days. We will confirm the start date once you invite the employee to do the self-enrollment.</ResponseField>
    <ResponseField name="seniority_date" type="date">**Seniority date**<br />
    Please indicate if different from contract start date</ResponseField>
    <ResponseField name="tax_job_category" type="single_select">**What is the main job category that the employee performs?**</ResponseField>
    <ResponseField name="tax_servicing_countries" type="multi_select">**What region(s) is the employee working for?**</ResponseField>
    <ResponseField name="work_email" type="text">**Work email**<br />
    The employee's company email. For example, [jane@company.com](mailto:jane@company.com).<br />
    Unified field: `work_email`</ResponseField>
  </Tab>
</Tabs>


# rexx systems HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/rexx

rexx systems connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The rexx systems HRIS integration allows you to sync HRIS data between rexx systems and your application through Kombo's unified API. The tool slug for this connector is `rexx`.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Employees">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_number    |       |
      | first\_name         |       |
      | last\_name          |       |
      | nationality         |       |
      | job\_title          |       |
      | work\_email         |       |
      | gender              |       |
      | manager\_id         |       |
      | home\_address       |       |
      | date\_of\_birth     |       |
      | start\_date         |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | API Passthrough       |       |
    | Custom Field Explorer |       |
    | Employees             |       |
    | Group Types           |       |
    | COST\_CENTER          |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** rexx systems

For **rexx systems**, we also offer the following other connector variants:

<CardGroup>
  <Card title="rexx systems ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/rexx/icon.svg" href="/ats/connectors/rexx">
    rexx systems for the ATS category
  </Card>
</CardGroup>


# Rippling HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/rippling

Rippling connector for Kombo's HRIS API

<Note>This connector requires a partnership with Rippling. Please contact us to get access.</Note>

The Rippling HRIS integration allows you to sync HRIS data between Rippling and your application through Kombo's unified API. The tool slug for this connector is `rippling`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/24946448912017">
    Step-by-step instructions to connect your Rippling account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes                                                                                                                                                                                             |
      | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
      | id                    |                                                                                                                                                                                                   |
      | remote\_id            |                                                                                                                                                                                                   |
      | changed\_at           |                                                                                                                                                                                                   |
      | remote\_deleted\_at   |                                                                                                                                                                                                   |
      | employee\_number      |                                                                                                                                                                                                   |
      | first\_name           |                                                                                                                                                                                                   |
      | last\_name            |                                                                                                                                                                                                   |
      | nationality           |                                                                                                                                                                                                   |
      | display\_full\_name   |                                                                                                                                                                                                   |
      | job\_title            |                                                                                                                                                                                                   |
      | work\_email           |                                                                                                                                                                                                   |
      | personal\_email       |                                                                                                                                                                                                   |
      | mobile\_phone\_number |                                                                                                                                                                                                   |
      | gender                |                                                                                                                                                                                                   |
      | ethnicity             |                                                                                                                                                                                                   |
      | employment\_status    |                                                                                                                                                                                                   |
      | employment\_type      |                                                                                                                                                                                                   |
      | avatar                |                                                                                                                                                                                                   |
      | work\_location\_id    | Rippling exposes a /work\_locations endpoint, but it may omit some locations. We therefore parse and upsert the work location directly from the employee payload to ensure referential integrity. |
      | legal\_entity\_id     |                                                                                                                                                                                                   |
      | manager\_id           |                                                                                                                                                                                                   |
      | home\_address         |                                                                                                                                                                                                   |
      | date\_of\_birth       |                                                                                                                                                                                                   |
      | start\_date           |                                                                                                                                                                                                   |
      | termination\_date     |                                                                                                                                                                                                   |
      | custom\_fields        |                                                                                                                                                                                                   |
      | integration\_fields   |                                                                                                                                                                                                   |
      | remote\_data          |                                                                                                                                                                                                   |
    </Accordion>

    <Accordion title="Absence Types">
      <Note>
        We can't map custom absence types because Rippling doesn't expose the IDs via API.
      </Note>

      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | name                  |       |
      | half\_days\_supported |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | approver\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_time         |       |
      | end\_time           |       |
      | amount              |       |
      | unit                |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Time Off Balances">
      <Note>
        We currently don't support unlimited balances for Rippling. Please reach out to Kombo support if you want to read unlimited balances.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | type\_id            |       |
      | balance             |       |
      | used                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee">
      <Note>
        Rippling requires a personal email address to create an employee. This personal email address needs to be submitted through the `work_email` field.
      </Note>

      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | gender                  |       |
      | job\_title              |       |
      | home\_address.street\_1 |       |
      | home\_address.city      |       |
      | home\_address.zip\_code |       |
      | home\_address.country   |       |
      | date\_of\_birth         |       |
      | start\_date             |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | API Passthrough    |       |
    | Scope Testing      |       |
    | Per Model Tests    |       |
    | Per Field Tests    |       |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
    | Group Types        |       |
    | TEAM               |       |
    | DEPARTMENT         |       |
  </Tab>
</Tabs>


# Sage HR HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/sagehr

Sage HR connector for Kombo's HRIS API

The Sage HR HRIS integration allows you to sync HRIS data between Sage HR and your application through Kombo's unified API. The tool slug for this connector is `sagehr`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/18200475423761">
    Step-by-step instructions to connect your Sage HR account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | job\_title            |       |
      | work\_email           |       |
      | mobile\_phone\_number |       |
      | tax\_id               |       |
      | gender                |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | avatar                |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | name                    |       |
      | unit                    |       |
      | half\_days\_supported   |       |
      | exact\_times\_supported |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_half\_day    |       |
      | end\_half\_day      |       |
      | start\_time         |       |
      | end\_time           |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Time Off Balances">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | type\_id            |       |
      | balance             |       |
      | balance\_unit       |       |
      | used                |       |
      | used\_unit          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee Document Categories">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee">
      <Note>
        The `work_email` field is required for creating employees in SageHR. SageHR only accepts teams, managers, positions, locations, employee numbers, absence approvers and leave types after the employee exists. We set them in a follow-up request, so the employee is still created and returned if applying them fails, and we report a warning instead. SageHR custom fields have to be written one request at a time, so setting many of them makes the request slower.
      </Note>

      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | gender                  |       |
      | job\_title              |       |
      | home\_address.street\_1 |       |
      | home\_address.street\_2 |       |
      | home\_address.city      |       |
      | home\_address.state     |       |
      | home\_address.zip\_code |       |
      | home\_address.country   |       |
      | date\_of\_birth         |       |
      | mobile\_phone\_number   |       |
      | home\_phone\_number     |       |
      | start\_date             |       |
    </Accordion>

    <Accordion title="Add document to employee">
      | Input Field            | Notes |
      | ---------------------- | ----- |
      | employee\_id           |       |
      | category\_id           |       |
      | document.name          |       |
      | document.content\_type |       |
      | document.data\_url     |       |
      | document.data          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | API Passthrough    |       |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
    | Group Types        |       |
    | TEAM               |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Sage HR

For **Sage HR**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Sage HR ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/sagehr/icon.svg" href="/ats/connectors/sagehr">
    Sage HR for the ATS category
  </Card>
</CardGroup>


# Sage People HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/sagepeople

Sage People connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Sage People HRIS integration allows you to sync HRIS data between Sage People and your application through Kombo's unified API. The tool slug for this connector is `sagepeople`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/25986513092881-Sage-People-How-do-I-link-my-account">
    Step-by-step instructions to connect your Sage People account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | ethnicity             |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | API Passthrough    |       |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
  </Tab>
</Tabs>


# Kombo Sandbox HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/sandbox

Kombo Sandbox connector for Kombo's HRIS API

The Kombo Sandbox HRIS integration allows you to sync HRIS data between Kombo Sandbox and your application through Kombo's unified API. The tool slug for this connector is `sandbox`.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | tax\_id               |       |
      | gender                |       |
      | ethnicity             |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | avatar                |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | name                  |       |
      | unit                  |       |
      | half\_days\_supported |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | approver\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_half\_day    |       |
      | end\_half\_day      |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Time Off Balances">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | type\_id            |       |
      | balance             |       |
      | balance\_unit       |       |
      | used                |       |
      | used\_unit          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Timesheets">
      | Field                  | Notes |
      | ---------------------- | ----- |
      | id                     |       |
      | remote\_id             |       |
      | changed\_at            |       |
      | remote\_deleted\_at    |       |
      | employee\_id           |       |
      | started\_at            |       |
      | ended\_at              |       |
      | timezone               |       |
      | payable\_hours         |       |
      | unpaid\_break\_minutes |       |
      | breaks                 |       |
      | approval\_status       |       |
      | comment                |       |
      | remote\_data           |       |
    </Accordion>

    <Accordion title="Performance Review Cycles">
      | Field                       | Notes |
      | --------------------------- | ----- |
      | id                          |       |
      | remote\_id                  |       |
      | changed\_at                 |       |
      | remote\_deleted\_at         |       |
      | name                        |       |
      | review\_period\_start\_date |       |
      | remote\_data                |       |
    </Accordion>

    <Accordion title="Performance Reviews">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | review\_cycle\_id   |       |
      | reviewee\_id        |       |
      | reviewer\_id        |       |
      | type                |       |
      | summary\_comment    |       |
      | summary\_rating     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Staffing entities">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | model\_type          |       |
      | description          |       |
      | status               |       |
      | employment\_types    |       |
      | number\_of\_openings |       |
      | parent\_id           |       |
      | remote\_url          |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Skill Proficiency Scales">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Skills">
      | Field                  | Notes |
      | ---------------------- | ----- |
      | id                     |       |
      | remote\_id             |       |
      | changed\_at            |       |
      | remote\_deleted\_at    |       |
      | name                   |       |
      | proficiency\_scale\_id |       |
      | remote\_created\_at    |       |
      | remote\_data           |       |
    </Accordion>

    <Accordion title="Skill Rating Providers">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee Skill Proficiency Ratings">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | employee\_id         |       |
      | skill\_id            |       |
      | proficiency          |       |
      | rating\_source       |       |
      | rating\_provider\_id |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Staffing Entity <> Location">
      | Field                | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | location\_id         |       |
      | id                   |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
    </Accordion>

    <Accordion title="Staffing Entity <> Legal Entity">
      | Field                | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | legal\_entity\_id    |       |
      | id                   |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
    </Accordion>

    <Accordion title="Staffing entity <> Group">
      | Field                | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | group\_id            |       |
      | id                   |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
    </Accordion>

    <Accordion title="Staffing entity <> Skill">
      | Field                 | Notes |
      | --------------------- | ----- |
      | expected\_proficiency |       |
      | staffing\_entity\_id  |       |
      | skill\_id             |       |
      | id                    |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create absence">
      | Input Field       | Notes |
      | ----------------- | ----- |
      | employee\_id      |       |
      | absence\_type\_id |       |
      | status            |       |
      | start\_date       |       |
      | end\_date         |       |
      | start\_half\_day  |       |
      | end\_half\_day    |       |
      | amount            |       |
      | unit              |       |
      | employee\_note    |       |
      | start\_time       |       |
      | end\_time         |       |
    </Accordion>

    <Accordion title="Delete absence">
      | Input Field | Notes |
      | ----------- | ----- |
      | absence\_id |       |
    </Accordion>

    <Accordion title="Create employee">
      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | gender                  |       |
      | job\_title              |       |
      | home\_address.street\_1 |       |
      | home\_address.street\_2 |       |
      | home\_address.city      |       |
      | home\_address.state     |       |
      | home\_address.zip\_code |       |
      | home\_address.country   |       |
      | date\_of\_birth         |       |
      | start\_date             |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>

    <Accordion title="Upsert employee skill proficiency rating">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | employee\_id          |       |
      | skill\_id             |       |
      | rating.rating\_source |       |
      | rating.proficiency    |       |
    </Accordion>

    <Accordion title="Upsert staffing entity skill expectation">
      | Input Field           | Notes |
      | --------------------- | ----- |
      | expected\_proficiency |       |
    </Accordion>

    <Accordion title="Upsert managed skill">
      | Input Field | Notes |
      | ----------- | ----- |
      | origin\_id  |       |
      | name        |       |
      | status      |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | Scope Testing         |       |
    | Per Model Tests       |       |
    | Per Field Tests       |       |
    | Custom Field Explorer |       |
    | Employees             |       |
    | Staffing entities     |       |
    | Group Types           |       |
    | TEAM                  |       |
    | DEPARTMENT            |       |
    | COST\_CENTER          |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Info>
      Some **optional** form fields are referencing the following data models:

      * Employees
      * Groups
      * Legal Entities
      * Locations

      Consider enabling these in your [scope configuration](/hris/features/scopes).
    </Info>

    <ResponseField name="email" type="text">**Private Email**<br />
    The private email address of the employee<br />
    Unified field: `private_email`</ResponseField>
    <ResponseField name="firstName" type="text">**First Name**<br />
    The first name of the employee<br />
    Unified field: `first_name`</ResponseField>
    <ResponseField name="lastName" type="text">**Last Name**<br />
    The last name of the employee<br />
    Unified field: `last_name`</ResponseField>

    <ResponseField name="personal" type="object">
      **Personal Details**

      <Expandable title="properties">
        <ResponseField name="date_of_birth" type="date">**Date of Birth**<br />
        The employee's date of birth<br />
        Unified field: `date_of_birth`</ResponseField>
        <ResponseField name="gender" type="single_select">**Gender**<br />
        The gender of the employee<br />
        Unified field: `gender`</ResponseField>
        <ResponseField name="nationality" type="text">**Nationality**<br />
        The uppercase two-letter ISO country (e.g., DE)<br />
        Unified field: `nationality`</ResponseField>
        <ResponseField name="mobile_phone" type="text">**Mobile Phone Number**<br />
        The mobile phone number of the employee<br />
        Unified field: `mobile_phone_number`</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="age" type="number">**Age**<br />
    The age of the employee.</ResponseField>

    <ResponseField name="address" type="object">
      **Address**

      <Expandable title="properties">
        <ResponseField name="address_line1" type="text">**Street 1**<br />
        The street address of the employee<br />
        Unified field: `home_address.street_1`</ResponseField>
        <ResponseField name="address_line_2" type="text">**Street 2**<br />
        The street address of the employee<br />
        Unified field: `home_address.street_2`</ResponseField>
        <ResponseField name="postal_code" type="text">**ZIP Code**<br />
        The ZIP code of the employee<br />
        Unified field: `home_address.zip_code`</ResponseField>
        <ResponseField name="city" type="text">**City**<br />
        The city of the employee<br />
        Unified field: `home_address.city`</ResponseField>
        <ResponseField name="state" type="text">**State**<br />
        The state of the employee<br />
        Unified field: `home_address.state`</ResponseField>
        <ResponseField name="country" type="text">**Country**<br />
        The uppercase two-letter ISO country (e.g., DE)<br />
        Unified field: `home_address.country`</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="needs_work_permit" type="checkbox">**Needs Work Permit**<br />
    The employee needs a work permit.</ResponseField>
    <ResponseField name="allergies" type="multi_select">**Allergies**<br />
    The allergies of the employee.</ResponseField>

    <ResponseField name="work" type="object">
      **Work**

      <Expandable title="properties">
        <ResponseField name="job_title" type="text">**Job Title**<br />
        The title of the position this person is working in<br />
        Unified field: `job_title`</ResponseField>
        <ResponseField name="job_description" type="text">**Job Description**<br />
        A summary of the position and its responsibilities.</ResponseField>
        <ResponseField name="start_date" type="date">**Start Date**<br />
        Start date of the employee. Also considered to be the hire date<br />
        Unified field: `start_date`</ResponseField>
        <ResponseField name="work_email" type="text">**Work Email**<br />
        The email address of the employee<br />
        Unified field: `work_email`</ResponseField>
        <ResponseField name="yearly_salary" type="number">**Yearly Salary**<br />
        The yearly salary of the employee<br />
        Unified field: `yearly_salary`</ResponseField>
        <ResponseField name="probation_end_date" type="date">**Probation End Date**<br />
        The date the probation period ends for this employee.</ResponseField>
        <ResponseField name="supervisor" type="single_select">**Supervisor**<br />
        The supervisor of the employee.<br />
        References `/v1/hris/employees?remote_model=employee`</ResponseField>
        <ResponseField name="location" type="single_select">**Location**<br />
        The location of the employee.<br />
        References `/v1/hris/locations?remote_model=location`</ResponseField>
        <ResponseField name="legal_entity" type="single_select">**Legal Entity**<br />
        The legal entity the employee should be assigned to.<br />
        References `/v1/hris/legal-entities?remote_model=legal_entity`</ResponseField>
        <ResponseField name="department" type="single_select">**Department**<br />
        The department of the employee.<br />
        References `/v1/hris/groups?types=DEPARTMENT`</ResponseField>
        <ResponseField name="team" type="single_select">**Group**<br />
        The team of the employee.<br />
        References `/v1/hris/groups?types=TEAM`</ResponseField>
        <ResponseField name="work_hours" type="number">**Work Hours**<br />
        The work hours of the employee.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="emergency_contact" type="object">
      **Emergency Contact**

      <Expandable title="properties">
        <ResponseField name="contacts" type="array">
          **Contacts**<br />
          The contacts of the employee.

          <Expandable title="items">
            <ResponseField name="name" type="text">**Name**<br />
            The name of the contact.</ResponseField>
            <ResponseField name="phone" type="text">**Phone**<br />
            The phone number of the contact.</ResponseField>
            <ResponseField name="relationship" type="single_select">**Relationship**<br />
            The relationship of the contact.</ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Kombo Sandbox

For **Kombo Sandbox**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Kombo Sandbox ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/sandbox/icon.svg" href="/ats/connectors/sandbox">
    Kombo Sandbox for the ATS category
  </Card>

  <Card title="Kombo Sandbox Assessment" icon="https://storage.googleapis.com/kombo-assets/integrations/sandbox/icon.svg" href="/assessment/connectors/sandbox">
    Kombo Sandbox for the Assessment category
  </Card>

  <Card title="Kombo Sandbox LMS" icon="https://storage.googleapis.com/kombo-assets/integrations/sandbox/icon.svg" href="/lms/connectors/sandbox">
    Kombo Sandbox for the LMS category
  </Card>
</CardGroup>


# Kallidus (Sapling) HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/sapling

Kallidus (Sapling) connector for Kombo's HRIS API

The Kallidus (Sapling) HRIS integration allows you to sync HRIS data between Kallidus (Sapling) and your application through Kombo's unified API. The tool slug for this connector is `sapling`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/21712526249873-Sapling-How-do-I-link-my-account">
    Step-by-step instructions to connect your Kallidus (Sapling) account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | tax\_id               |       |
      | gender                |       |
      | ethnicity             |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | avatar                |       |
      | work\_location\_id    |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee">
      <Note>
        Sapling requires `start_date` when creating employees.
      </Note>

      | Input Field | Notes |
      | ----------- | ----- |
      | first\_name |       |
      | last\_name  |       |
      | work\_email |       |
      | job\_title  |       |
      | start\_date |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
    | Group Types        |       |
    | DEPARTMENT         |       |
  </Tab>
</Tabs>


# SCIM HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/scim

SCIM connector for Kombo's HRIS API

<Note>This connector requires a custom Kombo plan. Please contact us to enable it.</Note>

The SCIM HRIS integration allows you to sync HRIS data between SCIM and your application through Kombo's unified API. The tool slug for this connector is `scim`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/31561428832017-How-to-Connect-with-SCIM-Integration">
    Step-by-step instructions to connect your SCIM account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | employment\_status    |       |
      | manager\_id           |       |
      | home\_address         |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | Connection Guide |       |
  </Tab>
</Tabs>


# SD Worx HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/sdworx

SD Worx connector for Kombo's HRIS API

The SD Worx HRIS integration allows you to sync HRIS data between SD Worx and your application through Kombo's unified API. The tool slug for this connector is `sdworx`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/35405285180817-SD-Worx-How-do-I-link-my-account">
    Step-by-step instructions to connect your SD Worx account to Kombo.
  </Card>

  <Card title="How to find your standard employees" icon="book" href="https://help.kombo.dev/hc/en-us/articles/35481610928785-SD-Worx-How-do-I-find-the-Standard-Employees-Default-Persons">
    Additional documentation and guides for SD Worx.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      <Note>
        SD Worx differentiates between companies and organizations. This integration only maps companies and does not interact with organizations in any way. If you need to access organization data, please contact the support team.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes                                                                                                                                                                                                                                                 |
      | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
      | id                    |                                                                                                                                                                                                                                                       |
      | remote\_id            |                                                                                                                                                                                                                                                       |
      | changed\_at           |                                                                                                                                                                                                                                                       |
      | remote\_deleted\_at   |                                                                                                                                                                                                                                                       |
      | employee\_number      |                                                                                                                                                                                                                                                       |
      | first\_name           |                                                                                                                                                                                                                                                       |
      | last\_name            |                                                                                                                                                                                                                                                       |
      | nationality           |                                                                                                                                                                                                                                                       |
      | display\_full\_name   |                                                                                                                                                                                                                                                       |
      | job\_title            |                                                                                                                                                                                                                                                       |
      | work\_email           | SD Worx provides a list of email addresses for each employee, but does not provide a way to distinguish between personal and work email addresses. We only use the first one.                                                                         |
      | mobile\_phone\_number | SD Worx provides a list of phone numbers for each employee, but we only use the first one.                                                                                                                                                            |
      | ssn                   | SD Worx provides a citizen service number for each employee, which can be roughly mapped to social security number or tax id.                                                                                                                         |
      | tax\_id               | SD Worx provides a citizen service number for each employee, which can be roughly mapped to social security number or tax id.                                                                                                                         |
      | gender                |                                                                                                                                                                                                                                                       |
      | marital\_status       |                                                                                                                                                                                                                                                       |
      | employment\_status    | SD Worx does not provide a uniform way to query employment status. This integration assumes that all employees that are not currently employed are INACTIVE.                                                                                          |
      | employment\_type      | SD Worx does not provide a uniform employment type. All employees in a fixed working contract with more than 32 hours per week are considered FULL\_TIME. All employees with a contract with a defined duration are considered as CONTRACT employees. |
      | weekly\_hours         |                                                                                                                                                                                                                                                       |
      | work\_location\_id    |                                                                                                                                                                                                                                                       |
      | legal\_entity\_id     |                                                                                                                                                                                                                                                       |
      | manager\_id           |                                                                                                                                                                                                                                                       |
      | home\_address         |                                                                                                                                                                                                                                                       |
      | bank\_accounts        |                                                                                                                                                                                                                                                       |
      | date\_of\_birth       |                                                                                                                                                                                                                                                       |
      | start\_date           |                                                                                                                                                                                                                                                       |
      | termination\_date     |                                                                                                                                                                                                                                                       |
      | custom\_fields        |                                                                                                                                                                                                                                                       |
      | integration\_fields   |                                                                                                                                                                                                                                                       |
      | remote\_data          |                                                                                                                                                                                                                                                       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes                                                                                                                                                                                                                                                          |
      | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
      | id                  |                                                                                                                                                                                                                                                                |
      | remote\_id          | Our system uses SD Worx' employment history resource to generate employments. As this is generated on the fly by SD Worx, the remote\_id is not stable and can change between runs. We use a compound key to ensure that the employment is upserted correctly. |
      | changed\_at         |                                                                                                                                                                                                                                                                |
      | remote\_deleted\_at |                                                                                                                                                                                                                                                                |
      | employee\_id        |                                                                                                                                                                                                                                                                |
      | job\_title          |                                                                                                                                                                                                                                                                |
      | pay\_rate           |                                                                                                                                                                                                                                                                |
      | pay\_period         |                                                                                                                                                                                                                                                                |
      | employment\_type    | SD Worx does not provide a uniform employment type. All employees in a fixed working contract with more than 32 hours per week are considered FULL\_TIME. All employees with a contract with a defined duration are considered as CONTRACT employees.          |
      | pay\_currency       | SD Worx does not provide a pay currency for employees. EUR is assumed for all employees                                                                                                                                                                        |
      | effective\_date     |                                                                                                                                                                                                                                                                |
    </Accordion>

    <Accordion title="Groups">
      <Note>
        SD Worx' Group resource is mapped as Kombo Teams SD Worx does not support getting cost centers without having access to companies. The legal entities scope must therefore be enabled to sync cost centers.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee Document Categories">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      <Note>
        SD Worx provides employee group associations through CurrentEmployment.DepartmentId, CurrentEmployment.CostCenterId, and ParticipantInGroups. Note that ParticipantInGroups requires additional permissions (GroupParticipant GET) and may not be available in all accounts.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>

    <Accordion title="Add document to employee">
      | Input Field        | Notes |
      | ------------------ | ----- |
      | employee\_id       |       |
      | category\_id       |       |
      | document.name      |       |
      | document.data\_url |       |
      | document.data      |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | API Passthrough  |       |
    | Scope Testing    |       |
    | Per Model Tests  |       |
    | Connection Guide |       |
    | Group Types      |       |
    | TEAM             |       |
    | DEPARTMENT       |       |
    | COST\_CENTER     |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Info>
      Some **required** form fields are referencing the following data models:

      * Groups

      Additionally, there are some **optional** form fields that reference:

      * Legal Entities

      Consider enabling these in your [scope configuration](/hris/features/scopes).
    </Info>

    <ResponseField name="StartDate" type="date">**Start Date**<br />
    Start date of the employee. Also considered to be the hire date<br />
    Unified field: `start_date`</ResponseField>
    <ResponseField name="OrganizationId" type="single_select">**Organization**</ResponseField>
    <ResponseField name="PersonNumber" type="text">**Person Number**<br />
    The person number of the employee.</ResponseField>
    <ResponseField name="CitizenServiceNumber" type="text">**Citizen Service Number**<br />
    The citizen service number of the employee. Use 0 to apply the next available number</ResponseField>
    <ResponseField name="Initials" type="text">The initials of the employee.</ResponseField>
    <ResponseField name="Prefixes" type="text">The prefixes of the employee.</ResponseField>
    <ResponseField name="Lastname" type="text">**Last Name**<br />
    The last name of the employee<br />
    Unified field: `last_name`</ResponseField>
    <ResponseField name="Names" type="text">**First Name**<br />
    The first name of the employee<br />
    Unified field: `first_name`</ResponseField>
    <ResponseField name="Nickname" type="text">The nickname of the employee.</ResponseField>

    <ResponseField name="Gender" type="single_select" />

    <ResponseField name="DateOfBirth" type="date">**Date of Birth**<br />
    The employee's date of birth<br />
    Unified field: `date_of_birth`</ResponseField>
    <ResponseField name="Email" type="text">**Work Email**<br />
    The email address of the employee<br />
    Unified field: `work_email`</ResponseField>
    <ResponseField name="DepartmentId" type="single_select">**Department**<br />
    References `/v1/hris/groups?types=DEPARTMENT`</ResponseField>
    <ResponseField name="FunctionId" type="single_select">**Function**</ResponseField>
    <ResponseField name="DefaultPerson" type="number">**Standard Employee**<br />
    The number of the standard employee to use in SD Worx' New Person workflow. You can find this in the 'Manage default person' task of the organization you want to create the employee in. Take a look at the guide here [https://help.kombo.dev/hc/en-us/articles/35481610928785-SD-Worx-How-do-I-find-the-Standard-Employees-Default-Persons](https://help.kombo.dev/hc/en-us/articles/35481610928785-SD-Worx-How-do-I-find-the-Standard-Employees-Default-Persons)</ResponseField>
    <ResponseField name="CompanyId" type="single_select">**Company**<br />
    References `/v1/hris/legal-entities?remote_model=legal_entity`</ResponseField>
  </Tab>
</Tabs>


# Sesame HR HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/sesamehr

Sesame HR connector for Kombo's HRIS API

The Sesame HR HRIS integration allows you to sync HRIS data between Sesame HR and your application through Kombo's unified API. The tool slug for this connector is `sesamehr`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/22970090538001">
    Step-by-step instructions to connect your Sesame HR account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Work Locations">
      <Note>
        Sesame HR allows for multiple work locations, but Kombo only show the most recent location.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | type                |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | first\_name           |       |
      | last\_name            |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | avatar                |       |
      | work\_location\_id    |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_time         |       |
      | end\_time           |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create absence">
      <Note>
        Hourly absences are not supported yet.
      </Note>

      | Input Field       | Notes |
      | ----------------- | ----- |
      | employee\_id      |       |
      | absence\_type\_id |       |
      | start\_date       |       |
      | end\_date         |       |
      | employee\_note    |       |
    </Accordion>

    <Accordion title="Delete absence">
      | Input Field | Notes |
      | ----------- | ----- |
      | absence\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
    | Group Types        |       |
    | DEPARTMENT         |       |
  </Tab>
</Tabs>


# SFTP HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/sftp

SFTP connector for Kombo's HRIS API

<Note>This connector requires a custom Kombo plan. Please contact us to enable it.</Note>

The SFTP HRIS integration allows you to sync HRIS data between SFTP and your application through Kombo's unified API. The tool slug for this connector is `sftp`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/28736908016529">
    Step-by-step instructions to connect your SFTP account to Kombo.
  </Card>
</CardGroup>

## General Notes

* Your end customer is responsible for the contents of the export. Before they configure the SFTP upload, you must communicate every required and custom field that their files need to include.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | tax\_id               |       |
      | gender                |       |
      | ethnicity             |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | avatar                |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | name                    |       |
      | unit                    |       |
      | half\_days\_supported   |       |
      | exact\_times\_supported |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | approver\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_half\_day    |       |
      | end\_half\_day      |       |
      | start\_time         |       |
      | end\_time           |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | parent\_id          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Time Off Balances">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | type\_id            |       |
      | balance             |       |
      | balance\_unit       |       |
      | used                |       |
      | used\_unit          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee Document Categories">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | Connection Guide |       |
    | Prerequisites    |       |
    | Group Types      |       |
    | TEAM             |       |
    | DEPARTMENT       |       |
    | COST\_CENTER     |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Choose this variant if your customer wants to send data to Kombo's SFTP server

For **SFTP**, we also offer the following other connector variants:

<CardGroup>
  <Card title="SFTP Fetch" icon="https://storage.googleapis.com/kombo-assets/integrations/sftpfetch/icon.svg" href="/hris/connectors/sftpfetch">
    Choose this variant if you want to read data from your customer's SFTP server
  </Card>
</CardGroup>

<Note>Multiple variants can be used within your Kombo environment at the same time.</Note>


# SFTP Fetch HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/sftpfetch

SFTP Fetch connector for Kombo's HRIS API

<Note>This connector requires a custom Kombo plan. Please contact us to enable it.</Note>

The SFTP Fetch HRIS integration allows you to sync HRIS data between SFTP Fetch and your application through Kombo's unified API. The tool slug for this connector is `sftpfetch`.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | tax\_id               |       |
      | gender                |       |
      | ethnicity             |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | avatar                |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | name                    |       |
      | unit                    |       |
      | half\_days\_supported   |       |
      | exact\_times\_supported |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | approver\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_half\_day    |       |
      | end\_half\_day      |       |
      | start\_time         |       |
      | end\_time           |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | parent\_id          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Time Off Balances">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | type\_id            |       |
      | balance             |       |
      | balance\_unit       |       |
      | used                |       |
      | used\_unit          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee Document Categories">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature      | Notes |
    | ------------ | ----- |
    | Group Types  |       |
    | DEPARTMENT   |       |
    | COST\_CENTER |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Choose this variant if you want to read data from your customer's SFTP server

For **SFTP Fetch**, we also offer the following other connector variants:

<CardGroup>
  <Card title="SFTP" icon="https://storage.googleapis.com/kombo-assets/integrations/sftp/icon.svg" href="/hris/connectors/sftp">
    Choose this variant if your customer wants to send data to Kombo's SFTP server
  </Card>
</CardGroup>

<Note>Multiple variants can be used within your Kombo environment at the same time.</Note>


# Silae HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/silae

Silae connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Silae HRIS integration allows you to sync HRIS data between Silae and your application through Kombo's unified API. The tool slug for this connector is `silae`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/22773374248337-Silae-How-do-I-link-my-account">
    Step-by-step instructions to connect your Silae account to Kombo.
  </Card>

  <Card title="How do I set up the integration for one of my customers?" icon="book" href="https://help.kombo.dev/hc/en-us/articles/16226986373393-Silae-How-do-I-set-up-the-integration-for-one-of-my-customers-">
    Additional documentation and guides for Silae.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_number    |       |
      | first\_name         |       |
      | last\_name          |       |
      | job\_title          |       |
      | work\_email         |       |
      | ssn                 |       |
      | employment\_status  |       |
      | legal\_entity\_id   |       |
      | start\_date         |       |
      | termination\_date   |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | name                  |       |
      | unit                  |       |
      | half\_days\_supported |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | amount              |       |
      | unit                |       |
      | employee\_note      |       |
      | type\_id            |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create absence">
      | Input Field       | Notes |
      | ----------------- | ----- |
      | employee\_id      |       |
      | absence\_type\_id |       |
      | start\_date       |       |
      | end\_date         |       |
      | start\_half\_day  |       |
      | end\_half\_day    |       |
      | employee\_note    |       |
    </Accordion>

    <Accordion title="Create employee">
      <Note>
        This endpoint requires the siret number as a remote field. You can find this as the remote ID of the Silae legal entity.
      </Note>

      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | gender                  |       |
      | job\_title              |       |
      | home\_address.street\_1 |       |
      | home\_address.street\_2 |       |
      | home\_address.city      |       |
      | home\_address.state     |       |
      | home\_address.zip\_code |       |
      | home\_address.country   |       |
      | date\_of\_birth         |       |
      | mobile\_phone\_number   |       |
      | nationality             |       |
      | start\_date             |       |
      | legal\_entity\_id       |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | API Passthrough       |       |
    | Custom Field Explorer |       |
    | Employees             |       |
    | Employments           |       |
    | Connection Guide      |       |
    | Create credentials    |       |
    | Group Types           |       |
    | DEPARTMENT            |       |
  </Tab>
</Tabs>


# Simployer HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/simployer

Simployer connector for Kombo's HRIS API

The Simployer HRIS integration allows you to sync HRIS data between Simployer and your application through Kombo's unified API. The tool slug for this connector is `simployer`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/22477829315985-AlexisHR-How-do-I-link-my-account">
    Step-by-step instructions to connect your Simployer account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | avatar                |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      <Note>
        In AlexisHR, absence types can be overwritten with policies, which are not available via API. The absence type returned by Kombo will therefore represent the default leave type, not the policy.
      </Note>

      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | name                    |       |
      | unit                    |       |
      | half\_days\_supported   |       |
      | exact\_times\_supported |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | approver\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_half\_day    |       |
      | end\_half\_day      |       |
      | start\_time         |       |
      | end\_time           |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create absence">
      <Note>
        AlexisHR will disregard time specific data on absences spanning multiple days. Trying to create an absence that conforms with the Kombo absence type might still fail, as AlexisHR allows to override types with leave policies, which are not available through the API.
      </Note>

      | Input Field       | Notes |
      | ----------------- | ----- |
      | employee\_id      |       |
      | absence\_type\_id |       |
      | status            |       |
      | start\_date       |       |
      | end\_date         |       |
      | start\_half\_day  |       |
      | end\_half\_day    |       |
      | employee\_note    |       |
      | start\_time       |       |
      | end\_time         |       |
    </Accordion>

    <Accordion title="Delete absence">
      | Input Field | Notes |
      | ----------- | ----- |
      | absence\_id |       |
    </Accordion>

    <Accordion title="Create employee">
      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | gender                  |       |
      | job\_title              |       |
      | home\_address.street\_1 |       |
      | home\_address.city      |       |
      | home\_address.zip\_code |       |
      | home\_address.country   |       |
      | date\_of\_birth         |       |
      | mobile\_phone\_number   |       |
      | nationality             |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | API Passthrough    |       |
    | Connection Guide   |       |
    | Prerequisites      |       |
    | Create credentials |       |
    | Group Types        |       |
    | TEAM               |       |
    | DEPARTMENT         |       |
    | COST\_CENTER       |       |
  </Tab>

  <Tab title="Create Employee with Form">
    *We don't have enough information yet about the fields to display them here.*
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Current name after AlexisHR was acquired by Simployer

For **Simployer**, we also offer the following other connector variants:

<CardGroup>
  <Card title="AlexisHR" icon="https://storage.googleapis.com/kombo-assets/integrations/alexishr/icon.svg" href="/hris/connectors/alexishr">
    Legacy name for AlexisHR. Use Simployer for new connections
  </Card>
</CardGroup>

<Note>You can only use one variant at a time.</Note>


# Square HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/square

Square connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Square HRIS integration allows you to sync HRIS data between Square and your application through Kombo's unified API. The tool slug for this connector is `square`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/29983726405905-Square-How-do-I-link-my-account">
    Step-by-step instructions to connect your Square account to Kombo.
  </Card>

  <Card title="Sandbox Environment" icon="flask" href="https://developer.squareup.com/docs/devtools/sandbox/overview">
    Access the Square sandbox environment for testing and development.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field               | Notes                                                                                                                       |
      | ------------------- | --------------------------------------------------------------------------------------------------------------------------- |
      | id                  |                                                                                                                             |
      | remote\_id          |                                                                                                                             |
      | changed\_at         |                                                                                                                             |
      | remote\_deleted\_at |                                                                                                                             |
      | employee\_number    |                                                                                                                             |
      | first\_name         |                                                                                                                             |
      | last\_name          |                                                                                                                             |
      | job\_title          |                                                                                                                             |
      | work\_email         |                                                                                                                             |
      | employment\_status  |                                                                                                                             |
      | work\_location\_id  | Employees in Square can be assigned to multiple locations. We only return locations for employees assigned to one location. |
      | remote\_created\_at |                                                                                                                             |
      | custom\_fields      |                                                                                                                             |
      | integration\_fields |                                                                                                                             |
      | remote\_data        |                                                                                                                             |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_currency       |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee">
      <Note>
        Employees will always be created as inactive in Square. We are not assigning the job automatically, because the manager needs to specify salary and job information for the employment manually.
      </Note>

      | Input Field           | Notes |
      | --------------------- | ----- |
      | first\_name           |       |
      | last\_name            |       |
      | work\_email           |       |
      | mobile\_phone\_number |       |
      | location\_id          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | OAuth            |       |
    | Connection Guide |       |
    | Prerequisites    |       |
  </Tab>
</Tabs>


# SAP SuccessFactors HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/successfactors

SAP SuccessFactors connector for Kombo's HRIS API

The SAP SuccessFactors HRIS integration allows you to sync HRIS data between SAP SuccessFactors and your application through Kombo's unified API. The tool slug for this connector is `successfactors`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/16225034050961-How-do-I-link-my-SAP-SuccessFactors-account-">
    Step-by-step instructions to connect your SAP SuccessFactors account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      <Note>
        Only one home address is mapped. If preferred address type is set in integration settings, we use that type; otherwise the first address is used. For employees with multiple managers, we only expose the first one. employment\_status is an employee-level status aggregated across all employments and can be ACTIVE, INACTIVE, or LEAVE.
      </Note>

      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | ethnicity             |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | name                    |       |
      | unit                    |       |
      | exact\_times\_supported |       |
      | remote\_data            |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_time         |       |
      | end\_time           |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_created\_at |       |
      | remote\_updated\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | parent\_id          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Time Off Balances">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | type\_id            |       |
      | balance             |       |
      | balance\_unit       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Timesheets">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | started\_at         |       |
      | ended\_at           |       |
      | timezone            |       |
      | payable\_hours      |       |
      | approval\_status    |       |
      | comment             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Performance Review Cycles">
      <Note>
        The we treat the form template as a performance review cycle.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Performance Reviews">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | review\_cycle\_id   |       |
      | reviewee\_id        |       |
      | reviewer\_id        |       |
      | type                |       |
      | summary\_comment    |       |
      | summary\_rating     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create absence">
      <Note>
        Setting the approvalStatus might not be working consistently
      </Note>

      | Input Field       | Notes |
      | ----------------- | ----- |
      | employee\_id      |       |
      | absence\_type\_id |       |
      | status            |       |
      | start\_date       |       |
      | end\_date         |       |
      | start\_time       |       |
      | end\_time         |       |
    </Accordion>

    <Accordion title="Delete absence">
      | Input Field | Notes |
      | ----------- | ----- |
      | absence\_id |       |
    </Accordion>

    <Accordion title="Create employee">
      <Note>
        SuccessFactors requires a native preferred language. We strive to find the best match, although it may not always be accurate. We will map the nationality into the country of birth.
      </Note>

      | Input Field           | Notes |
      | --------------------- | ----- |
      | first\_name           |       |
      | last\_name            |       |
      | work\_email           |       |
      | gender                |       |
      | date\_of\_birth       |       |
      | mobile\_phone\_number |       |
      | nationality           |       |
      | start\_date           |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>

    <Accordion title="Add document to employee">
      | Input Field            | Notes |
      | ---------------------- | ----- |
      | employee\_id           |       |
      | category\_id           |       |
      | document.name          |       |
      | document.content\_type |       |
      | document.data\_url     |       |
      | document.data          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | API Passthrough       |       |
    | Additional Scopes     |       |
    | Scope Testing         |       |
    | Delta Syncs           |       |
    | Custom Field Explorer |       |
    | Employees             |       |
    | Connection Guide      |       |
    | Prerequisites         |       |
    | Create credentials    |       |
    | Group Types           |       |
    | DEPARTMENT            |       |
    | COST\_CENTER          |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Note>
      It's possible when creating an employee, that it's a partial success, meaning some data might not be created or updated correctly. If this happens, you can use the Person ID to update the employee later with the form.
    </Note>

    <Info>
      Some **optional** form fields are referencing the following data models:

      * Employees

      Consider enabling these in your [scope configuration](/hris/features/scopes).
    </Info>

    <ResponseField name="personId" type="text">**Person ID**<br />
    This is the ID of the person in SuccessFactors. Only provide this when updating an existing employee. Leave blank to create a new employee.</ResponseField>

    <ResponseField name="user" type="object">
      **User**

      <Expandable title="properties">
        <ResponseField name="firstName" type="text">**First Name**<br />
        The first name of the employee<br />
        Unified field: `first_name`</ResponseField>
        <ResponseField name="lastName" type="text">**Last Name**<br />
        The last name of the employee<br />
        Unified field: `last_name`</ResponseField>
        <ResponseField name="email" type="text">**Work Email**<br />
        The work email address of the employee<br />
        Unified field: `work_email`</ResponseField>
        <ResponseField name="cellPhone" type="text">**Mobile Phone Number**<br />
        The mobile phone number of the employee<br />
        Unified field: `mobile_phone_number`</ResponseField>
        <ResponseField name="manager" type="single_select">**Manager**<br />
        The manager of the employee<br />
        References `/v1/hris/employees?remote_model=employee`</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="person" type="object">
      **Person**<br />
      This entity contains the non-effective-dated biographical information such as date of birth, country of birth. It is commonly used as the main entity when doing employee master extracts.

      <Expandable title="properties">
        <ResponseField name="countryOfBirth" type="single_select">**Country Of Birth**</ResponseField>
        <ResponseField name="customDate7" type="date">**Special Date**</ResponseField>
        <ResponseField name="customString1" type="text">**Nick Name**</ResponseField>
        <ResponseField name="dateOfBirth" type="date">**Date Of Birth**<br />
        Unified field: `date_of_birth`</ResponseField>
        <ResponseField name="regionOfBirth" type="text">**Region Of Birth**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="employment" type="object">
      **Employment**<br />
      Contains all the employment related information for an employee.

      <Expandable title="properties">
        <ResponseField name="benefitsEligibilityStartDate" type="date">**Benefits Eligibility Start Date**</ResponseField>
        <ResponseField name="customString1" type="text">**Change Reason**</ResponseField>
        <ResponseField name="customString15" type="text">**Test Custon Field**</ResponseField>
        <ResponseField name="eligibleForStock" type="checkbox">**Eligible for Stock**</ResponseField>
        <ResponseField name="employeeFirstEmployment" type="checkbox">**Employee's First Employment**</ResponseField>
        <ResponseField name="firstDateWorked" type="date">**First Date Worked**</ResponseField>
        <ResponseField name="initialOptionGrant" type="number">**Initial Option Grant**</ResponseField>
        <ResponseField name="initialStockGrant" type="number">**Initial Stock Grant**</ResponseField>
        <ResponseField name="isContingentWorker" type="checkbox">**Contingent Worker**</ResponseField>
        <ResponseField name="originalStartDate" type="date">**Original Start Date**</ResponseField>
        <ResponseField name="prevEmployeeId" type="text">**Previous Employment ID**</ResponseField>
        <ResponseField name="professionalServiceDate" type="date">**Professional Service Date**</ResponseField>
        <ResponseField name="seniorityDate" type="date">**Seniority Start Date**</ResponseField>
        <ResponseField name="serviceDate" type="date">**Service Date**</ResponseField>
        <ResponseField name="startDate" type="date">**Hire Date**<br />
        Unified field: `start_date`</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="personalInfo" type="object">
      **Personal Information**<br />
      Contains personal information for an employee.

      <Expandable title="properties">
        <ResponseField name="customDate7" type="date">**Special Date**</ResponseField>
        <ResponseField name="customString1" type="text">**Nick Name**</ResponseField>
        <ResponseField name="endDate" type="date">**End Date**</ResponseField>
        <ResponseField name="firstName" type="text">**First Name**<br />
        Unified field: `first_name`</ResponseField>
        <ResponseField name="firstNameAlt1" type="text">**Alt1 First Name**</ResponseField>
        <ResponseField name="gender" type="single_select">**Gender**<br />
        Unified field: `gender`</ResponseField>
        <ResponseField name="lastName" type="text">**Last Name**<br />
        Unified field: `last_name`</ResponseField>
        <ResponseField name="lastNameAlt1" type="text">**Alt1 Last Name**</ResponseField>
        <ResponseField name="maritalStatus" type="single_select">**Marital Status**</ResponseField>
        <ResponseField name="middleName" type="text">**Middle Name**</ResponseField>
        <ResponseField name="middleNameAlt1" type="text">**Alt1 Middle Name**</ResponseField>
        <ResponseField name="nationality" type="single_select">**Nationality**<br />
        Unified field: `nationality`</ResponseField>
        <ResponseField name="nativePreferredLang" type="single_select">**Preferred Language**</ResponseField>
        <ResponseField name="preferredName" type="text">**Preferred Name**</ResponseField>
        <ResponseField name="salutation" type="single_select">**Salutation**</ResponseField>
        <ResponseField name="startDate" type="date">**Event Date**<br />
        Unified field: `start_date`</ResponseField>
        <ResponseField name="suffix" type="single_select">**Suffix**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="perEmail" type="object">
      **Email**<br />
      Contains employee's email address.

      <Expandable title="properties">
        <ResponseField name="emailAddress" type="text">**Email Address**<br />
        Unified field: `private_email`</ResponseField>
        <ResponseField name="emailType" type="single_select">**Email Type**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="perPhone" type="object">
      **Phone**<br />
      Contains information about an employee's phone numbers.

      <Expandable title="properties">
        <ResponseField name="areaCode" type="text">**Area Code**</ResponseField>
        <ResponseField name="countryCode" type="text">**Country Code**</ResponseField>
        <ResponseField name="extension" type="text">**Extension**</ResponseField>
        <ResponseField name="phoneNumber" type="text">**Phone Number**</ResponseField>
        <ResponseField name="phoneType" type="single_select">**Phone Type**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="perEmergencyContacts" type="object">
      **Emergency Contacts**<br />
      Contains emergency contact information for an employee.

      <Expandable title="properties">
        <ResponseField name="email" type="text">**eMail**</ResponseField>
        <ResponseField name="name" type="text">**Name**</ResponseField>
        <ResponseField name="phone" type="text">**Phone**</ResponseField>

        <ResponseField name="primaryFlag" type="single_select" />

        <ResponseField name="relationship" type="single_select">**Relationship**</ResponseField>
        <ResponseField name="secondPhone" type="text">**Alt Phone**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="perAddressDEFLT" type="object">
      **Address**<br />
      Contains information about address.

      <Expandable title="properties">
        <ResponseField name="address1" type="text" />

        <ResponseField name="address10" type="text">**Apartment**</ResponseField>
        <ResponseField name="address11" type="text">**Bed Number**</ResponseField>
        <ResponseField name="address12" type="single_select">**City**</ResponseField>
        <ResponseField name="address13" type="text">**Street Number**</ResponseField>

        <ResponseField name="address2" type="text" />

        <ResponseField name="address20" type="text">**Care Of**</ResponseField>
        <ResponseField name="address3" type="single_select">**Municipality**</ResponseField>
        <ResponseField name="address5" type="text">**Second Address Line**</ResponseField>
        <ResponseField name="address8" type="single_select">**Camp**</ResponseField>
        <ResponseField name="address9" type="text">**Building**</ResponseField>
        <ResponseField name="addressType" type="single_select">**Address Type**</ResponseField>
        <ResponseField name="city" type="single_select">**District**<br />
        Unified field: `home_address.city`</ResponseField>
        <ResponseField name="country" type="single_select">Unified field: `home_address.country`</ResponseField>
        <ResponseField name="county" type="single_select">**County**</ResponseField>
        <ResponseField name="endDate" type="date">**End Date**</ResponseField>

        <ResponseField name="notes" type="text" />

        <ResponseField name="province" type="single_select">**Province**</ResponseField>
        <ResponseField name="startDate" type="date">**Event Date**<br />
        Unified field: `start_date`</ResponseField>
        <ResponseField name="state" type="single_select">**State**<br />
        Unified field: `home_address.state`</ResponseField>
        <ResponseField name="zipCode" type="text">Unified field: `home_address.zip_code`</ResponseField>
      </Expandable>
    </ResponseField>
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** SAP SuccessFactors

For **SAP SuccessFactors**, we also offer the following other connector variants:

<CardGroup>
  <Card title="SAP SuccessFactors ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/successfactors/icon.svg" href="/ats/connectors/successfactors">
    SAP SuccessFactors for the ATS category
  </Card>

  <Card title="SAP SuccessFactors Assessment" icon="https://storage.googleapis.com/kombo-assets/integrations/successfactors/icon.svg" href="/assessment/connectors/successfactors">
    SAP SuccessFactors for the Assessment category
  </Card>

  <Card title="SAP SuccessFactors LMS" icon="https://storage.googleapis.com/kombo-assets/integrations/successfactors/icon.svg" href="/lms/connectors/successfactors">
    SAP SuccessFactors for the LMS category
  </Card>
</CardGroup>


# Sympa HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/sympa

Sympa connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Sympa HRIS integration allows you to sync HRIS data between Sympa and your application through Kombo's unified API. The tool slug for this connector is `sympa`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/31669647308305-Sympa-How-do-I-link-my-account">
    Step-by-step instructions to connect your Sympa account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | tax\_id               |       |
      | gender                |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee">
      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | home\_address.street\_1 |       |
      | home\_address.city      |       |
      | home\_address.zip\_code |       |
      | home\_address.country   |       |
      | mobile\_phone\_number   |       |
      | start\_date             |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | API Passthrough  |       |
    | Connection Guide |       |
    | Prerequisites    |       |
    | Group Types      |       |
    | TEAM             |       |
    | DEPARTMENT       |       |
    | COST\_CENTER     |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Info>
      Some **required** form fields are referencing the following data models:

      * Employees

      Consider enabling these in your [scope configuration](/hris/features/scopes).
    </Info>

    <ResponseField name="Given_first_names" type="text">**First Name**<br />
    The first name of the employee<br />
    Unified field: `first_name`</ResponseField>
    <ResponseField name="Surname" type="text">**Last Name**<br />
    The last name of the employee<br />
    Unified field: `last_name`</ResponseField>
    <ResponseField name="Surname_prefix" type="text">**Surname Prefix**<br />
    Prefix for the surname (e.g. van, de, von)</ResponseField>
    <ResponseField name="Initials" type="text">The initials of the employee</ResponseField>
    <ResponseField name="Preferred_given_name" type="text">**Preferred Given Name**<br />
    The name the employee prefers to be called</ResponseField>
    <ResponseField name="Juridical_gender" type="single_select">**Gender**<br />
    The gender of the employee<br />
    Unified field: `gender`</ResponseField>
    <ResponseField name="Manager" type="single_select">The manager of the employee<br />
    References `/v1/hris/employees?remote_model=employee`</ResponseField>
    <ResponseField name="Phone_number_private" type="text">**Mobile Phone Number**<br />
    The mobile phone number of the employee<br />
    Unified field: `mobile_phone_number`</ResponseField>
    <ResponseField name="E-mail_address_private" type="text">**Private Email**<br />
    The private email address of the employee<br />
    Unified field: `private_email`</ResponseField>
    <ResponseField name="C/O_Address" type="text">**C/O Address**<br />
    Care of address line</ResponseField>
    <ResponseField name="Country_setting" type="single_select">**Country setting**<br />
    The country where the employee is based</ResponseField>
    <ResponseField name="Street_address" type="text">**Street 1**<br />
    The street address of the employee<br />
    Unified field: `home_address.street_1`</ResponseField>
    <ResponseField name="Postal_code" type="text">**ZIP Code**<br />
    The ZIP code of the employee<br />
    Unified field: `home_address.zip_code`</ResponseField>
    <ResponseField name="City" type="text">The city of the employee<br />
    Unified field: `home_address.city`</ResponseField>
    <ResponseField name="Region" type="text">**State**<br />
    The state of the employee<br />
    Unified field: `home_address.state`</ResponseField>
    <ResponseField name="Original_hire_date" type="date">**Start Date**<br />
    Start date of the employee. Also considered to be the hire date<br />
    Unified field: `start_date`</ResponseField>
    <ResponseField name="Date_of_birth" type="date">**Date of Birth**<br />
    The employee's date of birth<br />
    Unified field: `date_of_birth`</ResponseField>
    <ResponseField name="Tax_identification_number" type="text">**Tax Identification Number**<br />
    Tax ID or tax reference number</ResponseField>
    <ResponseField name="Personal_ID_number" type="text">**Personal ID number**<br />
    National identification number</ResponseField>
    <ResponseField name="Candidate_ID_from_ATS" type="text">**Candidate ID from ATS**<br />
    Applicant tracking system candidate identifier</ResponseField>
  </Tab>
</Tabs>


# TriNet (Zenefits) HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/trinet

TriNet (Zenefits) connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The TriNet (Zenefits) HRIS integration allows you to sync HRIS data between TriNet (Zenefits) and your application through Kombo's unified API. The tool slug for this connector is `trinet`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/26847548942737-Trinet-Zenefits-How-do-I-link-my-account">
    Step-by-step instructions to connect your TriNet (Zenefits) account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | avatar                |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | pay\_rate           |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | Scope Testing      |       |
    | Per Model Tests    |       |
    | Per Field Tests    |       |
    | Connection Guide   |       |
    | Create credentials |       |
    | Employment History |       |
    | Group Types        |       |
    | DEPARTMENT         |       |
  </Tab>
</Tabs>


# TriNet PEO HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/trinetpeo

TriNet PEO connector for Kombo's HRIS API

<Note>This connector is in closed beta. Please contact us to get access.</Note>

The TriNet PEO HRIS integration allows you to sync HRIS data between TriNet PEO and your application through Kombo's unified API. The tool slug for this connector is `trinetpeo`.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | mobile\_phone\_number |       |
      | gender                |       |
      | ethnicity             |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | avatar                |       |
      | work\_location\_id    |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature         | Notes |
    | --------------- | ----- |
    | API Passthrough |       |
    | Scope Testing   |       |
    | Per Model Tests |       |
    | Group Types     |       |
    | DEPARTMENT      |       |
  </Tab>

  <Tab title="Create Employee with Form">
    *We don't have enough information yet about the fields to display them here.*
  </Tab>
</Tabs>


# UKG Pro HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/ukgpro

UKG Pro connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The UKG Pro HRIS integration allows you to sync HRIS data between UKG Pro and your application through Kombo's unified API. The tool slug for this connector is `ukgpro`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/23900772792721-UKG-Pro-HRIS-How-do-I-link-my-account">
    Step-by-step instructions to connect your UKG Pro account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | ethnicity             |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | unit                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Time Off Balances">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | type\_id            |       |
      | balance             |       |
      | balance\_unit       |       |
      | used                |       |
      | used\_unit          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Staffing entities">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | model\_type          |       |
      | description          |       |
      | status               |       |
      | employment\_types    |       |
      | number\_of\_openings |       |
      | parent\_id           |       |
      | remote\_url          |       |
      | remote\_created\_at  |       |
      | remote\_updated\_at  |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Staffing Entity <> Location">
      | Field                | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | location\_id         |       |
      | id                   |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
    </Accordion>

    <Accordion title="Staffing Entity <> Legal Entity">
      | Field                | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | legal\_entity\_id    |       |
      | id                   |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
    </Accordion>

    <Accordion title="Staffing entity <> Group">
      | Field                | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | group\_id            |       |
      | id                   |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | API Passthrough       |       |
    | Scope Testing         |       |
    | Per Model Tests       |       |
    | Custom Field Explorer |       |
    | Employments           |       |
    | Connection Guide      |       |
    | Create credentials    |       |
    | Group Types           |       |
    | TEAM                  |       |
    | DEPARTMENT            |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Note>
      The behavior of this action depends on your UKG Pro configuration. If you selected UKG Onboarding during setup, it creates a "New Hire" that needs to be onboarded. If you selected UKG Pro, it creates an employee directly through the Import Tool.
    </Note>

    <Note>
      International Import Tool hires are supported only when [`staffing_entity_id`](`docs.kombo.dev/hris/implementation-guide/staffing-entities-in-create-employee`) is provided and resolves to a country other than the USA or Canada. Without that context, Kombo returns the existing US hire form and requires an SSN.
    </Note>

    This integration supports multiple employee creation forms for different use cases:

    <Tabs>
      <Tab title="import-tool">
        <Info>
          Some **optional** form fields are referencing the following data models:

          * Employees

          Consider enabling these in your [scope configuration](/hris/features/scopes).
        </Info>

        <Info>
          **Form-specific constraints**

          * Creates an employee directly in UKG Pro using the Import Tool API

          * International hires use the Global Hire transaction only when [`staffing_entity_id`](https://docs.kombo.dev/hris/implementation-guide/staffing-entities-in-create-employee) is provided and resolves to a country other than the USA or Canada. Without that context, the form uses the US Hire transaction and requires an SSN.
        </Info>

        <ResponseField name="KeyFields" type="object">
          **Key Fields**

          <Expandable title="properties">
            <ResponseField name="CompanyCode" type="single_select">**Company**<br />
            Unified field: `legal_entity_id`</ResponseField>
            <ResponseField name="EffectiveDate" type="date">**Effective Date**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="Personal" type="object">
          **Personal Information**

          <Expandable title="properties">
            <ResponseField name="NameFirst" type="text">**First Name**<br />
            Unified field: `first_name`</ResponseField>
            <ResponseField name="NameLast" type="text">**Last Name**<br />
            Unified field: `last_name`</ResponseField>
            <ResponseField name="NameMiddle" type="text">**Middle Name**</ResponseField>
            <ResponseField name="NamePreferred" type="text">**Preferred Name**</ResponseField>
            <ResponseField name="NameFormer" type="text">**Former Name**</ResponseField>
            <ResponseField name="NamePrefixCode" type="single_select">**Name Prefix**</ResponseField>
            <ResponseField name="NameSuffixCode" type="single_select">**Name Suffix**</ResponseField>
            <ResponseField name="GenderCode" type="single_select">**Gender**<br />
            Unified field: `gender`</ResponseField>
            <ResponseField name="DateOfBirth" type="date">**Date of Birth**<br />
            Unified field: `date_of_birth`</ResponseField>
            <ResponseField name="MaritalStatusCode" type="single_select">**Marital Status**</ResponseField>
            <ResponseField name="PhoneHomeNumber" type="text">**Home Phone**</ResponseField>
            <ResponseField name="PhoneBusinessNumber" type="text">**Business Phone**</ResponseField>
            <ResponseField name="PhoneBusinessExtension" type="text">**Business Phone Extension**</ResponseField>
            <ResponseField name="PhoneOtherNumber" type="text">**Other Phone**</ResponseField>
            <ResponseField name="PhoneOtherTypeCode" type="text">**Other Phone Type**</ResponseField>
            <ResponseField name="AddressEmail" type="text">**Email Address**<br />
            Unified field: `private_email`</ResponseField>
            <ResponseField name="AlternateEmail" type="text">**Alternate Email**</ResponseField>
            <ResponseField name="MailStop" type="text">**Mail Stop**</ResponseField>
            <ResponseField name="PreferredLanguageForPayStatement" type="text">**Preferred Language For Pay Statement**</ResponseField>
            <ResponseField name="EthnicId" type="text">**Ethnic ID**</ResponseField>

            <ResponseField name="Ethnicity" type="text" />

            <ResponseField name="IsAboriginal" type="single_select">**Is Aboriginal**</ResponseField>
            <ResponseField name="IsVisibleMinority" type="single_select">**Is Visible Minority**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="PrimaryAddress" type="object">
          **Primary Address**

          <Expandable title="properties">
            <ResponseField name="AddressLine1" type="text">**Address Line 1**<br />
            Unified field: `home_address.street_1`</ResponseField>
            <ResponseField name="AddressLine2" type="text">**Address Line 2**<br />
            Unified field: `home_address.street_2`</ResponseField>
            <ResponseField name="AddressCity" type="text">**City**<br />
            Unified field: `home_address.city`</ResponseField>
            <ResponseField name="AddressStateCode" type="text">**State/Province**<br />
            Unified field: `home_address.state`</ResponseField>
            <ResponseField name="AddressCountryCode" type="text">**Country**<br />
            Unified field: `home_address.country`</ResponseField>
            <ResponseField name="AddressZipCode" type="text">**Zip/Postal Code**<br />
            Unified field: `home_address.zip_code`</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="Status" type="object">
          **Status Information**

          <Expandable title="properties">
            <ResponseField name="DateOfLastHire" type="date">**Date of Last Hire**<br />
            Unified field: `start_date`</ResponseField>
            <ResponseField name="DateOfOriginalHire" type="date">**Date of Original Hire**</ResponseField>
            <ResponseField name="DateOfSeniority" type="date">**Date of Seniority**</ResponseField>
            <ResponseField name="DateOfBenefitSeniority" type="date">**Date of Benefit Seniority**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="JobInformation" type="object">
          **Job Information**

          <Expandable title="properties">
            <ResponseField name="JobCode" type="single_select">**Job Code**</ResponseField>
            <ResponseField name="LocationCode" type="single_select">**Location Code**<br />
            Unified field: `location_id`</ResponseField>
            <ResponseField name="PayGroup" type="single_select">**Pay Group**</ResponseField>
            <ResponseField name="PayScaleCode" type="single_select">**Pay Scale Code**</ResponseField>
            <ResponseField name="EmployeeTypeCode" type="single_select">**Employee Type**</ResponseField>
            <ResponseField name="FullOrPartTimeCode" type="single_select">**Full or Part Time**</ResponseField>
            <ResponseField name="SalaryOrHourly" type="single_select">**Salary or Hourly**</ResponseField>
            <ResponseField name="HourlyPayRate" type="number">**Hourly Pay Rate**</ResponseField>
            <ResponseField name="AnnualSalary" type="number">**Annual Salary**<br />
            Unified field: `yearly_salary`</ResponseField>
            <ResponseField name="ScheduledWorkHours" type="number">**Scheduled Work Hours**</ResponseField>
            <ResponseField name="SupervisorId" type="single_select">**Supervisor ID**<br />
            References `/v1/hris/employees?remote_model=employee`</ResponseField>
            <ResponseField name="EarningsGroupCode" type="single_select">**Earnings Group Code**</ResponseField>
            <ResponseField name="BenefitGroupCode" type="single_select">**Benefit Group Code**</ResponseField>
            <ResponseField name="JobGrpCode" type="single_select">**Job Group**</ResponseField>
            <ResponseField name="IsAutopaid" type="single_select">**Pay Automatically**</ResponseField>
            <ResponseField name="OrgLevel1Code" type="single_select">**Org Level 1 Code**</ResponseField>
            <ResponseField name="OrgLevel2Code" type="single_select">**Org Level 2 Code**</ResponseField>
            <ResponseField name="OrgLevel3Code" type="single_select">**Org Level 3 Code**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="USTaxes" type="object">
          **US Taxes**

          <Expandable title="properties">
            <ResponseField name="FederalFilingStatusCode" type="text">**Federal Filing Status Code**</ResponseField>
            <ResponseField name="FederalTotalAllowances" type="number">**Federal Total Allowances**</ResponseField>
            <ResponseField name="FederalAdditionalAmountWithheld" type="number">**Federal Additional Amount Withheld**</ResponseField>
            <ResponseField name="FederalDeductionAmount" type="number">**Federal Deduction Amount**</ResponseField>
            <ResponseField name="FederalEmployeeClaimsExemption" type="single_select">**Federal Employee Claims Exemption**</ResponseField>
            <ResponseField name="WorkInStateTaxPlan" type="single_select">**State Unemployment Tax Plan**</ResponseField>
            <ResponseField name="WorkInFilingStatusCode" type="text">**Work In Filing Status Code**</ResponseField>
            <ResponseField name="WorkInTotalAllowancesClaimed" type="number">**Work In Total Allowances Claimed**</ResponseField>
            <ResponseField name="WorkInDeductionAmount" type="number">**Work In Deduction Amount**</ResponseField>
            <ResponseField name="WorkInEmployeeClaimsExemption" type="single_select">**Work In Employee Claims Exemption**</ResponseField>
            <ResponseField name="WorkInAdditionalAmountWithheld" type="number">**Work In Additional Amount Withheld**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="ID" type="object">
          **Identification**

          <Expandable title="properties">
            <ResponseField name="SSN" type="text">**Social Security Number**</ResponseField>
            <ResponseField name="EmployeeNumber" type="text">**Employee Number**</ResponseField>
            <ResponseField name="NationalID" type="text">**National ID**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="PrivateInfo" type="object">
          **Private Information**

          <Expandable title="properties">
            <ResponseField name="BirthCountryCode" type="text">**Birth Country Code**<br />
            Unified field: `nationality`</ResponseField>
            <ResponseField name="BirthLocation" type="text">**Birth Location**</ResponseField>
            <ResponseField name="DisabilityType" type="text">**Disability Type**</ResponseField>
            <ResponseField name="IsVeteran" type="single_select">**Is Veteran**</ResponseField>
            <ResponseField name="IsDisabled" type="single_select">**Is Disabled**</ResponseField>
            <ResponseField name="MilitaryBranchCode" type="single_select">**Military Branch Code**</ResponseField>
            <ResponseField name="MilitaryEraCode" type="single_select">**Military Era Code**</ResponseField>
            <ResponseField name="MilitaryIsDisabledVet" type="single_select">**Is Disabled Veteran**</ResponseField>
            <ResponseField name="MilitaryIsMedalVet" type="single_select">**Is Medal Veteran**</ResponseField>
            <ResponseField name="MilitarySeparationDate" type="date">**Military Separation Date**</ResponseField>
            <ResponseField name="MilitaryIsActiveWartimeVet" type="single_select">**Is Active Wartime Veteran**</ResponseField>
            <ResponseField name="NationalIDExpireDate" type="date">**National ID Expiration Date**</ResponseField>
            <ResponseField name="Nationality1Code" type="text">**Primary Nationality Code**<br />
            Unified field: `nationality`</ResponseField>
            <ResponseField name="Nationality2Code" type="text">**Secondary Nationality Code**</ResponseField>
            <ResponseField name="Nationality3Code" type="text">**Tertiary Nationality Code**</ResponseField>

            <ResponseField name="Smoker" type="single_select" />

            <ResponseField name="WorkPermitCountry" type="text">**Work Permit Country**</ResponseField>
            <ResponseField name="WorkPermitRefID" type="text">**Work Permit Reference ID**</ResponseField>
            <ResponseField name="WorkPermitApplicationDate" type="date">**Work Permit Application Date**</ResponseField>
            <ResponseField name="WorkPermitApprovalDate" type="date">**Work Permit Approval Date**</ResponseField>
            <ResponseField name="WorkPermitExpirationDate" type="date">**Work Permit Expiration Date**</ResponseField>
            <ResponseField name="IsPensioner" type="single_select">**Is Pensioner**</ResponseField>
            <ResponseField name="I9VisaType" type="text">**I9 Visa Type**</ResponseField>
            <ResponseField name="I9ExpirationDate" type="date">**I9 Expiration Date**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="I9" type="object">
          **I-9 Employment Eligibility**

          <Expandable title="properties">
            <ResponseField name="I9VerifiedCode" type="text">**I9 Verified Code**</ResponseField>
            <ResponseField name="I9DocumentNumber" type="text">**I9 Document Number**</ResponseField>
            <ResponseField name="I9ExpirationDate" type="date">**I9 Expiration Date**</ResponseField>
            <ResponseField name="I9DocACode" type="text">**I9 Document A Code**</ResponseField>
            <ResponseField name="I9DocBCode" type="text">**I9 Document B Code**</ResponseField>
            <ResponseField name="I9DocCCode" type="text">**I9 Document C Code**</ResponseField>
            <ResponseField name="I9WorkAuthorization" type="text">**I9 Work Authorization**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="DirectDeposit" type="object">
          **Direct Deposit Information**

          <Expandable title="properties">
            <ResponseField name="DDAccountNumber" type="text">**Account Number**</ResponseField>
            <ResponseField name="DDAccountIsInactive" type="single_select">**Account Is Inactive**</ResponseField>
            <ResponseField name="DDAmountOrPercentage" type="number">**Amount or Percentage**</ResponseField>
            <ResponseField name="DDAccountTypeCode" type="single_select">**Account Type**</ResponseField>
            <ResponseField name="DDRoutingNumber" type="text">**Routing Number**</ResponseField>
            <ResponseField name="DDBankName" type="text">**Bank Name**</ResponseField>
            <ResponseField name="DDDepositRuleCode" type="single_select">**Deposit Rule**</ResponseField>
            <ResponseField name="DDInstitutionNo" type="text">**Institution Number**</ResponseField>
            <ResponseField name="DDIsPreNote" type="single_select">**Is Pre-Note**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="Contacts" type="object">
          **Emergency Contacts & Dependents**

          <Expandable title="properties">
            <ResponseField name="ContactDetail" type="object">
              **Contact Information**

              <Expandable title="properties">
                <ResponseField name="ConNameFirst" type="text">**First Name**</ResponseField>
                <ResponseField name="ConNameLast" type="text">**Last Name**</ResponseField>
                <ResponseField name="ConNameMiddle" type="text">**Middle Name**</ResponseField>
                <ResponseField name="ConNameFormer" type="text">**Former Name**</ResponseField>
                <ResponseField name="ConNameSuffixCode" type="single_select">**Name Suffix**</ResponseField>
                <ResponseField name="ConRelationshipCode" type="single_select">**Relationship Code**</ResponseField>
                <ResponseField name="ConDateOfBirth" type="date">**Date of Birth**</ResponseField>
                <ResponseField name="ConGender" type="single_select">**Gender**</ResponseField>
                <ResponseField name="ConSSN" type="text">**SSN**</ResponseField>
                <ResponseField name="ConNationalID" type="text">**National ID**</ResponseField>
                <ResponseField name="ConIsEmergencyContact" type="single_select">**Is Emergency Contact**</ResponseField>
                <ResponseField name="ConIsDependent" type="single_select">**Is Dependent**</ResponseField>
                <ResponseField name="ConIsBeneficiary" type="single_select">**Is Beneficiary**</ResponseField>
                <ResponseField name="ConIsActive" type="checkbox">**Is Active**</ResponseField>
                <ResponseField name="ConPhoneHomeNumberCountryCode" type="single_select">**Home Phone Country Code**</ResponseField>
                <ResponseField name="ConPhoneHomeNumber" type="text">**Home Phone**</ResponseField>
                <ResponseField name="ConPhoneWorkNumber" type="text">**Work Phone**</ResponseField>
                <ResponseField name="ConPhoneWorkNumberCountryCode" type="single_select">**Work Phone Country Code**</ResponseField>
                <ResponseField name="ConPhoneWorkExtension" type="text">**Work Phone Extension**</ResponseField>
                <ResponseField name="ConPhonePreferred" type="single_select">**Preferred Phone**</ResponseField>
                <ResponseField name="ConEmail" type="text">**Email**</ResponseField>
                <ResponseField name="ConIsDifferentAddress" type="single_select">**Has Different Address**</ResponseField>
                <ResponseField name="ConAddressLine1" type="text">**Address Line 1**</ResponseField>
                <ResponseField name="ConAddressLine2" type="text">**Address Line 2**</ResponseField>
                <ResponseField name="ConAddressCity" type="text">**City**</ResponseField>
                <ResponseField name="ConAddressStateCode" type="text">**State/Province**</ResponseField>
                <ResponseField name="ConAddressCountryCode" type="text">**Country**</ResponseField>
                <ResponseField name="ConAddressZipCode" type="text">**Zip/Postal Code**</ResponseField>
              </Expandable>
            </ResponseField>
          </Expandable>
        </ResponseField>
      </Tab>

      <Tab title="onboarding">
        <Info>
          Some **optional** form fields are referencing the following data models:

          * Employees
          * Legal Entities

          Consider enabling these in your [scope configuration](/hris/features/scopes).
        </Info>

        <Info>
          **Form-specific constraints**

          * Creates a new hire in UKG Onboarding that will go through the onboarding process
        </Info>

        <ResponseField name="contactInformation" type="object">
          **Contact Information**<br />
          Contact information for the new hire

          <Expandable title="properties">
            <ResponseField name="name" type="object">
              **Name**<br />
              The name of the new hire

              <Expandable title="properties">
                <ResponseField name="first" type="text">**First Name**<br />
                The first name of the new hire<br />
                Unified field: `first_name`</ResponseField>
                <ResponseField name="middle" type="text">**Middle Name**<br />
                The middle name of the new hire</ResponseField>
                <ResponseField name="last" type="text">**Last Name**<br />
                The last name of the new hire<br />
                Unified field: `last_name`</ResponseField>
                <ResponseField name="formerLast" type="text">**Former Last Name**<br />
                The former last name of the new hire</ResponseField>
                <ResponseField name="preferredFirst" type="text">**Preferred First Name**<br />
                The preferred first name of the new hire</ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="emailAddress" type="text">**Email Address**<br />
            The email address of the new hire<br />
            Unified field: `private_email`</ResponseField>
            <ResponseField name="primaryPhone" type="text">**Primary Phone**<br />
            The primary phone number of the new hire<br />
            Unified field: `mobile_phone_number`</ResponseField>
            <ResponseField name="secondaryPhone" type="text">**Secondary Phone**<br />
            The secondary phone number of the new hire</ResponseField>

            <ResponseField name="address" type="object">
              **Address**<br />
              The address of the new hire

              <Expandable title="properties">
                <ResponseField name="line1" type="text">**Street 1**<br />
                The street address of the new hire<br />
                Unified field: `home_address.street_1`</ResponseField>
                <ResponseField name="line2" type="text">**Street 2**<br />
                The street address of the new hire<br />
                Unified field: `home_address.street_2`</ResponseField>
                <ResponseField name="city" type="text">**City**<br />
                The city of the new hire<br />
                Unified field: `home_address.city`</ResponseField>
                <ResponseField name="postalCode" type="text">**Postal Code**<br />
                The postal code of the new hire<br />
                Unified field: `home_address.zip_code`</ResponseField>
                <ResponseField name="stateCode" type="text">**State Code**<br />
                The state code of the new hire<br />
                Unified field: `home_address.state`</ResponseField>
                <ResponseField name="country" type="text">**Country**<br />
                The country of the new hire<br />
                Unified field: `home_address.country`</ResponseField>
                <ResponseField name="countryCode" type="single_select">**Country Code**<br />
                ISO country code of the address</ResponseField>
              </Expandable>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="job" type="object">
          **Job**<br />
          The job information for the new hire

          <Expandable title="properties">
            <ResponseField name="code" type="single_select">**Job Code**<br />
            UKG Pro job code<br />
            Unified field: `job_title`</ResponseField>
            <ResponseField name="requisitionId" type="text">**Requisition ID**<br />
            RequisitionId of the job</ResponseField>
            <ResponseField name="componentCompany" type="single_select">**Component Company**<br />
            Component company of the job<br />
            Unified field: `legal_entity_id`<br />
            References `/v1/hris/legal-entities?remote_model=legal_entity`</ResponseField>
            <ResponseField name="workLocation" type="single_select">**Work Location**<br />
            Work location of the job<br />
            Unified field: `location_id`</ResponseField>
            <ResponseField name="supervisor" type="single_select">**Supervisor**<br />
            Supervisor of the job<br />
            References `/v1/hris/employees?remote_model=employee`</ResponseField>
            <ResponseField name="employeeType" type="single_select">**Employee Type**<br />
            Employee type for the job</ResponseField>
            <ResponseField name="selectedFLSAStatus" type="single_select">**Selected FLSA Status**<br />
            Selected FLSA status for the job.</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="organizationLevels" type="object">
          **Organization Levels**<br />
          Organization levels for the new hire

          <Expandable title="properties">
            <ResponseField name="orgLevel1Code" type="single_select">**Organization Level 1**<br />
            Organization level 1 code</ResponseField>
            <ResponseField name="orgLevel2Code" type="single_select">**Organization Level 2**<br />
            Organization level 2 code</ResponseField>
            <ResponseField name="orgLevel3Code" type="single_select">**Organization Level 3**<br />
            Organization level 3 code</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="compensation" type="object">
          **Compensation**<br />
          Compensation information for the new hire

          <Expandable title="properties">
            <ResponseField name="isFullTime" type="checkbox">**Is Full Time**<br />
            Whether the new hire is full time</ResponseField>
            <ResponseField name="isSalaried" type="checkbox">**Is Salaried**<br />
            Whether the new hire is salaried</ResponseField>
            <ResponseField name="workHours" type="number">**Work Hours**<br />
            Work hours of the new hire</ResponseField>
            <ResponseField name="weeklyHours" type="number">**Weekly Hours**<br />
            Weekly hours of the new hire. Only applicable for hires not in US/Canadian companies</ResponseField>
            <ResponseField name="currencyCode" type="text">**Currency Code**<br />
            ISO currency code of the new hire</ResponseField>
            <ResponseField name="payRate" type="number">**Pay Rate**<br />
            Pay rate of the new hire</ResponseField>
            <ResponseField name="ratePer" type="single_select">**Rate Per**<br />
            Pay period of the new hire.</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="onboardingOwnerId" type="text">**Onboarding Owner ID**<br />
        External user identifier of the onboarding owner</ResponseField>
        <ResponseField name="referenceId" type="text">**Reference ID**<br />
        Customer-provided identifier to track the new hire against their own system</ResponseField>
        <ResponseField name="hireDate" type="date">**Hire Date**<br />
        Hire date of the new hire</ResponseField>
        <ResponseField name="orientationDate" type="date">**Orientation Date**<br />
        Orientation date of the new hire</ResponseField>
        <ResponseField name="startDate" type="date">**Start Date**<br />
        Start date of the new hire<br />
        Unified field: `start_date`</ResponseField>
        <ResponseField name="pastStartDateReason" type="text">**Past Start Date Reason**<br />
        Reason why the new hire start date is 4 or more business days in the past</ResponseField>

        <ResponseField name="mentor" type="object">
          **Mentor**<br />
          Mentor for the new hire

          <Expandable title="properties">
            <ResponseField name="code" type="single_select">**Mentor**<br />
            Person from UKG Pro<br />
            References `/v1/hris/employees?remote_model=employee`</ResponseField>
            <ResponseField name="description" type="text">**Mentor Description**<br />
            Brief description of mentor</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="personalMessage" type="text">**Personal Message**<br />
        Personal message for the new hire</ResponseField>
      </Tab>
    </Tabs>
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** UKG Pro

For **UKG Pro**, we also offer the following other connector variants:

<CardGroup>
  <Card title="UKG Pro ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/ukgpro/icon.svg" href="/ats/connectors/ukgpro">
    UKG Pro for the ATS category
  </Card>

  <Card title="UKG Pro Assessment" icon="https://storage.googleapis.com/kombo-assets/integrations/ukgpro/icon.svg" href="/assessment/connectors/ukgpro">
    UKG Pro for the Assessment category
  </Card>
</CardGroup>


# UKG Pro WFM HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/ukgprowfm

UKG Pro WFM connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The UKG Pro WFM HRIS integration allows you to sync HRIS data between UKG Pro WFM and your application through Kombo's unified API. The tool slug for this connector is `ukgprowfm`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/45669441622673-UKG-Pro-WFM-How-do-I-link-my-account">
    Step-by-step instructions to connect your UKG Pro WFM account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      <Note>
        Only employees included in the Hyperfind referenced by the `hyperfind_id` setting are synced. If the Hyperfind is misconfigured (e.g., excludes inactive or terminated employees, filters by labor category, etc.), those employees will not appear in Kombo.
      </Note>

      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | gender                |       |
      | employment\_status    |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Timesheets">
      | Field                  | Notes |
      | ---------------------- | ----- |
      | id                     |       |
      | remote\_id             |       |
      | changed\_at            |       |
      | remote\_deleted\_at    |       |
      | employee\_id           |       |
      | started\_at            |       |
      | ended\_at              |       |
      | timezone               |       |
      | payable\_hours         |       |
      | unpaid\_break\_minutes |       |
      | breaks                 |       |
      | approval\_status       |       |
      | approved\_at           |       |
      | remote\_data           |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | API Passthrough  |       |
    | Connection Guide |       |
    | Group Types      |       |
    | TEAM             |       |
    | DEPARTMENT       |       |
    | COST\_CENTER     |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Info>
      Some **optional** form fields are referencing the following data models:

      * Employees

      Consider enabling these in your [scope configuration](/hris/features/scopes).
    </Info>

    <ResponseField name="personInformation" type="object">
      **Person Information**<br />
      Identity, contact details, access assignment, and product licenses for the new employee.

      <Expandable title="properties">
        <ResponseField name="person" type="object">
          **Person**

          <Expandable title="properties">
            <ResponseField name="personNumber" type="text">**Employee ID**<br />
            The employee identifier in UKG Pro WFM. Leave blank to auto-generate.</ResponseField>
            <ResponseField name="firstName" type="text">**First Name**<br />
            The first name of the employee<br />
            Unified field: `first_name`</ResponseField>
            <ResponseField name="lastName" type="text">**Last Name**<br />
            The last name of the employee<br />
            Unified field: `last_name`</ResponseField>
            <ResponseField name="middleInitial" type="text">**Middle Initial**</ResponseField>
            <ResponseField name="shortName" type="text">**Short Name**<br />
            A short display name. Defaults to the first name in most UKG configurations.</ResponseField>
            <ResponseField name="hireDate" type="date">**Start Date**<br />
            Also used as the effective date for employment status, primary labor account, badge assignment, and base wage (unless overridden).<br />
            Unified field: `start_date`</ResponseField>
            <ResponseField name="birthDate" type="date">**Date of Birth**<br />
            The employee's date of birth<br />
            Unified field: `date_of_birth`</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="emailAddresses" type="object">
          **Email Addresses**

          <Expandable title="properties">
            <ResponseField name="workEmail" type="text">**Work Email**<br />
            The email address of the employee<br />
            Unified field: `work_email`</ResponseField>
            <ResponseField name="homeEmail" type="text">**Private Email**<br />
            The private email address of the employee<br />
            Unified field: `private_email`</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="telephoneNumbers" type="object">
          **Telephone Numbers**

          <Expandable title="properties">
            <ResponseField name="mobilePhoneNumber" type="text">**Mobile Phone Number**<br />
            The mobile phone number of the employee<br />
            Unified field: `mobile_phone_number`</ResponseField>
            <ResponseField name="workPhoneNumber" type="text">**Work Phone Number**<br />
            The work phone number of the employee.</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="postalAddresses" type="object">
          **Postal Address**

          <Expandable title="properties">
            <ResponseField name="street" type="text">**Street 1**<br />
            The street address of the employee<br />
            Unified field: `home_address.street_1`</ResponseField>
            <ResponseField name="city" type="text">**City**<br />
            The city of the employee<br />
            Unified field: `home_address.city`</ResponseField>
            <ResponseField name="state" type="text">**State**<br />
            The state of the employee<br />
            Unified field: `home_address.state`</ResponseField>
            <ResponseField name="postalCode" type="text">**ZIP Code**<br />
            The ZIP code of the employee<br />
            Unified field: `home_address.zip_code`</ResponseField>
            <ResponseField name="country" type="text">**Country**<br />
            The uppercase two-letter ISO country (e.g., DE)<br />
            Unified field: `home_address.country`</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="accessAssignment" type="object">
          **Access Assignment**

          <Expandable title="properties">
            <ResponseField name="accessProfileName" type="single_select">**Function Access Profile**<br />
            Controls the employee's system access and permissions.</ResponseField>
            <ResponseField name="employeeLaborCategoryProfileName" type="single_select">**Labor Category Profile**<br />
            Controls which labor categories the employee can select.</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="personLicenseTypes" type="multi_select">**Product Licenses**<br />
        UKG product licenses to assign (e.g. "Hourly Timekeeping", "Analytics").</ResponseField>
        <ResponseField name="badgeAssignments" type="text">**Badge Number**<br />
        Used for time clock identification.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="jobAssignment" type="object">
      **Job Assignment**<br />
      Job details, primary labor account, and base wage for the new employee.

      <Expandable title="properties">
        <ResponseField name="jobAssignmentDetails" type="object">
          **Details**

          <Expandable title="properties">
            <ResponseField name="payRuleName" type="single_select">**Pay Rule**<br />
            The pay rule for timekeeping.</ResponseField>
            <ResponseField name="timeZoneName" type="single_select">**Time Zone**<br />
            The time zone for the employee's job assignment.</ResponseField>
            <ResponseField name="supervisorPersonNumber" type="single_select">**Supervisor**<br />
            The employee's direct supervisor.<br />
            References `/v1/hris/employees?remote_model=employee`</ResponseField>
            <ResponseField name="workerTypeName" type="single_select">**Employee Type**<br />
            The worker type as configured in UKG.</ResponseField>
            <ResponseField name="deviceGroupName" type="single_select">**Device Group**<br />
            The device group for time clock access.</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="organizationPath" type="single_select">**Organization Path**<br />
        Full organizational path for the primary labor account.</ResponseField>

        <ResponseField name="primaryLaborCategory" type="object">
          **Primary Labor Category**<br />
          Optional per-category labor entries appended to the primary labor account.

          <Expandable title="properties">
            <ResponseField name="level1" type="single_select">**Labor Category 1**</ResponseField>
            <ResponseField name="level2" type="single_select">**Labor Category 2**</ResponseField>
            <ResponseField name="level3" type="single_select">**Labor Category 3**</ResponseField>
            <ResponseField name="level4" type="single_select">**Labor Category 4**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="scheduleGroupName" type="single_select">**Schedule Group**<br />
        The employee's schedule group assignment.</ResponseField>

        <ResponseField name="baseWage" type="object">
          **Hourly Wage**<br />
          Optional hourly wage assignment for the new employee.

          <Expandable title="properties">
            <ResponseField name="rate" type="number">**Rate**<br />
            Hourly wage rate. Leave blank to skip the wage assignment.</ResponseField>
            <ResponseField name="effectiveDate" type="date">**Effective Date**<br />
            Only applied when Rate is set. Defaults to the hire date.</ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="user" type="object">
      **User Account**<br />
      Login credentials for the new employee.

      <Expandable title="properties">
        <ResponseField name="userAccount" type="object">
          **Account**

          <Expandable title="properties">
            <ResponseField name="userName" type="text">**Username**<br />
            The UKG login username for the new account.</ResponseField>
            <ResponseField name="userPassword" type="text">**Password**<br />
            A temporary password for the new account (min. 8 characters). Required unless the user is clock-only.</ResponseField>
            <ResponseField name="clockOnlyUser" type="checkbox">**Clock-only user**<br />
            Create a device/clock-only account with no password. UKG only allows this with Basic authentication.</ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Tab>
</Tabs>


# UKG Ready HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/ukgready

UKG Ready connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The UKG Ready HRIS integration allows you to sync HRIS data between UKG Ready and your application through Kombo's unified API. The tool slug for this connector is `ukgready`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/34023007262353-UKG-Ready-How-do-I-link-my-account">
    Step-by-step instructions to connect your UKG Ready account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes                                                      |
      | --------------------- | ---------------------------------------------------------- |
      | id                    |                                                            |
      | remote\_id            |                                                            |
      | changed\_at           |                                                            |
      | remote\_deleted\_at   |                                                            |
      | employee\_number      |                                                            |
      | first\_name           |                                                            |
      | last\_name            |                                                            |
      | display\_full\_name   |                                                            |
      | work\_email           |                                                            |
      | personal\_email       | The personal email is not exposed via the API.             |
      | mobile\_phone\_number |                                                            |
      | ssn                   |                                                            |
      | gender                |                                                            |
      | ethnicity             |                                                            |
      | employment\_status    |                                                            |
      | employment\_type      |                                                            |
      | weekly\_hours         | Calculated by multiplying "standard\_work\_day" by 5 days. |
      | avatar                |                                                            |
      | work\_location\_id    |                                                            |
      | legal\_entity\_id     |                                                            |
      | manager\_id           |                                                            |
      | home\_address         |                                                            |
      | date\_of\_birth       |                                                            |
      | start\_date           |                                                            |
      | termination\_date     |                                                            |
      | custom\_fields        |                                                            |
      | integration\_fields   |                                                            |
      | remote\_data          |                                                            |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | name                    |       |
      | unit                    |       |
      | half\_days\_supported   |       |
      | exact\_times\_supported |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_time         |       |
      | end\_time           |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | parent\_id          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Timesheets">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | started\_at         |       |
      | ended\_at           |       |
      | timezone            |       |
      | payable\_hours      |       |
      | approval\_status    |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | API Passthrough       |       |
    | Scope Testing         |       |
    | Per Model Tests       |       |
    | Delta Syncs           |       |
    | Custom Field Explorer |       |
    | Employees             |       |
    | Connection Guide      |       |
    | Group Types           |       |
    | COST\_CENTER          |       |
  </Tab>

  <Tab title="Create Employee with Form">
    This integration supports multiple employee creation forms for different use cases:

    <Tabs>
      <Tab title="import-tool">
        <ResponseField name="username" type="text">**Username**<br />
        Username for the employee. If not provided, a random value is generated.</ResponseField>
        <ResponseField name="external_id" type="text">**External Id**</ResponseField>
        <ResponseField name="new_employee_id" type="text">**New Employee Id**</ResponseField>
        <ResponseField name="badge_id" type="text">**Badge Id**</ResponseField>
        <ResponseField name="badge_id_2" type="text">**Badge Id 2**</ResponseField>
        <ResponseField name="badge_id_3" type="text">**Badge Id 3**</ResponseField>
        <ResponseField name="ein_tax_id" type="text">**EIN Tax Id**</ResponseField>
        <ResponseField name="ein_name" type="text">**EIN Name**</ResponseField>
        <ResponseField name="primary_ein" type="single_select">**Primary EIN**<br />
        Set to "Y" to mark this EIN as primary for the employee</ResponseField>
        <ResponseField name="employee_sync" type="text">**Employee Sync**</ResponseField>
        <ResponseField name="salutation" type="text">**Salutation**</ResponseField>
        <ResponseField name="first_name" type="text">**First Name**<br />
        Maximum 75 characters<br />
        Unified field: `first_name`</ResponseField>
        <ResponseField name="middle_initial" type="text">**Middle Initial**</ResponseField>
        <ResponseField name="last_name" type="text">**Last Name**<br />
        The last name of the employee<br />
        Unified field: `last_name`</ResponseField>
        <ResponseField name="nick_name" type="text">**Nick Name**</ResponseField>
        <ResponseField name="social_security" type="text">**Social Security**<br />
        Valid format: 111-11-1111</ResponseField>
        <ResponseField name="allow_change_to_social_security" type="single_select">**Allow Change To Social Security**<br />
        Setting value to "Y" allows changing Social Security Number</ResponseField>
        <ResponseField name="social_insurance_number" type="text">**Social Insurance Number**<br />
        Available only for Canada companies. Valid formats: 111-111-111 or 111111111</ResponseField>
        <ResponseField name="primary_national_id_type" type="text">**Primary National ID Type**</ResponseField>
        <ResponseField name="tax_file_number" type="text">**Tax File Number**<br />
        Available only for Australian companies. 8 digits</ResponseField>
        <ResponseField name="social_security_number_france" type="text">**Social Security Number (France)**<br />
        National ID number for France. Available only for French companies. 13-15 digits</ResponseField>
        <ResponseField name="primary_email" type="text">**Private Email**<br />
        The private email address of the employee<br />
        Unified field: `private_email`</ResponseField>
        <ResponseField name="secondary_email" type="text">**Secondary Email**</ResponseField>
        <ResponseField name="personal_email" type="text">**Personal Email**</ResponseField>
        <ResponseField name="security_question" type="text">**Security Question**</ResponseField>
        <ResponseField name="security_question_answer" type="text">**Security Question Answer**</ResponseField>
        <ResponseField name="disable_only_login_using_sso" type="text">**Disable Only Login Using SSO**<br />
        Maximum 25 characters</ResponseField>
        <ResponseField name="locale" type="text">**Locale**</ResponseField>
        <ResponseField name="home_phone" type="text">**Home Phone**</ResponseField>
        <ResponseField name="work_phone" type="text">**Work Phone**</ResponseField>
        <ResponseField name="cell_phone" type="text">**Cell Phone**<br />
        The mobile phone number of the employee<br />
        Unified field: `mobile_phone_number`</ResponseField>
        <ResponseField name="primary_phone" type="single_select">**Primary Phone**<br />
        Valid Values: Home Phone, Work Phone, Cell Phone. Abbreviations H, W, C will also be accepted.</ResponseField>
        <ResponseField name="address_1" type="text">**Address 1**<br />
        The street address of the employee<br />
        Unified field: `home_address.street_1`</ResponseField>
        <ResponseField name="address_2" type="text">**Address 2**<br />
        Alternative address <br />
        Unified field: `home_address.street_2`</ResponseField>
        <ResponseField name="address_3" type="text">**Address 3**<br />
        Alternative address </ResponseField>
        <ResponseField name="city" type="text">**City**<br />
        Maximum 25 characters<br />
        Unified field: `home_address.city`</ResponseField>
        <ResponseField name="state" type="text">**State**<br />
        Two character state code (e.g., NJ for New Jersey) or NA for non-USA<br />
        Unified field: `home_address.state`</ResponseField>
        <ResponseField name="zip" type="text">**Zip**<br />
        Valid formats: 11111 or 11111-1111<br />
        Unified field: `home_address.zip_code`</ResponseField>
        <ResponseField name="country" type="text">**Country**<br />
        The uppercase two-letter ISO country (e.g., DE)<br />
        Unified field: `home_address.country`</ResponseField>
        <ResponseField name="address_latitude" type="text">**Address Latitude**</ResponseField>
        <ResponseField name="address_longitude" type="text">**Address Longitude**</ResponseField>
        <ResponseField name="status" type="text">**Status**</ResponseField>
        <ResponseField name="status_external_id" type="text">**Status External Id**</ResponseField>
        <ResponseField name="employee_type" type="text">**Employee Type**</ResponseField>
        <ResponseField name="standard_work_day" type="text">**Standard Work Day**<br />
        Length of standard work day in HH:MM or HH.00 format (e.g., 8:00 or 8.00)</ResponseField>
        <ResponseField name="pay_type" type="text">**Pay Type**</ResponseField>
        <ResponseField name="pay_type_external_id" type="text">**Pay Type External Id**</ResponseField>
        <ResponseField name="default_shift" type="text">**Default Shift**</ResponseField>
        <ResponseField name="medical_eligibility" type="single_select">**Medical Eligibility**</ResponseField>
        <ResponseField name="dental_eligibility" type="single_select">**Dental Eligibility**</ResponseField>
        <ResponseField name="dependent_benefits_eligibility" type="single_select">**Dependent Benefits Eligibility**</ResponseField>
        <ResponseField name="union" type="text">**Union**</ResponseField>
        <ResponseField name="pay_grade" type="text">**Pay Grade**</ResponseField>
        <ResponseField name="step" type="text">**Step**</ResponseField>
        <ResponseField name="hired" type="date">**Hired**<br />
        Start date of the employee. Also considered to be the hire date<br />
        Unified field: `start_date`</ResponseField>
        <ResponseField name="started" type="date">**Started**</ResponseField>
        <ResponseField name="birthday" type="date">**Birthday**<br />
        The employee's date of birth<br />
        Unified field: `date_of_birth`</ResponseField>
        <ResponseField name="review" type="date">**Review**</ResponseField>
        <ResponseField name="seniority" type="date">**Seniority**</ResponseField>
        <ResponseField name="benefits" type="date">**Benefits**</ResponseField>
        <ResponseField name="terminated" type="date">**Terminated**<br />
        REQUIRED if employee has been terminated</ResponseField>
        <ResponseField name="re_hired" type="date">**Re Hired**</ResponseField>
        <ResponseField name="frozen_benefit" type="date">**Frozen Benefit**</ResponseField>
        <ResponseField name="retirement" type="date">**Retirement**</ResponseField>
        <ResponseField name="custom_date_1" type="date">**Custom Date 1**</ResponseField>
        <ResponseField name="custom_date_2" type="date">**Custom Date 2**</ResponseField>
        <ResponseField name="custom_date_3" type="date">**Custom Date 3**</ResponseField>
        <ResponseField name="custom_date_4" type="date">**Custom Date 4**</ResponseField>
        <ResponseField name="custom_date_5" type="date">**Custom Date 5**</ResponseField>
        <ResponseField name="time_zone" type="text">**Time Zone**</ResponseField>
        <ResponseField name="first_screen" type="text">**First Screen**</ResponseField>
        <ResponseField name="root_cost_center_1" type="text">**Root Cost Center 1**</ResponseField>
        <ResponseField name="root_cost_center_1_effective_from" type="date">**Root Cost Center 1 Effective From**</ResponseField>
        <ResponseField name="root_cost_center_2" type="text">**Root Cost Center 2**</ResponseField>
        <ResponseField name="root_cost_center_2_effective_from" type="date">**Root Cost Center 2 Effective From**</ResponseField>
        <ResponseField name="root_cost_center_3" type="text">**Root Cost Center 3**</ResponseField>
        <ResponseField name="root_cost_center_3_effective_from" type="date">**Root Cost Center 3 Effective From**</ResponseField>
        <ResponseField name="root_cost_center_4" type="text">**Root Cost Center 4**</ResponseField>
        <ResponseField name="root_cost_center_4_effective_from" type="date">**Root Cost Center 4 Effective From**</ResponseField>
        <ResponseField name="root_cost_center_5" type="text">**Root Cost Center 5**</ResponseField>
        <ResponseField name="root_cost_center_5_effective_from" type="date">**Root Cost Center 5 Effective From**</ResponseField>
        <ResponseField name="root_cost_center_6" type="text">**Root Cost Center 6**</ResponseField>
        <ResponseField name="root_cost_center_6_effective_from" type="date">**Root Cost Center 6 Effective From**</ResponseField>
        <ResponseField name="root_cost_center_7" type="text">**Root Cost Center 7**</ResponseField>
        <ResponseField name="root_cost_center_7_effective_from" type="date">**Root Cost Center 7 Effective From**</ResponseField>
        <ResponseField name="root_cost_center_8" type="text">**Root Cost Center 8**</ResponseField>
        <ResponseField name="root_cost_center_8_effective_from" type="date">**Root Cost Center 8 Effective From**</ResponseField>
        <ResponseField name="root_cost_center_9" type="text">**Root Cost Center 9**</ResponseField>
        <ResponseField name="root_cost_center_9_effective_from" type="date">**Root Cost Center 9 Effective From**</ResponseField>
        <ResponseField name="root_cost_center_10" type="text">**Root Cost Center 10**</ResponseField>
        <ResponseField name="root_cost_center_10_effective_from" type="date">**Root Cost Center 10 Effective From**</ResponseField>
        <ResponseField name="limit_cost_center_list_1" type="text">**Limit Cost Center List 1**</ResponseField>
        <ResponseField name="limit_cost_center_list_1_effective_from" type="date">**Limit Cost Center List 1 Effective From**</ResponseField>
        <ResponseField name="limit_cost_center_list_2" type="text">**Limit Cost Center List 2**</ResponseField>
        <ResponseField name="limit_cost_center_list_2_effective_from" type="date">**Limit Cost Center List 2 Effective From**</ResponseField>
        <ResponseField name="limit_cost_center_list_3" type="text">**Limit Cost Center List 3**</ResponseField>
        <ResponseField name="limit_cost_center_list_3_effective_from" type="date">**Limit Cost Center List 3 Effective From**</ResponseField>
        <ResponseField name="limit_cost_center_list_4" type="text">**Limit Cost Center List 4**</ResponseField>
        <ResponseField name="limit_cost_center_list_4_effective_from" type="date">**Limit Cost Center List 4 Effective From**</ResponseField>
        <ResponseField name="limit_cost_center_list_5" type="text">**Limit Cost Center List 5**</ResponseField>
        <ResponseField name="limit_cost_center_list_5_effective_from" type="date">**Limit Cost Center List 5 Effective From**</ResponseField>
        <ResponseField name="limit_cost_center_list_6" type="text">**Limit Cost Center List 6**</ResponseField>
        <ResponseField name="limit_cost_center_list_6_effective_from" type="date">**Limit Cost Center List 6 Effective From**</ResponseField>
        <ResponseField name="limit_cost_center_list_7" type="text">**Limit Cost Center List 7**</ResponseField>
        <ResponseField name="limit_cost_center_list_7_effective_from" type="date">**Limit Cost Center List 7 Effective From**</ResponseField>
        <ResponseField name="limit_cost_center_list_8" type="text">**Limit Cost Center List 8**</ResponseField>
        <ResponseField name="limit_cost_center_list_8_effective_from" type="date">**Limit Cost Center List 8 Effective From**</ResponseField>
        <ResponseField name="limit_cost_center_list_9" type="text">**Limit Cost Center List 9**</ResponseField>
        <ResponseField name="limit_cost_center_list_9_effective_from" type="date">**Limit Cost Center List 9 Effective From**</ResponseField>
        <ResponseField name="limit_cost_center_list_10" type="text">**Limit Cost Center List 10**</ResponseField>
        <ResponseField name="limit_cost_center_list_10_effective_from" type="date">**Limit Cost Center List 10 Effective From**</ResponseField>
        <ResponseField name="default_cost_center_1" type="text">**Default Cost Center 1**</ResponseField>
        <ResponseField name="default_cost_center_2" type="text">**Default Cost Center 2**</ResponseField>
        <ResponseField name="default_cost_center_3" type="text">**Default Cost Center 3**</ResponseField>
        <ResponseField name="default_cost_center_4" type="text">**Default Cost Center 4**</ResponseField>
        <ResponseField name="default_cost_center_5" type="text">**Default Cost Center 5**</ResponseField>
        <ResponseField name="default_cost_center_6" type="text">**Default Cost Center 6**</ResponseField>
        <ResponseField name="default_cost_center_7" type="text">**Default Cost Center 7**</ResponseField>
        <ResponseField name="default_cost_center_8" type="text">**Default Cost Center 8**</ResponseField>
        <ResponseField name="default_cost_center_9" type="text">**Default Cost Center 9**</ResponseField>
        <ResponseField name="default_cost_center_10" type="text">**Default Cost Center 10**</ResponseField>
        <ResponseField name="job_last_changed" type="date">**Job Last Changed**</ResponseField>
        <ResponseField name="access" type="text">**Access**</ResponseField>
        <ResponseField name="access_on_new_only" type="single_select">**Access On New Only**</ResponseField>
        <ResponseField name="accruals" type="text">**Accruals**</ResponseField>
        <ResponseField name="accruals_profile_effective_from" type="date">**Accruals Profile Effective From**</ResponseField>
        <ResponseField name="accruals_on_new_only" type="single_select">**Accruals On New Only**</ResponseField>
        <ResponseField name="attestation_profile" type="text">**Attestation Profile**</ResponseField>
        <ResponseField name="attestation_profile_effective_from" type="date">**Attestation Profile Effective From**</ResponseField>
        <ResponseField name="attestation_profile_on_new_only" type="single_select">**Attestation Profile On New Only**</ResponseField>
        <ResponseField name="beacon_mo_profile" type="text">**Beacon (Mo) Profile**</ResponseField>
        <ResponseField name="beacon_mo_profile_on_new_only" type="single_select">**Beacon (Mo) Profile On New Only**</ResponseField>
        <ResponseField name="benefit_profile" type="text">**Benefit Profile**</ResponseField>
        <ResponseField name="benefit_profile_effective_from" type="date">**Benefit Profile Effective From**</ResponseField>
        <ResponseField name="benefit_profile_on_new_only" type="single_select">**Benefit Profile On New Only**</ResponseField>
        <ResponseField name="competency_profile" type="text">**Competency Profile**</ResponseField>
        <ResponseField name="competency_profile_on_new_only" type="single_select">**Competency Profile On New Only**</ResponseField>
        <ResponseField name="counter_distribution_profile" type="text">**Counter Distribution Profile**</ResponseField>
        <ResponseField name="counter_distribution_profile_effective_from" type="date">**Counter Distribution Profile Effective From**</ResponseField>
        <ResponseField name="counter_distribution_profile_on_new_only" type="single_select">**Counter Distribution Profile On New Only**</ResponseField>
        <ResponseField name="dashboard_layout_profile" type="text">**Dashboard Layout Profile**</ResponseField>
        <ResponseField name="dashboard_layout_profile_effective_from" type="date">**Dashboard Layout Profile Effective From**</ResponseField>
        <ResponseField name="dashboard_layout_profile_on_new_only" type="single_select">**Dashboard Layout Profile On New Only**</ResponseField>
        <ResponseField name="holiday" type="text">**Holiday**</ResponseField>
        <ResponseField name="holiday_on_new_only" type="single_select">**Holiday On New Only**</ResponseField>
        <ResponseField name="intouch_schedule_restrictions_profile" type="text">**InTouch Schedule Restrictions Profile**</ResponseField>
        <ResponseField name="intouch_schedule_restrictions_profile_on_new_only" type="single_select">**InTouch Schedule Restrictions Profile On New Only**</ResponseField>
        <ResponseField name="labor_distribution_profile" type="text">**Labor Distribution Profile**</ResponseField>
        <ResponseField name="labor_distribution_profile_on_new_only" type="single_select">**Labor Distribution Profile On New Only**</ResponseField>
        <ResponseField name="onboarding_profile" type="text">**Onboarding Profile**</ResponseField>
        <ResponseField name="onboarding_profile_on_new_only" type="single_select">**Onboarding Profile On New Only**</ResponseField>
        <ResponseField name="pay_calculations" type="text">**Pay Calculations**</ResponseField>
        <ResponseField name="pay_calculations_profile_effective_from" type="date">**Pay Calculations Profile Effective From**</ResponseField>
        <ResponseField name="pay_calculations_on_new_only" type="single_select">**Pay Calculations On New Only**</ResponseField>
        <ResponseField name="pay_period" type="text">**Pay Period**</ResponseField>
        <ResponseField name="pay_period_on_new_only" type="single_select">**Pay Period On New Only**</ResponseField>
        <ResponseField name="pay_prep" type="text">**Pay Prep**</ResponseField>
        <ResponseField name="pay_prep_on_new_only" type="single_select">**Pay Prep On New Only**</ResponseField>
        <ResponseField name="points_profile" type="text">**Points Profile**</ResponseField>
        <ResponseField name="points_profile_on_new_only" type="single_select">**Points Profile On New Only**</ResponseField>
        <ResponseField name="pst_delivery_policy" type="text">**PST Delivery Policy**</ResponseField>
        <ResponseField name="pst_delivery_policy_on_new_only" type="single_select">**PST Delivery Policy On New Only**</ResponseField>
        <ResponseField name="pst_population_profile" type="text">**PST Population Profile**</ResponseField>
        <ResponseField name="pst_population_profile_on_new_only" type="single_select">**PST Population Profile On New Only**</ResponseField>
        <ResponseField name="retirement_plan" type="text">**Retirement Plan**</ResponseField>
        <ResponseField name="retirement_plan_on_new_only" type="single_select">**Retirement Plan On New Only**</ResponseField>
        <ResponseField name="role" type="text">**Role**</ResponseField>
        <ResponseField name="role_on_new_only" type="single_select">**Role On New Only**</ResponseField>
        <ResponseField name="second_retirement_plan" type="text">**Second Retirement Plan**</ResponseField>
        <ResponseField name="second_retirement_plan_on_new_only" type="single_select">**Second Retirement Plan On New Only**</ResponseField>
        <ResponseField name="employee_perspectives_profile" type="text">**Employee Perspectives Profile**</ResponseField>
        <ResponseField name="employee_perspectives_profile_effective_from" type="date">**Employee Perspectives Profile Effective From**</ResponseField>
        <ResponseField name="employee_perspectives_profile_on_new_only" type="single_select">**Employee Perspectives Profile On New Only**</ResponseField>
        <ResponseField name="work_schedule" type="text">**Work Schedule**</ResponseField>
        <ResponseField name="work_schedule_start_pattern_on" type="date">**Work Schedule Start Pattern On**</ResponseField>
        <ResponseField name="work_schedule_start_pattern_type" type="single_select">**Work Schedule Start Pattern Type**<br />
        REQUIRED if "Schedule Pattern On" is specified. Default Value - "Day" is set if empty or CLEAR.</ResponseField>
        <ResponseField name="work_schedule_on_new_only" type="single_select">**Work Schedule On New Only**</ResponseField>
        <ResponseField name="scheduler" type="text">**Scheduler**</ResponseField>
        <ResponseField name="scheduler_on_new_only" type="single_select">**Scheduler On New Only**</ResponseField>
        <ResponseField name="security" type="text">**Security**</ResponseField>
        <ResponseField name="security_on_new_only" type="single_select">**Security On New Only**</ResponseField>
        <ResponseField name="timesheet" type="text">**Timesheet**</ResponseField>
        <ResponseField name="timesheet_on_new_only" type="single_select">**Timesheet On New Only**</ResponseField>
        <ResponseField name="timesheet_autopopulate" type="text">**Timesheet Autopopulate**</ResponseField>
        <ResponseField name="timesheet_autopopulate_on_new_only" type="single_select">**Timesheet Autopopulate On New Only**</ResponseField>
        <ResponseField name="training_profile" type="text">**Training Profile**</ResponseField>
        <ResponseField name="training_profile_on_new_only" type="single_select">**Training Profile On New Only**</ResponseField>
        <ResponseField name="performance_review_profile" type="text">**Performance Review Profile**</ResponseField>
        <ResponseField name="performance_review_profile_on_new_only" type="single_select">**Performance Review Profile On New Only**</ResponseField>
        <ResponseField name="w2_delivery_policy" type="text">**W2 Delivery Policy**</ResponseField>
        <ResponseField name="w2_delivery_policy_on_new_only" type="single_select">**W2 Delivery Policy On New Only**</ResponseField>
        <ResponseField name="workday_breakdown" type="text">**Workday Breakdown**</ResponseField>
        <ResponseField name="workday_breakdown_profile_effective_from" type="date">**Workday Breakdown Profile Effective From**</ResponseField>
        <ResponseField name="workday_breakdown_on_new_only" type="single_select">**Workday Breakdown On New Only**</ResponseField>
        <ResponseField name="working_time_regulations" type="text">**Working Time Regulations**</ResponseField>
        <ResponseField name="expense_tracking_profile_on_new_only" type="single_select">**Expense Tracking Profile On New Only**</ResponseField>
        <ResponseField name="expense_tracking_profile" type="text">**Expense Tracking Profile**</ResponseField>
        <ResponseField name="data_retention_profile" type="text">**Data Retention Profile**</ResponseField>
        <ResponseField name="data_retention_profile_effective_from" type="date">**Data Retention Profile Effective From**</ResponseField>
        <ResponseField name="data_retention_profile_on_new_only" type="single_select">**Data Retention Profile On New Only**</ResponseField>
        <ResponseField name="hardware_rsi_hand_template" type="text">**Hardware RSI Hand Template**</ResponseField>
        <ResponseField name="hardware_asher_pin" type="text">**Hardware Asher PIN**</ResponseField>
        <ResponseField name="hardware_zk_password" type="text">**Hardware ZK Password**</ResponseField>
        <ResponseField name="hardware_ats_pin" type="text">**Hardware ATS PIN**</ResponseField>
        <ResponseField name="hardware_ats_security_level" type="text">**Hardware ATS Security Level**</ResponseField>
        <ResponseField name="hardware_intouch_pin" type="text">**Hardware InTouch PIN**</ResponseField>
        <ResponseField name="hardware_intouch_security_level" type="single_select">**Hardware InTouch Security Level**</ResponseField>
        <ResponseField name="gender" type="single_select">**Gender**<br />
        The gender of the employee<br />
        Unified field: `gender`</ResponseField>
        <ResponseField name="eye_color" type="text">**Eye Color**</ResponseField>
        <ResponseField name="height" type="text">**Height**</ResponseField>
        <ResponseField name="disability" type="single_select">**Disability**</ResponseField>
        <ResponseField name="citizenship" type="single_select">**Citizenship**</ResponseField>
        <ResponseField name="ethnicity" type="single_select">**Ethnicity**</ResponseField>
        <ResponseField name="eeo_classification" type="single_select">**EEO Classification**</ResponseField>
        <ResponseField name="eeo_4_classification" type="single_select">**EEO-4 Classification**</ResponseField>
        <ResponseField name="eeo_4_function" type="single_select">**EEO-4 Function**</ResponseField>
        <ResponseField name="primary_language" type="text">**Primary Language**</ResponseField>
        <ResponseField name="secondary_language" type="text">**Secondary Language**</ResponseField>
        <ResponseField name="smoker" type="single_select">**Smoker**</ResponseField>
        <ResponseField name="seasonal" type="single_select">**Seasonal**</ResponseField>
        <ResponseField name="ft_student" type="single_select">**FT Student**</ResponseField>
        <ResponseField name="referral" type="text">**Referral**</ResponseField>
        <ResponseField name="visa_type" type="single_select">**Visa Type**</ResponseField>
        <ResponseField name="recruiter" type="text">**Recruiter**</ResponseField>
        <ResponseField name="worker_type" type="text">**Worker Type**</ResponseField>
        <ResponseField name="manager_1" type="text">**Manager 1**</ResponseField>
        <ResponseField name="manager_1_ein_tax_id" type="text">**Manager 1 EIN Tax Id**</ResponseField>
        <ResponseField name="manager_1_ein_name" type="text">**Manager 1 EIN Name**</ResponseField>
        <ResponseField name="manager_2" type="text">**Manager 2**</ResponseField>
        <ResponseField name="manager_2_ein_tax_id" type="text">**Manager 2 EIN Tax Id**</ResponseField>
        <ResponseField name="manager_2_ein_name" type="text">**Manager 2 EIN Name**</ResponseField>
        <ResponseField name="manager_3" type="text">**Manager 3**</ResponseField>
        <ResponseField name="manager_3_ein_tax_id" type="text">**Manager 3 EIN Tax Id**</ResponseField>
        <ResponseField name="manager_3_ein_name" type="text">**Manager 3 EIN Name**</ResponseField>
        <ResponseField name="manager_4" type="text">**Manager 4**</ResponseField>
        <ResponseField name="manager_4_ein_tax_id" type="text">**Manager 4 EIN Tax Id**</ResponseField>
        <ResponseField name="manager_4_ein_name" type="text">**Manager 4 EIN Name**</ResponseField>
        <ResponseField name="manager_5" type="text">**Manager 5**</ResponseField>
        <ResponseField name="manager_5_ein_tax_id" type="text">**Manager 5 EIN Tax Id**</ResponseField>
        <ResponseField name="manager_5_ein_name" type="text">**Manager 5 EIN Name**</ResponseField>
        <ResponseField name="manager_6" type="text">**Manager 6**</ResponseField>
        <ResponseField name="manager_6_ein_tax_id" type="text">**Manager 6 EIN Tax Id**</ResponseField>
        <ResponseField name="manager_6_ein_name" type="text">**Manager 6 EIN Name**</ResponseField>
        <ResponseField name="managed_cost_centers_enabled" type="single_select">**Managed Cost Centers Enabled**</ResponseField>
        <ResponseField name="managed_cost_centers_allow_save_of_other_cost_centers" type="single_select">**Managed Cost Centers Allow Save Of Other Cost Centers**</ResponseField>
        <ResponseField name="managed_cost_centers_restrict_editing_approved_timesheets" type="single_select">**Managed Cost Centers Restrict Editing Approved Timesheets**</ResponseField>
        <ResponseField name="time_entry_extra_1" type="text">**Time Entry Extra 1**</ResponseField>
        <ResponseField name="time_entry_extra_2" type="text">**Time Entry Extra 2**</ResponseField>
        <ResponseField name="time_entry_extra_3" type="text">**Time Entry Extra 3**</ResponseField>
        <ResponseField name="time_entry_extra_4" type="text">**Time Entry Extra 4**</ResponseField>
        <ResponseField name="time_entry_extra_5" type="text">**Time Entry Extra 5**</ResponseField>
        <ResponseField name="account_extra_1" type="text">**Account Extra 1**<br />
        Additional employee attributes - Maximum 255 characters</ResponseField>
        <ResponseField name="account_extra_2" type="text">**Account Extra 2**<br />
        Additional employee attributes - Maximum 255 characters</ResponseField>
        <ResponseField name="account_extra_3" type="text">**Account Extra 3**<br />
        Additional employee attributes - Maximum 255 characters</ResponseField>
        <ResponseField name="account_extra_4" type="text">**Account Extra 4**<br />
        Additional employee attributes - Maximum 255 characters</ResponseField>
        <ResponseField name="account_extra_5" type="text">**Account Extra 5**<br />
        Additional employee attributes - Maximum 255 characters</ResponseField>
        <ResponseField name="account_extra_1_effective_from" type="date">**Account Extra 1 Effective From**</ResponseField>
        <ResponseField name="account_extra_2_effective_from" type="date">**Account Extra 2 Effective From**</ResponseField>
        <ResponseField name="account_extra_3_effective_from" type="date">**Account Extra 3 Effective From**</ResponseField>
        <ResponseField name="account_extra_4_effective_from" type="date">**Account Extra 4 Effective From**</ResponseField>
        <ResponseField name="account_extra_5_effective_from" type="date">**Account Extra 5 Effective From**</ResponseField>
        <ResponseField name="account_extra_mode" type="single_select">**Account Extra Mode**<br />
        Controls whether account extra field entries are added as new records (ADD) or overwrite existing (SET). Default: ADD</ResponseField>
        <ResponseField name="rate_x_base" type="text">**Rate X Base**</ResponseField>
        <ResponseField name="rate_x_base_eff_date" type="date">**Rate X Base Eff Date**</ResponseField>
        <ResponseField name="rate_x_table" type="text">**Rate X Table**</ResponseField>
        <ResponseField name="rate_x_ext_z_table" type="text">**Rate X Ext Z Table**</ResponseField>
        <ResponseField name="rate_x_ext_z_type" type="text">**Rate X Ext Z Type**</ResponseField>
        <ResponseField name="base_compensation" type="text">**Base Compensation**</ResponseField>
        <ResponseField name="base_compensation_type" type="single_select">**Base Compensation Type**</ResponseField>
        <ResponseField name="base_compensation_amount_earning_code" type="text">**Base Compensation Amount Earning Code**</ResponseField>
        <ResponseField name="base_compensation_hours_earning_code" type="text">**Base Compensation Hours Earning Code**</ResponseField>
        <ResponseField name="base_compensation_effective_from" type="date">**Base Compensation Effective From**</ResponseField>
        <ResponseField name="autopay_schedule" type="text">**Autopay Schedule**</ResponseField>
        <ResponseField name="autopay_schedule_effective_from" type="date">**Autopay Schedule Effective From**</ResponseField>
        <ResponseField name="emergency_contact_first_name" type="text">**Emergency Contact First Name**</ResponseField>
        <ResponseField name="emergency_contact_last_name" type="text">**Emergency Contact Last Name**</ResponseField>
        <ResponseField name="emergency_contact_relationship" type="text">**Emergency Contact Relationship**<br />
        REQUIRED if any Emergency Contact fields are defined (unless disabled in company settings)</ResponseField>
        <ResponseField name="emergency_contact_work_phone" type="text">**Emergency Contact Work Phone**</ResponseField>
        <ResponseField name="emergency_contact_home_phone" type="text">**Emergency Contact Home Phone**</ResponseField>
        <ResponseField name="emergency_contact_cell_phone" type="text">**Emergency Contact Cell Phone**</ResponseField>
        <ResponseField name="emergency_contact_address_1" type="text">**Emergency Contact Address 1**</ResponseField>
        <ResponseField name="emergency_contact_address_2" type="text">**Emergency Contact Address 2**</ResponseField>
        <ResponseField name="emergency_contact_address_3" type="text">**Emergency Contact Address 3**</ResponseField>
        <ResponseField name="emergency_contact_city" type="text">**Emergency Contact City**</ResponseField>
        <ResponseField name="emergency_contact_state" type="text">**Emergency Contact State**</ResponseField>
        <ResponseField name="emergency_contact_zip" type="text">**Emergency Contact Zip**</ResponseField>
        <ResponseField name="emergency_contact_country" type="text">**Emergency Contact Country**</ResponseField>
        <ResponseField name="accruals_x_def" type="text">**Accruals X Def**</ResponseField>
        <ResponseField name="accruals_x_hrs" type="text">**Accruals X Hrs**</ResponseField>
        <ResponseField name="last_pay_period_end_date" type="date">**Last Pay Period End Date**</ResponseField>
        <ResponseField name="default_workers_comp_code" type="text">**Default Workers Comp Code**</ResponseField>
        <ResponseField name="default_workers_comp_code_on_new_only" type="single_select">**Default Workers Comp Code On New Only**</ResponseField>
        <ResponseField name="is_w2" type="single_select">**Is W2**</ResponseField>
        <ResponseField name="is_1099" type="single_select">**Is 1099**</ResponseField>
        <ResponseField name="is_draw" type="single_select">**Is Draw**</ResponseField>
        <ResponseField name="reciprocity_override" type="text">**Reciprocity Override**</ResponseField>
        <ResponseField name="is_commission_only_canada" type="single_select">**Is Commission Only (Canada)**</ResponseField>
        <ResponseField name="add_to_new_hire_export" type="text">**Add To New Hire Export**</ResponseField>
        <ResponseField name="add_to_new_hire_export_on_new_only" type="single_select">**Add To New Hire Export On New Only**</ResponseField>
        <ResponseField name="actual_marital_status" type="text">**Actual Marital Status**</ResponseField>
        <ResponseField name="hr_action_history_type" type="text">**HR Action History Type**</ResponseField>
      </Tab>

      <Tab title="v2">
        <Info>
          Some **optional** form fields are referencing the following data models:

          * Employees

          Consider enabling these in your [scope configuration](/hris/features/scopes).
        </Info>

        <ResponseField name="username" type="text">**Username**<br />
        The username for the employee.</ResponseField>
        <ResponseField name="first_name" type="text">**First Name**<br />
        The first name of the employee<br />
        Unified field: `first_name`</ResponseField>
        <ResponseField name="last_name" type="text">**Last Name**<br />
        The last name of the employee<br />
        Unified field: `last_name`</ResponseField>
        <ResponseField name="middle_name" type="text">**Middle Name**</ResponseField>
        <ResponseField name="nickname" type="text">**Nickname (Preferred Name)**</ResponseField>
        <ResponseField name="primary_email" type="text">**Private Email**<br />
        The private email address of the employee<br />
        Unified field: `private_email`</ResponseField>
        <ResponseField name="secondary_email" type="text">**Secondary Email**</ResponseField>
        <ResponseField name="employee_id" type="text">**Employee ID**<br />
        External Employee ID</ResponseField>

        <ResponseField name="address" type="object">
          **Home Address**

          <Expandable title="properties">
            <ResponseField name="country" type="text">**Country**<br />
            The country of the employee. Use the ISO 3166-1 alpha-3 code.</ResponseField>
            <ResponseField name="address_line_1" type="text">**Street 1**<br />
            The street address of the employee<br />
            Unified field: `home_address.street_1`</ResponseField>
            <ResponseField name="address_line_2" type="text">**Street 2**<br />
            The street address of the employee<br />
            Unified field: `home_address.street_2`</ResponseField>
            <ResponseField name="city" type="text">**City**<br />
            The city of the employee<br />
            Unified field: `home_address.city`</ResponseField>
            <ResponseField name="state" type="text">**State**<br />
            State/Province (Max 3 characters). Only for supported Countries.<br />
            Unified field: `home_address.state`</ResponseField>
            <ResponseField name="zip" type="text">**ZIP Code**<br />
            The ZIP code of the employee<br />
            Unified field: `home_address.zip_code`</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="phones" type="object">
          **Phone Numbers**

          <Expandable title="properties">
            <ResponseField name="cell_phone" type="text">**Mobile Phone Number**<br />
            The mobile phone number of the employee<br />
            Unified field: `mobile_phone_number`</ResponseField>
            <ResponseField name="home_phone" type="text">**Home Phone**</ResponseField>
            <ResponseField name="work_phone" type="text">**Work Phone**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="managers" type="multi_select">**Managers**<br />
        The managers for the employee.</ResponseField>
        <ResponseField name="national_insurance" type="text">**National Insurance Number**</ResponseField>
        <ResponseField name="social_insurance" type="text">**Social Insurance Number**</ResponseField>
        <ResponseField name="social_security" type="text">**Social Security Number**</ResponseField>
        <ResponseField name="add_to_new_hire_export" type="checkbox">**Add to New Hire Export**</ResponseField>

        <ResponseField name="dates" type="object">
          **Important Dates**

          <Expandable title="properties">
            <ResponseField name="started" type="date">**Start Date**<br />
            Start date of the employee. Also considered to be the hire date<br />
            Unified field: `start_date`</ResponseField>
            <ResponseField name="birthday" type="date">**Date of Birth**<br />
            The employee's date of birth<br />
            Unified field: `date_of_birth`</ResponseField>
            <ResponseField name="hired" type="date">**Hired Date**</ResponseField>
            <ResponseField name="re_hired" type="date">**Re-Hired Date**</ResponseField>
            <ResponseField name="terminated" type="date">**Terminated Date**</ResponseField>
          </Expandable>
        </ResponseField>
      </Tab>
    </Tabs>
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** UKG Ready

For **UKG Ready**, we also offer the following other connector variants:

<CardGroup>
  <Card title="UKG Ready ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/ukgready/icon.svg" href="/ats/connectors/ukgready">
    UKG Ready for the ATS category
  </Card>
</CardGroup>


# Workday HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/workday

Workday connector for Kombo's HRIS API

The Workday HRIS integration allows you to sync HRIS data between Workday and your application through Kombo's unified API. The tool slug for this connector is `workday`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/14350938170897">
    Step-by-step instructions to connect your Workday account to Kombo.
  </Card>

  <Card title="How to set up Custom Fields" icon="book" href="https://help.kombo.dev/hc/en-us/articles/24079912530961-Workday-How-do-I-set-up-custom-fields">
    Additional documentation and guides for Workday.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | ethnicity             |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | name                  |       |
      | half\_days\_supported |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absences">
      <Note>
        Some time off entries might not have a time off type associated with them because Workday is not exposing information about the time off types.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_time         |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | parent\_id          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Time Off Balances">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | type\_id            |       |
      | balance             |       |
      | balance\_unit       |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Timesheets">
      <Note>
        Time blocks are synced from Workday Time Tracking API Open clock-in timesheets (ended\_at is null) are deleted once Workday converts them into a full time block.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | started\_at         |       |
      | ended\_at           |       |
      | timezone            |       |
      | payable\_hours      |       |
      | approval\_status    |       |
      | comment             |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee Document Categories">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Performance Review Cycles">
      | Field                       | Notes |
      | --------------------------- | ----- |
      | id                          |       |
      | remote\_id                  |       |
      | changed\_at                 |       |
      | remote\_deleted\_at         |       |
      | name                        |       |
      | review\_period\_start\_date |       |
      | remote\_data                |       |
    </Accordion>

    <Accordion title="Performance Reviews">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | review\_cycle\_id   |       |
      | reviewee\_id        |       |
      | reviewer\_id        |       |
      | type                |       |
      | summary\_comment    |       |
      | summary\_rating     |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Staffing entities">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | name                 |       |
      | model\_type          |       |
      | description          |       |
      | status               |       |
      | employment\_types    |       |
      | number\_of\_openings |       |
      | parent\_id           |       |
      | custom\_fields       |       |
      | integration\_fields  |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Skills">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee Skill Proficiency Ratings">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | employee\_id         |       |
      | skill\_id            |       |
      | proficiency          |       |
      | rating\_source       |       |
      | rating\_provider\_id |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>

    <Accordion title="Staffing Entity <> Location">
      | Field                | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | location\_id         |       |
      | id                   |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
    </Accordion>

    <Accordion title="Staffing Entity <> Legal Entity">
      | Field                | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | legal\_entity\_id    |       |
      | id                   |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
    </Accordion>

    <Accordion title="Staffing entity <> Group">
      | Field                | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | group\_id            |       |
      | id                   |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
    </Accordion>

    <Accordion title="Staffing entity <> Skill">
      | Field                 | Notes |
      | --------------------- | ----- |
      | expected\_proficiency |       |
      | staffing\_entity\_id  |       |
      | skill\_id             |       |
      | id                    |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee">
      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | home\_address.street\_1 |       |
      | home\_address.street\_2 |       |
      | home\_address.city      |       |
      | home\_address.state     |       |
      | home\_address.zip\_code |       |
      | home\_address.country   |       |
      | mobile\_phone\_number   |       |
      | nationality             |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>

    <Accordion title="Add document to employee">
      | Input Field            | Notes |
      | ---------------------- | ----- |
      | employee\_id           |       |
      | category\_id           |       |
      | document.name          |       |
      | document.content\_type |       |
      | document.data\_url     |       |
      | document.data          |       |
    </Accordion>

    <Accordion title="Upsert employee skill proficiency rating">
      <Note>
        Workday rounds skill proficiency ratings up to one decimal place (e.g. 3.44 → 3.5).
      </Note>

      | Input Field        | Notes |
      | ------------------ | ----- |
      | employee\_id       |       |
      | skill\_id          |       |
      | rating.proficiency |       |
    </Accordion>

    <Accordion title="Upsert staffing entity skill expectation">
      <Note>
        Workday only accepts integer values for expected proficiency. Updating a Workday job modifies its shared job profile and may also affect other jobs or positions linked to that profile. Writes replace the job profile's complete skill set. Run writes targeting the same profile sequentially to avoid lost updates.
      </Note>

      | Input Field           | Notes |
      | --------------------- | ----- |
      | staffing\_entity\_id  |       |
      | skill\_id             |       |
      | expected\_proficiency |       |
    </Accordion>

    <Accordion title="Upsert managed skill">
      | Input Field | Notes |
      | ----------- | ----- |
      | origin\_id  |       |
      | name        |       |
      | status      |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | API Passthrough       |       |
    | Additional Scopes     |       |
    | Scope Testing         |       |
    | Per Model Tests       |       |
    | Per Field Tests       |       |
    | Custom Field Explorer |       |
    | Employees             |       |
    | Employments           |       |
    | Connection Guide      |       |
    | Prerequisites         |       |
    | Create credentials    |       |
    | Group Types           |       |
    | DEPARTMENT            |       |
    | COST\_CENTER          |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Info>
      Some **optional** form fields are referencing the following data models:

      * Employees
      * Groups
      * Locations

      Consider enabling these in your [scope configuration](/hris/features/scopes).
    </Info>

    <ResponseField name="Name_Data" type="object">
      **Personal Data**

      <Expandable title="properties">
        <ResponseField name="Country_Reference" type="single_select">**Country**<br />
        The Country that the name is in reference to.</ResponseField>
        <ResponseField name="First_Name" type="text">**First Name**<br />
        The first name of the employee<br />
        Unified field: `first_name`</ResponseField>
        <ResponseField name="Last_Name" type="text">**Last Name**<br />
        The last name of the employee<br />
        Unified field: `last_name`</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="Contact_Data" type="object">
      **Contact Data**

      <Expandable title="properties">
        <ResponseField name="Address_Data" type="object">
          **Address Data**

          <Expandable title="properties">
            <ResponseField name="Country_Reference" type="single_select">**Country of the Address**</ResponseField>
            <ResponseField name="Country_Region_Reference" type="single_select">**Country Region**<br />
            The region of the country, you can only set this for certain countries.</ResponseField>
            <ResponseField name="Last_Modified" type="date">**Last Modified**<br />
            The moment when the address was last modified.</ResponseField>
            <ResponseField name="ADDRESS_LINE_1" type="text">**Address Line 1**<br />
            Unified field: `home_address.street_1`</ResponseField>
            <ResponseField name="ADDRESS_LINE_2" type="text">**Address Line 2**<br />
            Unified field: `home_address.street_2`</ResponseField>
            <ResponseField name="CITY" type="text">**City**<br />
            Unified field: `home_address.city`</ResponseField>
            <ResponseField name="POSTAL_CODE" type="text">**Postal Code**<br />
            Unified field: `home_address.zip_code`</ResponseField>
            <ResponseField name="REGION" type="text">**Region**<br />
            Unified field: `home_address.state`</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="Phone_Data" type="object">
          **Phone Data**

          <Expandable title="properties">
            <ResponseField name="Phone_Number" type="text">**Phone Number**<br />
            Unified field: `mobile_phone_number`</ResponseField>
            <ResponseField name="International_Phone_Code" type="text">**International Phone Code**<br />
            The international phone code of the phone number.</ResponseField>
            <ResponseField name="Phone_Device_Type_Reference" type="single_select">**Phone Device Type**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="Email_Address_Data" type="object">
          **Email Address Data**

          <Expandable title="properties">
            <ResponseField name="Email_Address" type="text">**Private Email**<br />
            The private email address of the employee<br />
            Unified field: `private_email`</ResponseField>
            <ResponseField name="Email_Comment" type="text">**Email Comment**</ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="Recruiting_Data" type="object">
      **Recruiting Data**

      <Expandable title="properties">
        <ResponseField name="Applicant_Entered_Date" type="date">**The date the applicant was created.**</ResponseField>
        <ResponseField name="Applicant_Comments" type="text">**Comments about the applicant.**</ResponseField>
        <ResponseField name="Applicant_Source_Reference" type="single_select">**Applicant Source**</ResponseField>
        <ResponseField name="Referred_by_Worker_Reference" type="single_select">**Referred by Worker**<br />
        References `/v1/hris/employees?remote_model=employee`</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="Universal_ID" type="text">**Universal ID**</ResponseField>

    <ResponseField name="Post_Hire_Data" type="object">
      **Post Hire Data**

      <Expandable title="properties">
        <ResponseField name="Is_Contingent_Worker" type="checkbox">**Is Contingent Worker**<br />
        If enabled, the employee will be hired as a contingent worker.</ResponseField>
        <ResponseField name="Auto_Complete" type="checkbox">**Auto Complete**<br />
        When checked, the business process (Hire Employee/Contract Contingent Worker) is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.</ResponseField>
        <ResponseField name="Run_Now" type="checkbox">**Run Now**<br />
        Indicates the transaction should process to completion before the response is generated.</ResponseField>
        <ResponseField name="Comment_Data" type="text">**Comment**</ResponseField>
        <ResponseField name="Positions_Reference" type="single_select">**Position Reference**<br />
        References `/v1/hris/staffing-entities?model_types=POSITION&statuses=OPEN_LIMITED%2COPEN_UNLIMITED`</ResponseField>
        <ResponseField name="Organization_Reference" type="single_select">**Supervisory Organization**<br />
        References `/v1/hris/groups?types=DEPARTMENT`</ResponseField>
        <ResponseField name="Contract_Start_Date" type="date">**Hire / Contract Start Date**</ResponseField>

        <ResponseField name="Hire_Employee_Event_Data" type="object">
          **Hire Employee Event Data**

          <Expandable title="properties">
            <ResponseField name="Employee_Type_Reference" type="single_select">**Employee Type**<br />
            The employee type for the hire (e.g. Regular, Fixed Term). Defaults to the type defined on the position.</ResponseField>
            <ResponseField name="Employment_End_Date" type="date">**Employment End Date**<br />
            Required for fixed term employee types. Must be after the hire date.</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="Propose_Compensation_for_Hire_Sub_Process" type="object">
          **Stock Compensation**<br />
          Assign an active amount-based stock compensation plan as part of the hire process.

          <Expandable title="properties">
            <ResponseField name="Stock_Plan_Reference" type="single_select">**Stock Compensation Plan**</ResponseField>
            <ResponseField name="Individual_Target_Amount" type="number">**Amount**<br />
            The individual target amount for the stock compensation plan.</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="Request_One_Time_Payment_Sub_Process" type="object">
          **One-Time Payment**<br />
          Request an amount-based one-time payment, such as a sign-on or relocation payment, as part of the hire process.

          <Expandable title="properties">
            <ResponseField name="One_Time_Payment_Plan_Reference" type="single_select">**One-Time Payment Plan**</ResponseField>

            <ResponseField name="Amount" type="number" />

            <ResponseField name="Currency_Reference" type="single_select">**Currency**<br />
            Defaults to the currency configured on the selected plan when omitted.</ResponseField>
            <ResponseField name="Effective_Date" type="date">**Effective Date**</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="Contingent_Worker_Event_Data" type="object">
          **Contingent Worker Event Data**<br />
          Details for the contingent worker contract event. Required when hiring as a contingent worker.

          <Expandable title="properties">
            <ResponseField name="Contract_Worker_Type_Reference" type="single_select">**Contingent Worker Type**</ResponseField>
            <ResponseField name="Job_Profile_Reference" type="single_select">**Job Profile**<br />
            The Job Profile for the filled position. This is required if there is no job profile on the position.</ResponseField>
            <ResponseField name="Location_Reference" type="single_select">**Location**<br />
            The Location for the filled position.<br />
            References `/v1/hris/locations?remote_model=location`</ResponseField>
            <ResponseField name="Position_Time_Type_Reference" type="single_select">**Position Time Type**<br />
            The time type for the position (e.g., part time or full time).</ResponseField>

            <ResponseField name="Contract_Details_Data" type="object">
              **Contract Details**<br />
              Contingent worker contract details. If omitted, Workday keeps the existing contract details.

              <Expandable title="properties">
                <ResponseField name="Contract_Pay_Rate" type="number">**Contract Pay Rate**<br />
                The pay rate for the position.</ResponseField>
                <ResponseField name="Currency_Reference" type="single_select">**Currency**<br />
                The preferred currency for the contract pay rate.</ResponseField>
                <ResponseField name="Frequency_Reference" type="single_select">**Frequency**<br />
                The frequency with which the worker is paid. If Create Purchase Order is set, this must have an hourly behavior.</ResponseField>
              </Expandable>
            </ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Choose this variant if you want to use the Workday SOAP API for comprehensive HRIS data access

For **Workday**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Workday Custom Reports" icon="https://storage.googleapis.com/kombo-assets/integrations/workdaycustomreport/icon.svg" href="/hris/connectors/workdaycustomreport">
    Choose this variant if you want to use Workday Custom Reports API. Requires custom report setup in Workday
  </Card>

  <Card title="Workday ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/workday/icon.svg" href="/ats/connectors/workday">
    Workday for the ATS category
  </Card>

  <Card title="Workday Assessment" icon="https://storage.googleapis.com/kombo-assets/integrations/workday/icon.svg" href="/assessment/connectors/workday">
    Workday for the Assessment category
  </Card>

  <Card title="Workday LMS" icon="https://storage.googleapis.com/kombo-assets/integrations/workday/icon.svg" href="/lms/connectors/workday">
    Workday for the LMS category
  </Card>
</CardGroup>

<Note>Multiple variants can be used within your Kombo environment at the same time.</Note>


# Workday Custom Reports HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/workdaycustomreport

Workday Custom Reports connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Workday Custom Reports HRIS integration allows you to sync HRIS data between Workday Custom Reports and your application through Kombo's unified API. The tool slug for this connector is `workdaycustomreport`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/21595421202321-Workday-Custom-Reports-How-do-I-link-my-account-">
    Step-by-step instructions to connect your Workday Custom Reports account to Kombo.
  </Card>

  <Card title="What are custom reports?" icon="book" href="https://help.kombo.dev/hc/en-us/articles/21623846742417-What-are-Workday-Custom-Reports-">
    Additional documentation and guides for Workday Custom Reports.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | address             |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | ethnicity             |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | type\_id            |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_currency       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | Scope Testing    |       |
    | Per Model Tests  |       |
    | Per Field Tests  |       |
    | Connection Guide |       |
    | Prerequisites    |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Choose this variant if you want to use Workday Custom Reports API. Requires custom report setup in Workday

For **Workday Custom Reports**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Workday" icon="https://storage.googleapis.com/kombo-assets/integrations/workday/icon.svg" href="/hris/connectors/workday">
    Choose this variant if you want to use the Workday SOAP API for comprehensive HRIS data access
  </Card>
</CardGroup>

<Note>Multiple variants can be used within your Kombo environment at the same time.</Note>


# Workday Custom Report SFTP HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/workdaycustomreportsftp

Workday Custom Report SFTP connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Workday Custom Report SFTP HRIS integration allows you to sync HRIS data between Workday Custom Report SFTP and your application through Kombo's unified API. The tool slug for this connector is `workdaycustomreportsftp`.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | address             |       |
    </Accordion>

    <Accordion title="Employees">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_number    |       |
      | job\_title          |       |
      | employment\_status  |       |
      | employment\_type    |       |
      | work\_location\_id  |       |
      | manager\_id         |       |
      | start\_date         |       |
      | termination\_date   |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature      | Notes |
    | ------------ | ----- |
    | Group Types  |       |
    | COST\_CENTER |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Workday Custom Report SFTP

For **Workday Custom Report SFTP**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Workday" icon="https://storage.googleapis.com/kombo-assets/integrations/workday/icon.svg" href="/hris/connectors/workday">
    Choose this variant if you want to use the Workday SOAP API for comprehensive HRIS data access
  </Card>

  <Card title="Workday Custom Reports" icon="https://storage.googleapis.com/kombo-assets/integrations/workdaycustomreport/icon.svg" href="/hris/connectors/workdaycustomreport">
    Choose this variant if you want to use Workday Custom Reports API. Requires custom report setup in Workday
  </Card>
</CardGroup>

<Note>Multiple variants can be used within your Kombo environment at the same time.</Note>


# workforce.com HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/workforcecom

workforce.com connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The workforce.com HRIS integration allows you to sync HRIS data between workforce.com and your application through Kombo's unified API. The tool slug for this connector is `workforcecom`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/33744278471057-Workforce-com-How-do-I-link-my-account">
    Step-by-step instructions to connect your workforce.com account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      <Note>
        Only the primary employment's work location is exposed via Kombo's API. Workforce.com does not differentiate between the employee's "work\_email" and "personal\_email"
      </Note>

      | Field                 | Notes                                                                                                                                                                                                       |
      | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
      | id                    |                                                                                                                                                                                                             |
      | remote\_id            |                                                                                                                                                                                                             |
      | changed\_at           |                                                                                                                                                                                                             |
      | remote\_deleted\_at   |                                                                                                                                                                                                             |
      | employee\_number      |                                                                                                                                                                                                             |
      | first\_name           |                                                                                                                                                                                                             |
      | last\_name            |                                                                                                                                                                                                             |
      | display\_full\_name   |                                                                                                                                                                                                             |
      | job\_title            |                                                                                                                                                                                                             |
      | work\_email           |                                                                                                                                                                                                             |
      | personal\_email       |                                                                                                                                                                                                             |
      | mobile\_phone\_number |                                                                                                                                                                                                             |
      | tax\_id               |                                                                                                                                                                                                             |
      | gender                |                                                                                                                                                                                                             |
      | employment\_status    |                                                                                                                                                                                                             |
      | employment\_type      | When the employment type field is unavailable, the system uses fallback logic: If a yearly salary is provided, the type defaults to 'FULL\_TIME'; If an hourly rate is provided, it defaults to 'CONTRACT'. |
      | weekly\_hours         |                                                                                                                                                                                                             |
      | avatar                |                                                                                                                                                                                                             |
      | work\_location\_id    |                                                                                                                                                                                                             |
      | home\_address         |                                                                                                                                                                                                             |
      | bank\_accounts        |                                                                                                                                                                                                             |
      | date\_of\_birth       |                                                                                                                                                                                                             |
      | start\_date           |                                                                                                                                                                                                             |
      | termination\_date     |                                                                                                                                                                                                             |
      | remote\_created\_at   |                                                                                                                                                                                                             |
      | custom\_fields        |                                                                                                                                                                                                             |
      | integration\_fields   |                                                                                                                                                                                                             |
      | remote\_data          |                                                                                                                                                                                                             |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | employment\_type    |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature               | Notes |
    | --------------------- | ----- |
    | OAuth                 |       |
    | API Passthrough       |       |
    | Custom Field Explorer |       |
    | Employees             |       |
    | Connection Guide      |       |
    | Group Types           |       |
    | TEAM                  |       |
  </Tab>
</Tabs>


# Visma Raet - Youforce HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/youforce

Visma Raet - Youforce connector for Kombo's HRIS API

The Visma Raet - Youforce HRIS integration allows you to sync HRIS data between Visma Raet - Youforce and your application through Kombo's unified API. The tool slug for this connector is `youforce`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/25662408679825-Visma-Raet-Youforce-How-do-I-link-my-account">
    Step-by-step instructions to connect your Visma Raet - Youforce account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | gender                |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | work\_location\_id    |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | employment\_type    |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | parent\_id          |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | API Passthrough    |       |
    | Scope Testing      |       |
    | Connection Guide   |       |
    | Create credentials |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Note>
      Youforce creates hires through an asynchronous HSS workflow. Kombo waits for that workflow and surfaces any validation error it reports, but the new employee only appears in Kombo on a later sync, once Youforce has finished processing it.
    </Note>

    <Note>
      Hires run through an HSS workflow that must be configured on the customer's Youforce tenant. The workflow that runs — and which fields it treats as mandatory (e.g. some require payroll client/institution codes) — depends on that tenant's setup.
    </Note>

    <ResponseField name="workflowName" type="text">**Workflow Name**<br />
    Optional override for the HSS workflow to start, sent as `X-Raet-Workflow`. Must exactly match a workflow name configured on the customer's Youforce tenant (case-sensitive). When omitted, Youforce starts the default workflow configured for this endpoint.</ResponseField>
    <ResponseField name="lastNameAtBirth" type="text">**Last Name**<br />
    The last name of the employee<br />
    Unified field: `last_name`</ResponseField>
    <ResponseField name="lastNameAtPrefix" type="text">**Last Name at Birth Prefix**<br />
    Optional Dutch tussenvoegsel for the birth name (e.g. `de`, `van der`).</ResponseField>
    <ResponseField name="knownAs" type="text">**First Name**<br />
    The name the person is commonly known by.<br />
    Unified field: `first_name`</ResponseField>
    <ResponseField name="initials" type="text">**Initials**</ResponseField>
    <ResponseField name="firstNames" type="text">**First Names**</ResponseField>
    <ResponseField name="gender" type="single_select">**Gender**<br />
    When omitted, Youforce defaults to `Unknown`.<br />
    Unified field: `gender`</ResponseField>
    <ResponseField name="birthDate" type="date">**Date of Birth**<br />
    The employee's date of birth<br />
    Unified field: `date_of_birth`</ResponseField>
    <ResponseField name="birthPlace" type="text">**Birth Place**</ResponseField>
    <ResponseField name="birthCountry" type="text">**Birth Country**</ResponseField>
    <ResponseField name="titlePrefix" type="text">**Title Prefix**<br />
    Title shown before the name.</ResponseField>
    <ResponseField name="titleSuffix" type="text">**Title Suffix**<br />
    Title shown after the name.</ResponseField>
    <ResponseField name="maritalStatus" type="text">**Marital Status**</ResponseField>
    <ResponseField name="lastNamePreference" type="text">**Last Name Preference**<br />
    Youforce code controlling how the displayed last name is composed from the birth and partner names (e.g. `E` for the birth name).</ResponseField>
    <ResponseField name="lastNamePartner" type="text">**Partner's Last Name**</ResponseField>
    <ResponseField name="partnerNamePrefix" type="text">**Partner's Last Name Prefix**<br />
    Optional Dutch tussenvoegsel for the partner name.</ResponseField>
    <ResponseField name="socialSecurityNumber" type="text">**Social Security Number**<br />
    Dutch BSN/Sofi number.</ResponseField>
    <ResponseField name="emailAddress" type="text">**Private Email**<br />
    Personal email address used for self-service onboarding.<br />
    Unified field: `private_email`</ResponseField>

    <ResponseField name="phoneNumbers" type="object">
      **Phone Numbers**

      <Expandable title="properties">
        <ResponseField name="phoneNumberHome" type="text">**Home Phone Number**</ResponseField>
        <ResponseField name="phoneNumberMobile" type="text">**Mobile Phone Number**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="addresses" type="object">
      **Addresses**

      <Expandable title="properties">
        <ResponseField name="homeAddress" type="object">
          **Home Address**

          <Expandable title="properties">
            <ResponseField name="street" type="text">**Street**</ResponseField>
            <ResponseField name="number" type="number">**Number**</ResponseField>
            <ResponseField name="numberAdditional" type="text">**Number Addition**</ResponseField>
            <ResponseField name="postalCode" type="text">**Postal Code**</ResponseField>
            <ResponseField name="city" type="text">**City**</ResponseField>
            <ResponseField name="country" type="text">**Country**<br />
            ISO country code (e.g. `NL`).</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="postalAddress" type="object">
          **Postal Address**<br />
          The employee's mailing address, when it differs from the home address.

          <Expandable title="properties">
            <ResponseField name="street" type="text">**Street**</ResponseField>
            <ResponseField name="number" type="number">**Number**</ResponseField>
            <ResponseField name="numberAdditional" type="text">**Number Addition**</ResponseField>
            <ResponseField name="postalCode" type="text">**Postal Code**</ResponseField>
            <ResponseField name="city" type="text">**City**</ResponseField>
            <ResponseField name="country" type="text">**Country**<br />
            ISO country code (e.g. `NL`).</ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="employmentDetails" type="object">
      **Employment Details**

      <Expandable title="properties">
        <ResponseField name="hireDate" type="date">**Start Date**<br />
        Start date of the employee. Also considered to be the hire date<br />
        Unified field: `start_date`</ResponseField>
        <ResponseField name="originalHireDate" type="date">**Original Hire Date**<br />
        Used for CAO seniority calculations.</ResponseField>
        <ResponseField name="endDate" type="date">**End Date**</ResponseField>
        <ResponseField name="employeeType" type="single_select">**Employee Type**</ResponseField>
        <ResponseField name="contractType" type="text">**Contract Type**<br />
        Code indicating whether the contract is for a (in)definite period.</ResponseField>
        <ResponseField name="probationPeriodEnddate" type="date">**Probation Period End Date**</ResponseField>
        <ResponseField name="organizationUnit" type="single_select">**Organization Unit**</ResponseField>
        <ResponseField name="jobProfile" type="single_select">**Job Profile**</ResponseField>
        <ResponseField name="amountOfHours" type="number">**Hours per Week**</ResponseField>
        <ResponseField name="parttimePercentage" type="number">**Part-time Percentage**</ResponseField>
        <ResponseField name="payrollClientCode" type="text">**Payroll Client Code**<br />
        The payroll client (Opdrachtgever) code configured by the customer's Visma Raet consultant on their Youforce tenant. Whether this field is mandatory depends on the HSS workflow that handles the request – check with the customer's consultant if unsure.</ResponseField>
        <ResponseField name="payrollInstitutionCode" type="text">**Payroll Institution Code**<br />
        The payroll company (Instelling) code configured by the customer's Visma Raet consultant on their Youforce tenant. Whether this field is mandatory depends on the HSS workflow that handles the request – check with the customer's consultant if unsure.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="salaryDetails" type="object">
      **Salary Details**

      <Expandable title="properties">
        <ResponseField name="salary" type="number">**Salary**</ResponseField>
        <ResponseField name="hourlyRate" type="number">**Hourly Rate**</ResponseField>
        <ResponseField name="payScale" type="text">**Pay Scale**</ResponseField>
        <ResponseField name="payScaleStep" type="text">**Pay Scale Step**</ResponseField>
        <ResponseField name="payScaleAmountNo" type="number">**Pay Scale Amount Number**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="assignments" type="array">
      **Assignments (Inzet)**<br />
      Optional secondary deployments to other organization units. Requires a workflow configured with assignment support on the customer's tenant (e.g. "YF API - Nieuwe Medewerker (incl inzet)") – set "Workflow Name" accordingly.

      <Expandable title="items">
        <ResponseField name="startDate" type="date">**Start Date**</ResponseField>
        <ResponseField name="endDate" type="date">**End Date**</ResponseField>
        <ResponseField name="assignmentType" type="text">**Assignment Type**</ResponseField>
        <ResponseField name="organizationUnit" type="single_select">**Organization Unit**</ResponseField>
        <ResponseField name="jobProfile" type="single_select">**Job Profile**</ResponseField>
        <ResponseField name="amountOfHours" type="number">**Hours per Week**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="files" type="array">
      **Files**<br />
      Attachments forwarded with the HSS workflow, up to roughly 28 MB total per request.

      <Expandable title="items">
        <ResponseField name="file" type="file">**File**</ResponseField>
        <ResponseField name="category" type="text">**Category**<br />
        Optional category label shown alongside the file in the HSS workflow.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="customFields" type="array">
      **Custom Fields**

      <Expandable title="items">
        <ResponseField name="fieldCode" type="text">**Field Code**<br />
        Native Youforce field code, e.g. `P00390`.</ResponseField>
        <ResponseField name="fieldValue" type="text">**Field Value**<br />
        String-encoded value for this field.</ResponseField>
      </Expandable>
    </ResponseField>
  </Tab>
</Tabs>


# Visma YouServe HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/youserve

Visma YouServe connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Visma YouServe HRIS integration allows you to sync HRIS data between Visma YouServe and your application through Kombo's unified API. The tool slug for this connector is `youserve`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/38118977217553-Visma-YouServe-How-do-I-link-my-account">
    Step-by-step instructions to connect your Visma YouServe account to Kombo.
  </Card>
</CardGroup>

## General Notes

* Only the Visma YouServe "API for Learning Mgmt Systems" is supported at the moment.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | gender                |       |
      | employment\_status    |       |
      | weekly\_hours         |       |
      | work\_location\_id    |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | employment\_type    |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | parent\_id          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee Document Categories">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Add document to employee">
      <Note>
        YouServe's API does not support document categories.
      </Note>

      | Input Field            | Notes |
      | ---------------------- | ----- |
      | employee\_id           |       |
      | document.name          |       |
      | document.content\_type |       |
      | document.data\_url     |       |
      | document.data          |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | API Passthrough  |       |
    | Delta Syncs      |       |
    | Connection Guide |       |
    | Group Types      |       |
    | COST\_CENTER     |       |
  </Tab>
</Tabs>


# Zelt HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/zelt

Zelt connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Zelt HRIS integration allows you to sync HRIS data between Zelt and your application through Kombo's unified API. The tool slug for this connector is `zelt`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/23832630684689">
    Step-by-step instructions to connect your Zelt account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | gender                |       |
      | employment\_status    |       |
      | work\_location\_id    |       |
      | manager\_id           |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature            | Notes |
    | ------------------ | ----- |
    | OAuth              |       |
    | API Passthrough    |       |
    | Connection Guide   |       |
    | Create credentials |       |
    | Group Types        |       |
    | DEPARTMENT         |       |
  </Tab>
</Tabs>


# Zoho People HRIS Integration
Source: https://docs.kombo.dev/hris/connectors/zohopeople

Zoho People connector for Kombo's HRIS API

The Zoho People HRIS integration allows you to sync HRIS data between Zoho People and your application through Kombo's unified API. The tool slug for this connector is `zohopeople`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/42520517031057-Zoho-People-How-do-I-link-my-account">
    Step-by-step instructions to connect your Zoho People account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Employees">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | gender                |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | avatar                |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | remote\_created\_at   |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                 | Notes |
      | --------------------- | ----- |
      | id                    |       |
      | remote\_id            |       |
      | changed\_at           |       |
      | remote\_deleted\_at   |       |
      | name                  |       |
      | unit                  |       |
      | half\_days\_supported |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | amount              |       |
      | unit                |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create employee">
      <Note>
        Zoho People requires an employee ID (personnel code) to create an employee. We will default it to the `work_email`, or you could provide one via remote fields.
      </Note>

      | Input Field           | Notes |
      | --------------------- | ----- |
      | first\_name           |       |
      | last\_name            |       |
      | work\_email           |       |
      | gender                |       |
      | date\_of\_birth       |       |
      | mobile\_phone\_number |       |
      | nationality           |       |
      | start\_date           |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | OAuth            |       |
    | Connection Guide |       |
    | Group Types      |       |
    | DEPARTMENT       |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Note>
      You can use the Invitation Method or the Direct Method to create employees in Zoho People. The Invitation Method sends an email invitation to the employee for profile setup. The Direct Method creates the employee immediately with login credentials.
    </Note>

    This integration supports multiple employee creation forms for different use cases:

    <Tabs>
      <Tab title="direct">
        <Info>
          Some **optional** form fields are referencing the following data models:

          * Employees

          Consider enabling these in your [scope configuration](/hris/features/scopes).
        </Info>

        <Warning>
          This form may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
        </Warning>

        <ResponseField name="EmployeeID" type="text">**Employee ID**<br />
        The unique employee identifier (personnel code) required by Zoho People.</ResponseField>
        <ResponseField name="FirstName" type="text">**First Name**<br />
        The first name of the employee<br />
        Unified field: `first_name`</ResponseField>
        <ResponseField name="LastName" type="text">**Last Name**<br />
        The last name of the employee<br />
        Unified field: `last_name`</ResponseField>
        <ResponseField name="EmailID" type="text">**Work Email**<br />
        The email address of the employee<br />
        Unified field: `work_email`</ResponseField>
        <ResponseField name="Dateofjoining" type="date">**Start Date**<br />
        Start date of the employee. Also considered to be the hire date<br />
        Unified field: `start_date`</ResponseField>
        <ResponseField name="Date_of_birth" type="date">**Date of Birth**<br />
        The employee's date of birth<br />
        Unified field: `date_of_birth`</ResponseField>
        <ResponseField name="Gender" type="single_select">The gender of the employee<br />
        Unified field: `gender`</ResponseField>
        <ResponseField name="Work_phone" type="text">**Mobile Phone Number**<br />
        The work phone number of the employee<br />
        Unified field: `mobile_phone_number`</ResponseField>
        <ResponseField name="password" type="text">**Password**<br />
        A temporary password for the employee to log in to Zoho People.</ResponseField>
      </Tab>

      <Tab title="invitation">
        <Info>
          Some **optional** form fields are referencing the following data models:

          * Employees

          Consider enabling these in your [scope configuration](/hris/features/scopes).
        </Info>

        <Warning>
          This form may contain additional custom fields that depend on your specific tool instance configuration. The exact custom fields available will vary based on your setup and cannot be displayed here.
        </Warning>

        <ResponseField name="EmployeeID" type="text">**Employee ID**<br />
        The unique employee identifier (personnel code) required by Zoho People.</ResponseField>
        <ResponseField name="FirstName" type="text">**First Name**<br />
        The first name of the employee<br />
        Unified field: `first_name`</ResponseField>
        <ResponseField name="LastName" type="text">**Last Name**<br />
        The last name of the employee<br />
        Unified field: `last_name`</ResponseField>
        <ResponseField name="EmailID" type="text">**Work Email**<br />
        The email address of the employee<br />
        Unified field: `work_email`</ResponseField>
        <ResponseField name="Dateofjoining" type="date">**Start Date**<br />
        Start date of the employee. Also considered to be the hire date<br />
        Unified field: `start_date`</ResponseField>
        <ResponseField name="Date_of_birth" type="date">**Date of Birth**<br />
        The employee's date of birth<br />
        Unified field: `date_of_birth`</ResponseField>
        <ResponseField name="Gender" type="single_select">The gender of the employee<br />
        Unified field: `gender`</ResponseField>
        <ResponseField name="Work_phone" type="text">**Mobile Phone Number**<br />
        The work phone number of the employee<br />
        Unified field: `mobile_phone_number`</ResponseField>
      </Tab>
    </Tabs>
  </Tab>
</Tabs>


# Process Description
Source: https://docs.kombo.dev/hris/datev/datev-eau

Learn how to use the Kombo DATEV integration to request and retrieve eAU certificates.

# Prerequisites

## Permissions

To use the eAU endpoints, you must have the `Manage eAU` permission enabled in your scope config.

You can allow your customers to opt-out of the eAU process by setting the permission to `optional`. In this scenario, you must verify whether the permission is granted by using our [Verify eAU Permission endpoint](/hris/v1/get-datev-check-eau-permission).

The corresponding service within DATEV is called `DATEV Lohnaustauschdatenservice`.

# eAU Workflow

## Creating an eAU Request

To verify an employee's sick leave, you must initiate an eAU request. This request triggers a process within the employee's health insurance to confirm whether a sick leave was officially reported by a doctor.

### Legal Preconditions

Before requesting an eAU certificate, the following legal preconditions must be met:

* The employee must have been employed at the time of the sick leave.
* The employee must have public health insurance at the time of the AU.
* The employee must provide a start date and a preliminary duration for the AU.

### Timing of the Initial eAU Request

The provided `start_date` can be any day within the reported AU period. The health insurance will return the eAU certificate if the provided `start_date` is between the AU's start and end date.

Legally, employees must issue an eAU from their doctor by the fourth working day of their sick leave. However, employers can choose to shorten this period. If the sick leave lasts fewer than four days, an eAU certificate is not legally required.

You can request an eAU certificate up to four years retrospectively, but not before October 1, 2021. Doctors may issue eAU certificates up to three days retroactively.

### Making the Request

To create an eAU request, call our [Create eAU Request endpoint](/hris/v1/post-datev-employees-employee-id-eau-requests) with the following details:

* The DATEV employee number (remote\_id or retrievable via the Lohnaustauschdatenservice/Lohnergebnisdatenservice).
* The start date of the AU.

A successful eAU request creation returns an `eau_id`, which you will use to query the request's status.

## Querying the Status of the eAU Request

Once created, the health insurance processes the eAU request and provides feedback within approximately 14 days.

Use the [Get eAU Request Status endpoint](/hris/v1/get-datev-eau-requests-eau-id) with your received `eau_id` to check the request status.

Note: DATEV APIs must be used efficiently. No webhook or notification mechanisms exist for status changes. Therefore, you must periodically poll the status. Avoid polling more than twice daily.

#### Example Response

When you fetch the status we will return an object like this:

```json theme={null}
{
  "status": "success",
  "data": {
    "rawResponse": {
      "source": "LuG",
      "start_work_incapacity": "2024-04-18",
      "feedbacks_from_health_insurance": [
        {
          "guid": "22506bf2-7cf4-4e40-aadf-1a242920cfef",
          "contact_person": {
            "gender_contact_person": "M",
            "name": "Barmer Muster Friedrich",
            "telephone": "+49 201 1234-0",
            "fax": "+49 201 1234-1",
            "email": "friedrich.barmermuster@barmer.de",
            "name1_health_insurance": "Krankengeld-Zentrum Regensburg",
            "name2_health_insurance": null,
            "name3_health_insurance": null,
            "postal_code": "93059",
            "city": "Regensburg",
            "street": "Im Gewerbepark D 55",
            "house_number": "12345"
          },
          "incapacity_for_work": {
            "start_work_incapacity_employer": "2024-04-18",
            "start_work_incapacity_au": null,
            "end_work_incapacity_au": null,
            "date_of_diagnosis": null,
            "flag_current_work_incapacity": 1,
            "accident_at_work": false,
            "assignment_accident_insurance_doctor": false,
            "other_accident": false,
            "start_hospitalisation": null,
            "end_hospitalisation": null,
            "initial_certificate": false,
            "automatic_feedback_until": null
          },
          "error_block_list": [
            {
              "error_value": null,
              "error_text": null,
              "origin": "INTERN",
              "error_number": "DAPC050"
            }
          ]
        }
      ]
    }
  }
}
```

#### Parsing the Response

Initially, while the health insurance is processing the request, the `feedbacks_from_health_insurance` array in the response is empty. You can consider the request as pending.

Once the health insurance has processed the request, the `feedbacks_from_health_insurance` array will contain one or multiple feedbacks. If any errors occurred, they will be listed under the `error_block_list` array.

Some feedback states are not final and can change over time. The response will include an `automatic_feedback_until` date, indicating until when further polling may lead to updates.

#### Validating the eAU

A feedback from the health insurance does not automatically mean that the eAU is valid. You need to validate the eAU by examining the `flag_current_work_incapacity`, which can have these values:

**Flag 1: Health Insurance Not Responsible**

* The provided insurance is incorrect. Request updated insurance information from the employee and inform the tax consultant to update DATEV.

**Flag 2: Incapacity for Work**

* The eAU is valid if absence dates match.

**Flag 3: Hospitalization | Flag 6: Partial Inpatient Treatment**

* The end date may initially be missing and only provided upon patient discharge. Keep polling until the end date appears.
* The eAU is valid if absence dates match.

**Flag 4: eAU or Hospitalization Report Not Found**

* eAU not yet available. Continue polling status updates for 14 days. After this period, submit a new request if necessary.

**Flag 5: Rehabilitation or Prevention**

* The eAU is valid if absence dates match.

**Flag 7: Under Verification**

* Health insurance is manually verifying incorrect or disputed information. Continue polling for updates for up to 28 days, after which submit a new request if needed.

**Flag 8: Other Evidence Available**

* Evidence from private or foreign doctors. Poll status updates for 14 days; afterward, submit a new request if necessary.

**Flag 9: Forwarding Procedure**

* The employee is changing health insurers. Continue polling for updates within 28 days.

#### Follow-up certificate

If the employee has a sick leave that is longer than what was returned in the initial eAU request its possible that the doctor has issued a follow-up certificate. In this case you will need to create a new eAU request with the new start date (end date of the eAU plus 1 day).


# eAU examples
Source: https://docs.kombo.dev/hris/datev/datev-eau-examples

Common eAU requests and their responses.

# Examples

### Example 1: `start_work_incapacity` matches the AU start date of the health insurance

<Frame>
  <img alt="1762" />
</Frame>

The response will inculde the AU from 26.04. to 30.04.

### Example 2: `start_work_incapacity` is after the AU start date of the health insurance

<Frame>
  <img alt="1762" />
</Frame>

The response will inculde the AU period, which is containing the
`start_work_incapacity` date. The AU response will be from26.04. to 30.04.

### Example 3: `start_work_incapacity` is before the AU start date of the health insurance

<Frame>
  <img alt="1762" />
</Frame>

If the health insurance has no starting or running AU for the specified
`start_work_incapacity` date it will check **5 days** into the future. In this
example the response will report the AU from 26.04. to 30.04.

### Example 4: Two AU periods - The `start_work_incapacity` date matches one of the AU periods

<Frame>
  <img alt="1762" />
</Frame>

The response will include the AU matching the `start_work_incapacity` date. In
this example the response will be from 26.04. to 30.04. The AU from 28.04. to
10.05 will be returned on a follow up request with the `start_work_incapacity`
date set to 01.05.

### Example 5: Two AU periods - The `start_work_incapacity` date matches both of the AU periods

<Frame>
  <img alt="1762" />
</Frame>

The response will include both AU periods.

### Example 6: Two AU periods - The `start_work_incapacity` date matches one of the AU periods

<Frame>
  <img alt="1762" />
</Frame>

The response will include the AU matching the `start_work_incapacity` date. In
this example the response will be AU-period 2 from 28.04. to 10.05. The AU
period 1 (from 26.04 to 30.04) will not be included.

### Example 7: Two AU periods - The `start_work_incapacity` date is between the start dates of both AU periods

<Frame>
  <img alt="1762" />
</Frame>

The response will only include AU period 1 from 26.04. to 30.04.

### Example 8: Two AU periods - The `start_work_incapacity` date is before both start dates of the AU periods

<Frame>
  <img alt="1762" />
</Frame>

If the request was sent before the AU period 2 was available for the health
insurance (e.g. on the 27.04.), the response will only include AU period 1 from
26.04. to 30.04. Otherwise the response will include both AU periods.

### Example 9: Two AU periods - The `start_work_incapacity` date is before both start dates of the AU periods

<Frame>
  <img alt="1762" />
</Frame>

In this example the start date of the AU period 2 is exactly 5 days after the
`start_work_incapacity` date. Therefor the response will only include AU periods
1 from 26.04. to 30.04.

### Example 10: Delayed eAU processing

<Frame>
  <img alt="1762" />
</Frame>

If the health insurance has no AU for the available for the
`start_work_incapacity` date it will respond with flag\_current\_work\_incapacity =
4\. After receiving the AU on the 29.04 (within the 14 day window) the status
will update and return the AU from 26.04. to 30.04.

### Example 11: Two AU periods - Delayed eAU processing of the first AU

<Frame>
  <img alt="1762" />
</Frame>

Due to technical issues (e.g. internet outage at the doctor's office) the first
AU-period was not processed until the 29.04. The status for the request on the
27.04 will be flag\_current\_work\_incapacity = 4. On the 28.04 the follow up
certificate will be available and the status will be updated to the AU from
28.04. to 10.05. This finalizes the eAU request and the initial AU will not be
returned.


# Getting Started
Source: https://docs.kombo.dev/hris/datev/datev-integration

Learn how to set up a DATEV integration with Kombo.

# Good to know

Our DATEV integration is available on selected plans only. Please contact your dedicated solutions contact or our support team if you are interested.

#### DATEV Variants

Kombo currently offers 2 distinct DATEV integration variants:

* DATEV HR
* DATEV Lohnaustauschdatenservice (we call this DATEV LAUDS from here onwards)

The primary difference is the underlying API they use to synchronize employees into Kombo. DATEV HR uses the [Lohnergebnisdatenservice API](https://developer.datev.de/de/product-detail/hr-exports/1.0.0/overview), which means it has access to payroll results on a monthly basis. DATEV LAUDS uses the [Lohnaustauschdatenservice API](https://developer.datev.de/de/product-detail/hr-exchange/1.0.0/overview), which means it has real-time access to the data in the payroll tool.
DATEV LAUDS syncs faster, has access to more data points (e.g. email addresses, salary types, ...) and comes with an easy-to-use write API. We recommend most new customers to use our new DATEV LAUDS integration.

#### DATEV LAUDS limitations

For the following use cases we recommend you to use our DATEV HR integration:

* You require historical salary information (coming to LAUDS soon).
* You want to exclusively use the DATEV ASCII write interface and your end customers are very price sensitive (DATEV HR is 15 cents cheaper per employee per month for the end customer).

Everyone else should use or migrate to the new DATEV LAUDS variant.

#### Implementation

Integrating with DATEV can be both challenging and rewarding. If you are planning to undertake a DATEV integration, we encourage you to reach out to us for assistance. For our enterprise-tier clients, we offer comprehensive support throughout the integration process. This includes help with generating the necessary files, explaining key concepts, and providing insights that are often overlooked. We also offer testing sessions and access to our production testing environment.

# Connecting DATEV integrations

### Creating a sandbox integration

To develop your integration with Kombo, you will connect DATEV at least a few times. DATEV offers a sandbox with some sample development data. Here is everything you need to know about that.

Call our [Create link](/hris/v1/post-connect-create-link) endpoint. Specify the tool `datevhr` and enter the `remote_environment` `SANDBOX`. The other parameters are up to you. This will create a link to connect a DATEV sandbox account. Find the credentials for that here:

#### In Kombo Connect

* System: `any`
* Consultant ID (Berater Nummer): `455148`
* Client ID (Mandanten Nummer): `1`

#### In the DATEV popup

* Select login with **DATEV Benutzerkonto**
* Username: `Test6`
* Password: `bTomu4cTKg`

<Tip>
  On our DATEV plan you can request us to connect a production instance with
  your dev environment. The production instance offers a bigger sample of
  example-employees and payslips than the DATEV sandbox.
</Tip>

For development with DATEV LAUDS we recommend to use the credentials above only
for testing the connection flow/setup. The example data contained in this sandbox,
is not suited for any read/write implementation. We will provide your with our
production equivalent sandbox instead, which is included in your Kombo contract,
if you have the DATEV option.

### Creating a production integration

A detailed guide that you can share with your customer is available [here](https://help.kombo.dev/hc/en-us/articles/27472113295121-DATEV-Wie-stelle-ich-eine-Verbindung-mit-DATEV-her).

Since customers usually don't have direct access to their DATEV instance (managed by their tax consultant), the consultant must enable specific DATEV services to access the required APIs. These services come with a nominal cost, typically passed on to the customer. Based on your [scope config](/hris/features/scopes) a combination of the following services is required:

* DATEV Lohnergebnisdatenservice (read payroll data)
* DATEV Lohnimportdatenservice (write payroll data)
* DATEV Lohnauswertungsdatenservice (read documents/payslips)
* DATEV Lohnaustauschdatenservice (read and write data in realtime + eAU)

We recommend having the tax consultant enable these services and provide the necessary credentials. Afterward, your customer can schedule a call to set up the connection together. While this process may seem complex, we see a high conversion rate, as tax consultants are typically well-versed in DATEV and benefit from the integration.

# Reading data from DATEV

DATEV can be used as the source of truth for employee data. It is particularly useful for tax-relevant and compensation data. However, it is important to note that some commonly required fields, such as email addresses and phone numbers, cannot be read from DATEV with the DATEV HR variant.

Also, data with DATEV HR changes infrequently, usually once per month when the payroll run is done. Data is only available after a payroll run. This limitation may restrict the integration's usefulness for many HRIS use cases.
DATEV LAUDS, on the other hand, is a real-time data mirror of the underlying DATEV software. You will be able to read updates whenever the payroll clerks change the data and the sync finishes.

### Read employee data through unified API

You can fetch employee data from DATEV using our unified [GET employees endpoint](/hris/v1/get-employees). The endpoint will return all employees that are available in DATEV.

For some DATEV usecases you may want to [extend our model](/extending-the-model) for example with tax relevant data. You can use [custom fields](/hris/features/custom-fields) to achieve this.

You can also use [remote data](/hris/getting-started/remote-data) to see all the available data. You can also reach out to our support to adjust our remote data model so it returns the data for all available months, which is particularly relevant for analytics.

### Documents / payslips

Documents can be downloaded with [this endpoint](/hris/v1/post-datev-employees-employee-id-download-document). The response contains a download link to the document.

The endpoint requires you to submit the `employee_id`. Alternatively you can passthrough a `remote_id` / Personalnummer by using `remote:{Personalnummer}`.

The accounting month and the document type are also required. A list of available document types can be found [here](https://developer.datev.de/en/product-detail/hr-payrollreports/2.0.0/documentation). Most common is payslips and the document type is `LOBN`.

### eAU

The electronic sick certificate is now available for publicly insured employees. Using our eAU API you can validate sick leaves. We offer the following endpoints:

* [check if eAU is available](/hris/v1/get-datev-check-eau-permission)
* [create eAU request](/hris/v1/post-datev-employees-employee-id-eau-requests)
* [check eAU status](/hris/v1/get-datev-eau-requests-eau-id)

We wrote a detailed guide about the eAU process [here](/hris/datev/datev-eau).

# Writing data to DATEV

### Submitting the data to DATEV

Writing data to DATEV is done by one of two ways:

* LAUDS JSON API
* Legacy ASCII Interface

Kombo customers will get exclusive access to our extended DATEV LAUDS API documentation, including field requirements, dependencies and implementation recommendations. We currently offer documentation for the following use cases:

* Creating employees
* Updating employees
  * including compensation adjustments
  * including termination
* Submitting work hours/timesheets
* Submitting absences

The corresponding endpoint is available through our [passthrough endpoint](/hris/v1/post-passthrough-tool-api).

Some use cases require access to tables and fields not available in the LAUDS API. For these we will assist you in generating ASCII files in DATEVs proprietary format. You can generate such files based on our use-case specific ASCII write documentation.
Examples would be: bAV, company cars or bikes.

Afterwards you can submit the files to DATEV using the [POST ASCII endpoint](/hris/v1/post-datev-passthrough).

The necessary information to generate the file can be queried with the [GET system-information endpoint](/hris/v1/get-datev-system-information).

ASCII writes require the tax consultant to have enabled the DATEV Lohnimportdatenservice. Since that is a separate service, you can check whether an integration (DATEV HR or DATEV LAUDS) can submit ASCII files with the [check write permission endpoint](/hris/v1/get-datev-check-write-permission). JSON writes through the LAUDS API use the Lohnaustauschdatenservice that every DATEV LAUDS integration connects with, so they are always available on DATEV LAUDS and don't need this check.

<Note>
  Please note that DATEV HR can't read if the payroll run was already completed
  in DATEV for the specified month, so it might be possible that you submit data
  that can't be taken into account anymore. In this case, your customers' tax
  consultant should look into the necessary corrections.
</Note>

### Importing data in DATEV

For DATEV LAUDS, the data gets imported automatically. If the tax advisor has the client already opened at the time of the data transfer, they need to close and reopen the program to see the changes.

For the ASCII import, there are a few steps to import the files.
First, open the `Daten Übernehmen` function and select `ASCII-Import` (the actual files are not in ASCII)

<Frame>
  ![](https://files.readme.io/7e7779c-image_2.png "Importing files in DATEV")
</Frame>

When the form is open, instead of selecting a file `Aus dem Rechenzentrum abrufen (Lohndatenimportservice)`. Now the user should be able to see all the files that were submitted.

![](https://files.readme.io/dc1c65e-811173466fcc02bb1cace86e9db6349db95ed57d6de8d99ae4dcf59c1cb72c5c.png "LODAS file import window")

#### Tracking if files were imported

Our integration tracks if files that were submitted to DATEV were imported. Call our [Get data pushes](/hris/v1/get-datev-data-pushes) endpoint to receive all recent files with their status.


# FAQ
Source: https://docs.kombo.dev/hris/faq

Frequently Asked Questions

#### Do I have to wait for the first sync to complete?

Yes, during the first sync, customers will need to wait for the process to complete before accessing the latest data. The duration of the first sync depends on the amount of data being synchronized and the efficiency of the data transfer process. Kombo's system will handle the sync and can notify you when it's finished via a webhook.

#### How long does the first sync take?

The duration of the first sync can vary based on factors such as the volume of data (which is influenced by [your scopes](./features/scopes)), network conditions, and the bulk export capabilities of the target system's API.

Generally, you can expect initial syncs to take **just a few minutes** for most integrations. A major exception to this are syncs involving large amounts of historical data. If you, for example, connect a large ATS instance with hundreds of thousands of applications, an initial sync might take **up to several hours** depending on the system.

In these cases, we'd recommend thinking about whether you can reduce the data points you're syncing and [adapting your scope config](./features/scopes). As a job board, you might, for example, only need to [access the applications that you created](/ats/features/application-status-tracking#syncing-only-created-candidates).

#### What should I show my customers during the first sync?

During the very first sync, you should display an informative message to users about the ongoing data update and reassure them that the app is actively fetching and updating data with a loading state or progress indicator.

#### What happens when I change my Kombo scope configuration?

The [Kombo scope configuration](./features/scopes) lets you control the data you read from your customers' systems and communicate this information when they are setting up their integrations.

But once the connection is established, your customer will **not** be forced to accept new changes you made to the scope config. That's because changes to the scope config will often be made for purely technical reasons, like enabling a single new field we expose. In these cases, we don't want to force hundreds of end customers to reconnect their systems.

Thus, when planning to make significant changes to your Kombo scopes, you should communicate this with your customers in advance and give them enough time to react.

**Important note:** Most systems allow specifying specific permissions on the API credentials. If the API credentials don't grant permissions to a specific data point, changing the Kombo scope config can't expose any more data (but it will often make Kombo syncs fail because of authorization errors). In that case, you will actually have to ask your customer to enable the missing permissions on their API credentials to allow you reading those data points.

#### What time zone and format does Kombo use for times and dates?

We return times and dates in the UTC time zone and in the standard UTC format (ISO 8601).


# Audit Logs
Source: https://docs.kombo.dev/hris/features/audit-logs

Audit sensitive changes to your Kombo environment.

## Use Case

Audit logs are essential for maintaining compliance and security within your
organization. They provide a detailed record of actions taken within your
Kombo environment, helping you track changes, identify unusual activity,
and ensure accountability.

## Accessing Audit Logs

You can access audit logs through the
[Audit Logs section in the Dashboard](https://app.kombo.dev/audit-logs).
Logs are environment-specific, so make sure to select the appropriate environment.
The dashboard allows you to query logs using the provided filter functionality.

<Frame>
  <img alt="Audit Logs Screenshot" />
</Frame>

## Limitations

Audit logs are available only on and above the scale plan and are retained for
one year, with retention periods of up to three years available on higher plans.
Custom retention policies and automated access to logs are
available on larger plans. If you require these customizations,
please contact Customer Success for assistance.


# Create Employee
Source: https://docs.kombo.dev/hris/features/create-employee

Streamline employee onboarding with a dynamic form-based solution for creating employee records in connected HRIS systems.

## Overview

The **Create Employee** feature enables you to create new employee records in a connected HRIS with a structured, simplified approach. Instead of manually building separate integrations for each HRIS system, this feature dynamically generates forms based on the specific requirements of the connected system.

## Key Benefits

* **Unified Integration**: Use a single API to create employees across any supported HRIS
* **Dynamic Form Generation**: Automatically retrieve the required fields for each HRIS
* **Smart Field Mapping**: Map your existing data to HRIS fields using unified keys
* **Validation Built-in**: Form schema includes validation rules to ensure data accuracy
* **Intuitive UI Support**: Guidelines for building user-friendly interfaces

## How It Works

1. **Fetch Form Schema**: Retrieve a dynamic schema from the connected HRIS that defines all required and optional fields
2. **Auto-map Fields**: Use unified keys to automatically map standard fields (name, email, etc.) from your data
3. **Collect Missing Data**: Generate UI components to collect any additional required information
4. **Submit Data**: Send the validated data to create the new employee record

## Implementation

This feature is implemented through two primary endpoints:

<CardGroup>
  <Card title="Get Employee Form" icon="align-left" href="/hris/v1/get-employees-form">
    Retrieve the form schema for a connected HRIS with required fields and
    validation rules.
  </Card>

  <Card title="Create Employee" icon="user-plus" href="/hris/v1/post-employees-form">
    Submit the populated form data to create a new employee record in the HRIS.
  </Card>
</CardGroup>

The form schema includes detailed information about each field:

* Field type (text, number, date, select, etc.)
* Validation rules (required, min/max values)
* Unified keys for standard fields
* Description and labels

## Getting Started

To implement this feature in your application:

1. Set up a connection to an HRIS via [Kombo Connect](/hris/guides/connect/introduction)
2. [Fetch the form schema](/hris/v1/get-employees-form) for the connected HRIS
3. Build a UI that displays the required fields and collects user input
4. [Submit the populated form data](/hris/v1/post-employees-form) to create the employee

<Card title="Detailed Implementation Guide" icon="book-open" href="/hris/implementation-guide/create-employee">
  Ready to implement? Our detailed step-by-step guide covers everything from
  setting up connections to handling field mapping and validation.
</Card>

<Card title="Hiring into Positions & Requisitions" icon="briefcase" href="/hris/implementation-guide/staffing-entities-in-create-employee">
  For enterprise HRIS systems (Workday, UKG Pro, SAP SuccessFactors), hires
  typically need to target a specific position or requisition. Learn how to use
  staffing entities to scope the form and place employees into the correct org
  slot.
</Card>


# Create and read absences
Source: https://docs.kombo.dev/hris/features/creating-absences

Learn how properly utilize the Absence functionality.

The Time Off endpoints unify the reading, creating and deleting of absences
across all supported HRIS integrations.
This document describes what to look out for when using these endpoints.

## Basics

When dealing with absences, there are three relevant concepts:

* **Absences** are time-spans when an employee is absent. They are
  specific to an employee and are at minimum characterized by a `start_date` and
  an `end_date`.
* **Absence types** define what kind of absences an employee can request. They
  have a name and can have additional properties, such as whether absences of this
  type are in hours or days. An example absence type is 'Vacation'.
* **Time off balances** (often called vacation or holiday accounts) represent the balance a specific employee has for
  a particular absence type. For example, an employee with a balance of 15 days for the
  absence type 'Vacation' can request 15 days of vacation. At that point, the
  balance will be reduced to 0 and no more 'Vacation' absences can be created.

## Absence Types in Detail

Absence types have to be submitted when creating an absence. They hold useful
information about the absence type and are supported by almost all HRIS systems.

## Time Off Balances in Detail

Some instances might have dozens of absence types and usually an individual
employee is restricted to only a few. You can find out which absence types are
available for a specific employee by retrieving
[the time off balance](/hris/v1/get-time-off-balances) for that employee. If the
absence type has an associated time off balance for a given employee, and the
balance is greater than 0, then the employee can request an absence of that type.

<Note>
  Not all tools support [time off balances](/hris/v1/get-time-off-balances). If
  they are not supported by a tool, expect all absence types to be available for
  all employees.
</Note>

## Explaining absence type properties

Each absence type has a few fields that specify how absences of its type work.
Let's review them:

### `half_days_supported`

Some systems support half days (i.e. the ability to request half a day, e.g.,
'Wednesday morning' or 'Wednesday afternoon' off). If this is the case, you can
specify whether you want to use half days or not when creating an absence.

### `exact_times_supported`

Some systems support exact times. If this is the case, you can specify
a start and end time for your absence.

### How do these properties interact?

In many systems these `half_days_supported` and `exact_times_supported` are
independent of each other.

For example, if the absence type supports half-days, it doesn't necessarily mean
that exact times are supported. As many HRIS don't offer these kinds of
guarantees, we can't offer them either.

## Creating Absences

<Note>
  Some HRIS apply additional validation rules to requested absences, for example
  they might not allow you to create an absence that starts on a weekend. In
  these cases we will either return an error message that explains the problem
  or we return the error message from the HRIS system.
</Note>

When creating an absence, you have to specify the following parameters:

### `employee_id`

The ID of the employee for whom you want to create the absence.

### `absence_type_id`

The ID of the absence type you want to use.

### `start_date` and `end_date`

This defines the duration of the absence. These fields have the `YYYY-MM-DD`
format.

### `start_half_day` and `end_half_day`

If the absence type supports half days, you can specify whether you want to
use half days or not. If you don't want to use half days, you can omit these
parameters.

### `start_time` and `end_time`

If the absence type supports exact times, you can specify the start and end
time of the absence. If you don't want to use exact times, you can omit these
parameters.

### `amount` and `unit`

These parameter define the amount of time that the absence will count as
with regards to the time off balance of an employee. This
feature is only available for few HRIS systems. We recommend not using it
unless there is no alternative.

## Reading absences

### How should I interpret half days when building, e.g., a calendar UI?

We recommend displaying half-days as 4.5 hour blocks based on the typical start
and end time of your customer's workday, assuming a typical 8-hour workday with
one hour of lunch break.

If your customers are based in different timezones or
a single customer may have offices within different time zones, we
recommend trying to infer the time zone based on the office location (either
based on the associated [legal entity](/hris/v1/get-employees#:~:text=%227E2gyuv6TmvtByzBxW9Sxt53%22%2C-,%22legal_entity_id%22,-%3A%20%22xB32bied320csBSsl3XWdlw33%22) or the [work
location](/hris/v1/get-employees#:~:text=%7D%0A%20%20%20%20%20%20%20%20%5D%2C-,%22work_location%22,-%3A%20%7B%0A%20%20%20%20%20%20%20%20%20%20%22id)
of an employee).
It is not possible to tell at what exact time the half-day starts - you
need to make an assumption based on your business context.


# Custom Fields
Source: https://docs.kombo.dev/hris/features/custom-fields

Learn how to extend Kombo's unified data models with additional fields.

## What are Kombo custom fields?

Kombo's unified models cover the fields that are standard across HR, ATS, and other business systems. When your product needs additional read-side data, custom fields let you extend those models with your own stable field keys.

For example, you might add `t_shirt_size` to employees, `benefit_eligibility` to employments, or `source_campaign` to applications. Once a custom field is configured and mapped, Kombo returns it in the `custom_fields` object of the relevant API response.

This makes custom fields a good fit whenever you need a data point that is not part of Kombo's standard unified model, but you still want to read it in an integration-agnostic way.

<Info>
  Custom fields are for **reading** additional data from connected systems.
  Looking to **write** extra data when creating candidates or applications? See
  [Remote Fields](/extending-the-model#remote-fields). For a full comparison of
  all extension mechanisms, see [Extending the Model](/extending-the-model).
</Info>

## How mappings work

A Kombo custom field is the target field that appears in your API response. A field from the connected system is the source field that provides the value for a specific integration.

The source field can be anything Kombo can discover from the connected system: a standard field in that system, a niche provider-specific field, or a custom field that your customer created in their HR or ATS tool.

For example:

* A Personio employee attribute called **"Favorite Color"** can be mapped to your Kombo custom field `favorite_color`.
* A provider-specific employee field for cost center, employment type, or benefit eligibility can be mapped to a Kombo custom field if your product needs that value and Kombo's standard model does not expose it exactly the way you need.
* Different customers can use different field names, such as **"Favorite Color"** and **"Favourite Colour"**, while your API integration always reads the same Kombo key.

## Setting up custom fields in Kombo

### Create the Kombo custom field

Open [the Dashboard](https://app.kombo.dev/) and click on **Configuration** in the sidebar, then on the **Custom Fields** tab.

<Frame>
  <img
    alt="Custom fields empty
state"
  />
</Frame>

Find the relevant data model on the page. In this example, we want to add a field to employees, so click **Add custom field** in the **Employees** section.

<Frame>
  <img
    alt="Create custom field
dialog"
  />
</Frame>

Enter the field key that should appear in the API response. Let's call it `favorite_color`. The field key you choose here becomes the key in the `custom_fields` object of every mapped record.

### Prepare the field in the connected system

Sometimes the field you want to map already exists in the connected system. In other cases, your customer may first need to create or expose it there.

Let's take Personio as an example where the source field is a custom attribute in the HR system.

Under **Settings > Employee Information**, you can add new attributes or entire sections to employee profiles. We will add a new attribute called **"Favorite Color"** to the **"Public Profile"** section.

<Frame>
  <img alt="image" />
</Frame>

If we now go to the profile of an employee, we can see the new field. Let's set a value for it.

<Frame>
  <img alt="image" />
</Frame>

In the case of Personio, we need to let the API key know that we want to expose the new attribute. Go to **Settings > API Credentials**, click on the API key you used to connect to Kombo, then open the **"Readable employee attributes"** section and select the field.

<Frame>
  <img alt="image" />
</Frame>

Don't forget to click **save**.

### Map fields manually

To map a field manually, open the overview for the integration. Kombo discovers available fields during syncs, so run a sync first if the field is new or has not appeared yet.

After the sync is finished, open the custom field dropdown for the relevant model and select the field from the connected system that should fill your Kombo custom field.

<Frame>
  <img
    alt="Custom field mapping
dropdown"
  />
</Frame>

Don't forget to click **Save changes** to save your changes. After creating the mapping, the next sync will read the source value and return it under your Kombo custom field key.

<a />

### Map fields based on live data

For supported integrations, the custom field dropdown also includes a recommended option to **Identify field using live data** (see screenshot above). Click **Open Custom Field Explorer** to search the connected system directly and find the field based on real records.

<Frame>
  <img alt="Custom Field Explorer" />
</Frame>

This is useful when the field name is unclear, or when you know an example value but not the exact field key. For example, you can search for an employee with the value **"Large"** to find the field that stores T-shirt size, then map that field to your Kombo custom field.

If the Explorer is not available for an integration yet, use the regular dropdown mapping flow described above.

### Add automatic mapping rules

On the custom field detail page, you can see how many integrations use the field and which **automatic mapping rules** are defined for it.

Automatic mapping rules tell Kombo which fields of new integrations should automatically be mapped to this Kombo custom field. Each rule matches against a field key or label and can optionally be scoped to a connector. You can add as many rules as you need.

Click **Add rule** to create a new automatic mapping rule.

<Frame>
  <img
    alt="Automatic mapping rules empty
state"
  />
</Frame>

In the dialog, choose whether the rule should apply to one connector or every integration in the category. Then choose whether Kombo should match against the remote field's key or label, and enter the value to match.

<Frame>
  <img
    alt="Create automatic mapping rule
dialog"
  />
</Frame>

Whenever a sync discovers a field in an integration whose key or label matches one of your rules, its value is automatically mapped to your Kombo custom field. Going back to the Personio example: if you had set up a rule for **"Favorite Color"** scoped to Personio, the next Personio sync would have automatically mapped the value to `favorite_color`.

## Self-Serve Custom Field Configuration

To simplify the mapping process, you can allow your customers to map fields themselves using our self-serve **Setup Flow**. This is especially useful when your customer knows best which field in their system contains the value your Kombo custom field should receive.

Custom fields can be mapped as part of the connection, reducing the need for manual setup.

[Learn more about enabling self-serve field mapping here.](./setup-flow/introduction)

## Accessing custom fields in the API

Each model that supports custom fields has a `custom_fields` attribute. This attribute is a JSON object containing all mapped Kombo custom fields for that record.

When you query the API, you receive mapped custom field values in the `custom_fields` attribute. In this example, we query the [GET /employees](/hris/v1/get-employees) endpoint.

The value of a custom field mirrors what is returned by the underlying API. It is not always a string; it can also be a number, boolean, object, or array.

```json {7-17} theme={null}
{
  "status": "success",
  "data": {
    "results": [
      {
        ...
        "custom_fields": {
          "favorite_color": "blue",
          "manager": {
            "name": "Frank"
          },
          "reports": [
            {
              "name": "Tom"
            }
          ]
        }
      }
    ]
  }
}
```


# Data Explorer
Source: https://docs.kombo.dev/hris/features/data-explorer

Interact with customer data from a convenient UI in the Kombo dashboard.

## Overview

The Data Explorer is a visual layer on top of Kombo's unified API. It allows
you to view and search for data entries and execute all write actions from a
convenient UI in the Kombo dashboard.

This allows you to easily debug issues with your integrations, develop new
features, and test changes with your customer's data or your sandboxes.

<Frame>
  <img />
</Frame>

## Features

Below a few examples showing what you can do with the Data Explorer.

<AccordionGroup>
  <Accordion title="View data">
    You can view any data field of any data model
    on the Kombo API in the Data Explorer. This includes employees, groups,
    work locations, legal entities, org hierarchy and structure, absence
    information and all their relations to each other.

    <Frame>
      <img />
    </Frame>

    <Frame>
      <img />
    </Frame>

    <Frame>
      <img />
    </Frame>

    <Frame>
      <img />
    </Frame>
  </Accordion>

  <Accordion title="Modify data (e.g. creating absences and employees)">
    You can run any write action supported by the Kombo API in the Data
    Explorer. This includes creating employees and absences, deleting absences
    and adding documents to employees.

    Documents can be added to employees by clicking the three dots menu on the
    employee and selecting "Add document to employee".

    <Frame>
      <img />
    </Frame>

    Absences can be created by selecting a time period in the calendar view.
    Absences can be deleted by selecting an existing absence and clicking the
    delete button.

    <Frame>
      <img />
    </Frame>

    Employees can be created by navigating to the "Create employee form" page.

    <Frame>
      <img />
    </Frame>
  </Accordion>

  <Accordion title="View available custom fields">
    For supported models you can view all
    [available custom fields](./custom-fields#map-fields-based-on-live-data) in
    the Data Explorer. This feature is currently only implemented for some
    integrations.

    You can access it either from the custom fields card on a data entry or from
    the three dots menu under **Fetch live data**.

    <Frame>
      <img />
    </Frame>

    A window will open, showing all available custom fields for the data entry.

    <Frame>
      <img />
    </Frame>
  </Accordion>
</AccordionGroup>

## How It Works

The Data Explorer is a feature built on top of the Kombo API. It allows you to
interact with the Kombo API in a convenient UI in the Kombo dashboard. All
integration-specific read and write actions that are possible via the Kombo API
are available in the Data Explorer.

## Where to find the Data Explorer

The Data Explorer is located within individual integration pages in the Kombo
dashboard:

1. **Go to Integrations**: Navigate to the [Integrations page](https://app.kombo.dev/integrations) in your dashboard
2. **Select an Integration**: Click on any connected integration from your list
3. **Access Komboman**: Click the "Data Explorer" tab in the integration interface

<Frame>
  <img />
</Frame>

## Access Permissions

The Data Explorer is available to:

* **Production Environment**: Users with admin role
* **Development Environment**: Users with admin or developer role


# Deletion Policy
Source: https://docs.kombo.dev/hris/features/deletion-policy

Understand how Kombo deletes data.

## General

Kombo prioritizes privacy and security by cleaning up any data that is no longer
used. We do that by following the deletion policies below. Kombo will not store
any sensitive data for longer than needed.

## Integration Data

### Case: an entry is not found anymore

When Kombo can't find an entry during a sync, we will mark it with
`remote_deleted_at` and 14 days later set all the fields to `null`.

### Case: an integration has been deleted

Kombo will delete all the data of an integration **14 days** after the integration
was deleted via API or UI.

### Case: scope config changed

**Field is turned off:** While running the next sync, Kombo will overwrite
the turned-off field for all entries with the value `null`.

**Model is turned off:** When a model gets turned off, Kombo will mark all entries with `remote_deleted_at`
and delete the entries after **14 days**.

***

## Logs

Kombo will delete statistics about syncs and write actions after **60 days**.

On all plans but the enterprise plan, Kombo will delete request data in the logs,
including the request and the response after **30 days**.


# Data deletion
Source: https://docs.kombo.dev/hris/features/filtering/data-policy

How we make our filtering feature compliant.

<Note>
  If you want to learn more about how we keep your data safe, visit our
  [security center](https://security.kombo.dev/).
</Note>

This article primarily discusses how we delete employee data that is out of scope with our [filtering feature](/hris/getting-started). We have invested in a data deletion process that ensures that Kombo and our customers are reading employee data in the most compliant way possible.

## Initial Sync

During the initial sync, which is the first sync of a new integration, we fetch all employees in the system to generate the criteria for filtering. If filtering is enabled for this connection, we won't sync any employee PII data into our database until the filters have been confirmed by the user in the filtering UI. This ensures that we only store the data that is necessary and compliant with the user’s requirements.

<img alt="Filtering feature enabled in connection flow" />

If filtering is disabled, we treat it as if the filters are set to include all employees and save everything in our database. However, we only save the fields that are enabled in the scope config. This means that even if we fetch all the data, only the relevant fields as per the scope configuration will be persisted in our database.

<img alt="Filtering feature disabled in connection flow" />

## Subsequent Syncs

For subsequent syncs, we still need to fetch all employees in the system because most tools we support do not give us the option to fetch only the employees that match the filters. Despite this, we only save the data of employees that match the setup criteria.

If an employee goes out of scope, we mark them as deleted and handle them according to our [deletion policy](/hris/features/deletion-policy). Specifically, the entry will be marked with **`remote_deleted_at`** and deleted after 14 days. This process ensures that no sensitive data is retained longer than necessary, maintaining compliance and data protection standards.

By adhering to these policies, Kombo ensures compliance and the protection of sensitive employee data.


# Introduction
Source: https://docs.kombo.dev/hris/features/filtering/introduction

Learn what the filtering feature is and when to use it.

The filtering feature allows your customers to specify which employees they wish to share based on criteria such as work location, employment type, departments, and more. It features a user-friendly configuration interface that you can expose to your customers. We only persist data that belongs to employees matching the configured filters afterward.

<img alt="Filtering UI" />

# Implementation

## Configuring the Filters

There are two ways to configure the filters: as part of the connection flow and as a standalone configuration.

### As Part of the Connection Flow

To enable filtering for a specific connection flow link, you can use the [create connection link endpoint](/hris/v1/post-connect-create-link) with `enable_filtering` set to `true`. Alternatively, you can do this in the dashboard by flipping the toggle in the connection link creation dialog.

<img alt="Filtering enabled" />

The filtering UI will open after completing the connection flow. Once the connection is successful, the integration will enter the `SETUP` state and remain there until the filters are configured or confirmed. If the connection flow is closed, you can reopen the old link, which remains valid until the filters are configured, or create a new provisioning link as described below.

### Standalone Configuration

You can also offer the filtering configuration as a standalone feature to set up filters for your existing integrations or to update filters at any time.
You can do this via API with the [create provisioning link endpoint](/hris/v1/post-provisioning-groups-group-id-setup-links) or in the dashboard at the bottom of any integration overview page.

<img alt="Configure Filters" />

### Custom Fields

Many customers have custom fields that they want to use for filtering. Common fields include `benefits_eligibility`, `seniority_level`, and `team_name`.
To enable filtering by custom fields, you must [map the fields beforehand](/hris/features/custom-fields). You can also enable your customers to map the custom fields themselves using our [field mapping UI](/hris/features/setup-flow/introduction#field-mapping)

### Active Filters

Once the filters are set, you can view and manage them on the integrations page of the dashboard.

<img alt="View active filters in the dashboard" />

## Querying the Data

After setting the filters, you can query the data through our API. Our [employees](/hris/v1/get-employees), [absences](/hris/v1/get-absences), and [employments](/hris/v1/get-employments) endpoints will return only the data that belongs to the employees matching the configured filters. However, we will still return all groups, legal entities, work locations, and teams, even if no employee belongs to them. The data is persisted as described [here](/hris/features/filtering/data-policy).

We recommend setting up [webhooks](/hris/guides/webhooks) and reacting to finished syncs to get the filtered data back to your system. By using our `updated_after` and `include_deleted` query params, you can significantly decrease your ingress for big integrations. Employees that go out of scope are treated as deleted.


# Integration Fields
Source: https://docs.kombo.dev/hris/features/integration-fields

Learn how to use integration fields to read additional data properties from your customer's systems.

<Warning>
  The Integration Fields API was built for a very specific niche use case. This
  is likely not what you want to use. See [Custom Fields](./custom-fields)
  instead.
</Warning>

## What is an integration field

An integration field is a field returned from the raw response of the remote system.

## Setting up integration fields in Kombo

Before we set up the integration field in Kombo, let's talk about how you will receive the data.

Each model that supports integration fields has an `integration_fields` attribute. This attribute is an Array of JSON objects that contains all selected integration fields. We will discuss how to select integration fields in a [later step](#selecting-an-integration-field).

### View available integration fields

To list which integration fields are available for a specific integration, you should use our [GET integration-fields](../v1/get-integrations-integration-id-integration-fields) endpoint.

Example response:

```JSON theme={null}
{
    "status": "success",
    "data": {
        "results": [
            {
                "id": "123AbcDEFG4hijK5Lmn67OPq",
                "key": "dynamic_5487319",
                "model": "hris_employees",
                "type": "CUSTOM",
                "label": "Name of health insurance",
                "is_passthrough_enabled": false
            },
            ...
        ]
    },
    "next_cursor": null
}
```

If your array is empty or does not contain the values that you are looking for, double check if "integration fields" is enabled for the specific model in your [scope config](https://app.kombo.dev/scope-config).

<Note>
  Please note that this endpoint is paginated, featuring a default page size of
  250 and a maximum page size of 2000 (specified via the `page_size` parameter).
</Note>

### Selecting an integration field

To select an integration field to be passed through, use the [PATCH integration-fields](../v1/patch-integrations-integration-id-integration-fields-integration-field-id) endpoint.

An example payload would look like this:

```JSON theme={null}
{
    "enable_passthrough": true
}
```

Example response:

```JSON theme={null}
{
    "status": "success",
    "data": {
        "id": "123AbcDEFG4hijK5Lmn67OPq",
        "key": "dynamic_5487319",
        "model": "hris_employees",
        "type": "CUSTOM",
        "label": "Name of health insurance",
        "is_passthrough_enabled": true
    }
}
```

After successfully enabling passthrough on an integration field, the **next sync** will collect the values for the selected field and save them. These values then become part of our API response as follows:

## Getting integration fields as part of the API response

When you query the API, you will receive any selected integration fields in the `integration_fields` attribute. In this case, we query the [GET /employees](/hris/v1/get-employees) endpoint.
The value of an integration field mirrors what is returned by the underlying API (i.e. it's not always a `string` but can be a `number` or even an `object` too).

```JSON theme={null}
{
  "status": "success",
  "data": {
    "results": [
      {
        "first_name": "Frank",
        ...,
        "integration_fields": [
          {
            "id": "123AbcDEFG4hijK5Lmn67OPq",
            "key": "dynamic_5487319",
            "type": "CUSTOM",
            "value": "National Health",
            "label": "Name of health insurance"
          }
        ],
        ...
      }
    ]
  }
}
```


# Issue types
Source: https://docs.kombo.dev/hris/features/issue-types

All customer-visible issue types Kombo can raise, and when they are created and resolved.

Kombo [raises an issue](./issues) when a condition is true and resolves it when that condition clears. This page lists every customer-visible type. Internal-only types are not included.

`issue.type` on the [`issue-status-changed`](../guides/webhooks#issue-status-changed) webhook is the identifier shown under each heading. We add types over time, so your handler should treat `issue.type` as an open set and not fail on unknown values.

## Authentication failed

Type: `integration.authentication_failed`

Raised when Kombo cannot authenticate with the connected tool. That happens when a sync's connection test fails with an authentication error, or when a scheduled OAuth credential refresh fails because the credentials are invalid. Rate limits during a sync do not raise this issue.

Resolved when a later sync successfully tests the connection, or when OAuth credentials refresh successfully.

## Action failing

Type: `integration.action_failing`

Raised when at least 50% of the finished calls for a specific action on an integration have failed in the last 24 hours, and there have been at least 5 finished calls in that window. Kombo checks this after each action call.

Resolved when a later check finds fewer than 5 finished calls in the window, or a failure rate below 50%. If the action is not called again, the issue also resolves 24 hours after it was last raised.

## Incoming webhooks failing

Type: `integration.incoming_webhook_failing`

Raised when at least 50% of the incoming webhooks for an integration have failed in the last 6 hours, and there have been at least 5 incoming webhooks in that window. Kombo checks this after it receives a webhook from the tool.

Resolved when at least 5 incoming webhooks in the last 6 hours have a failure rate below 50%. It stays open if webhooks stop, or if fewer than 5 have arrived in the window.


# Issues
Source: https://docs.kombo.dev/hris/features/issues

See which integrations need attention, and how long the problem has been going on.

When an integration starts failing, you want to know about it before your customer does. Issues put those problems on the dashboard as soon as Kombo observes them, so you can act before the end customer complains.

<Frame>
  <img alt="Issues column on the integrations list" />
</Frame>

The integrations list shows an issue count on any integration that currently has an open issue. Hover the count to see the title and how long Kombo has been observing it.

Open the integration to read what is wrong and what to do next.

<Frame>
  <img alt="Issue details on an integration" />
</Frame>

## What an issue is

Kombo's issues track a problem of an integration over time. Kombo raises them when a condition is true (for example, authentication is failing) and keeps it open while that condition is still observed. When the condition clears, the issue resolves on its own.

Each issue tells you:

* what is broken
* how to investigate or fix it
* when Kombo first observed it, and when it last saw it again

See [all issue types](./issue-types) for when each one is raised and resolved. More types will follow.

## What to do when you see one

1. Open the integration from the list.
2. Read the issue. Follow the linked [logs](./logs) if you need the underlying requests.
3. If credentials are invalid, [reconnect the integration](../guides/connect/reconnection).

The [integration state](../guides/integration-states) on the same page is the current snapshot (`Active`, `Sync failing`, `Authentication failing`). The issue is the durable record that the problem is still happening, and for how long.

You can snooze an issue to hide it in the Kombo dashboard for a while. Snoozing only affects the UI. The issue stays open, Kombo keeps observing it, and it does not send an [`issue-status-changed`](../guides/webhooks#issue-status-changed) webhook.

Subscribe to that webhook to get raised and resolved events as they happen. Slack notifications will follow.

<CardGroup>
  <Card title="Issue types" icon="list" href="./issue-types">
    When each issue type is raised and resolved.
  </Card>

  <Card title="Logs" icon="scroll" href="./logs">
    Inspect the requests behind a failing sync or action.
  </Card>

  <Card title="Reconnecting" icon="arrow-rotate-right" href="../guides/connect/reconnection">
    Restore credentials when authentication has failed.
  </Card>

  <Card title="Integration states" icon="traffic-light" href="../guides/integration-states">
    Read the current operational status of an integration.
  </Card>

  <Card title="Webhooks" icon="webhook" href="../guides/webhooks#issue-status-changed">
    Get raised and resolved issue events as they happen.
  </Card>
</CardGroup>


# Komboman
Source: https://docs.kombo.dev/hris/features/komboman

Test and troubleshoot both Kombo API and passthrough API calls with our built-in API client.

## Overview

Komboman is a powerful API testing tool built directly into the Kombo dashboard that allows you to test, explore, and troubleshoot both Kombo's unified API endpoints and integration-specific passthrough API calls. It provides a convenient way to interact with APIs without requiring you to provide any authentication credentials.

<img alt="Komboman" />

## Key Benefits

* **Test Kombo API Endpoints**: Validate Kombo's unified API responses and test data models directly
* **Test Passthrough Functionality**: Quickly verify the functionality of integration-specific API endpoints
* **Troubleshoot Data Quality Issues**: Identify and resolve data format or content issues directly
* **Self-Service Debugging**: Diagnose and resolve API issues independently
* **Request History**: Save and revisit previous API requests for reference and troubleshooting
* **Simplified Authentication**: No need to manage API keys or tokens separately - we handle the authentication

## Supported API Types

### Kombo API

Test Kombo's unified API endpoints directly from the dashboard, including all HRIS, ATS, and general endpoints like `/hris/employees`, `/ats/jobs`, `/ats/applications`, `/integrations/{integration_id}`, etc. Automatic authentication and audit logging are included.

### Passthrough APIs

Test integration-specific APIs for connected tools to access native functionality not covered by unified endpoints and debug integration-specific issues.

## How It Works

Komboman provides an intuitive interface for working with both API types:

1. **Select API Type**: Choose between "kombo" (unified API) or integration-specific passthrough APIs
2. **Configure Request**: Set the HTTP method, path, query parameters, and body for your request
3. **Send and View Responses**: Instantly see the API response, including status codes and data
4. **Save Request History**: Automatically save your requests for future reference

## Where to Find Komboman

Komboman is located within individual integration pages in the Kombo dashboard:

1. **Go to Integrations**: Navigate to the [Integrations page](https://app.kombo.dev/integrations) in your dashboard
2. **Select an Integration**: Click on any connected integration from your list
3. **Access Komboman**: Click the "Komboman" tab in the integration interface

<img alt="Komboman" />

## Getting Started

To use Komboman:

1. Select the desired API from the dropdown:
   * **"kombo"** - Test Kombo's unified API endpoints for the selected integration.
   * **Integration-specific APIs** - Test passthrough functionality
2. Configure your request with the appropriate method, path, and payload
3. Send your request and analyze the response

### Testing Kombo API Endpoints

When testing Kombo API endpoints, select "kombo" from the API dropdown and enter the endpoint path (e.g., `/employees`, `/jobs`, `/applications`). Refere to our API reference for all available endpoints. All requests are automatically authenticated and audit logged.

### Testing Passthrough APIs

When testing integration-specific passthrough APIs, select the appropriate passthrough API from the dropdown and configure the request according to the integration's native API documentation which is linked on the selected API.

Komboman works directly with our [Passthrough API](./passthrough-api), which enables you to interact with the native APIs of specific integrations while we handle the authentication.

## Access Permissions

Komboman is available to:

* **Production Environment**: Users with admin role
* **Development Environment**: Users with admin or developer role


# Logs
Source: https://docs.kombo.dev/hris/features/logs

Learn how Kombo's logs allow you to monitor and troubleshoot your integrations.

## Overview

Our logs enable you to dig deeper into what is happening behind your integrations. Depending on the type of interaction, different logs are available.

You can find the logs in the [sidebar of the Kombo dashboard](https://app.kombo.dev/logs).

<Frame>
  <img alt="logs-overview" />
</Frame>

### Available Log types

| Log Type             | Description                                                                                                                                                                   | Features                                                                 |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| **Sync**             | Created for each recurring sync of an integration                                                                                                                             | [Sync Metrics](#sync-metrics), [Request Logs](#request-logs)             |
| **Connection Flow**  | Created for each connection flow interaction                                                                                                                                  | [Event Logs](#connection-flow-event-logs), [Request Logs](#request-logs) |
| **Action**           | Created whenever Kombo receives an API request which triggers Kombo to make external API requests to a tool. E.g. [create application](/ats/v1/post-jobs-job-id-applications) | [Request Logs](#request-logs)                                            |
| **Passthrough**      | Created for each [passthrough](./passthrough-api) request made                                                                                                                | [Request Logs](#request-logs)                                            |
| **Incoming Webhook** | Created whenever a tool sends an API request to Kombo                                                                                                                         | [Request Logs](#request-logs)                                            |

### Filters

Use filters to narrow your search and find exactly what you're searching for.

We additionally make sure to link back to any logs from relevant dashboard pages. For example, you can instantly query an integration's logs by clicking "logs" on the integration's details page.

<Frame>
  <img alt="log-filters" />
</Frame>

## Request Logs

Request logs help you see any API requests that Kombo is making to the integrated tool, and debug any issues. If an integration is having issues, request logs let you deep dive into understanding which endpoints are causing problems, such as finding requests returning `403` status codes for missing permissions.

<Frame>
  <img alt="request-logs" />
</Frame>

### Viewing Details

Click on a row to view details of the API request. Kombo will redact any sensitive data.

You can view the response of the request by clicking on **Open response**.

<Frame>
  <img alt="request-log-details" />
</Frame>

### Retention

By default, Kombo stores logs for 30 days. Longer retentions are available upon request on the enterprise plan.

## Connection Flow Event Logs

We store any decisive events that happen throughout the connection flow to enable you to understand exactly what your customer is experiencing. This visibility lets you detect what is preventing your customers from connecting their tool, and ultimately reach out to them with the right help to complete the integration.

<Frame>
  <img alt="connection-flow-logs" />
</Frame>

View your current connection flow logs in the [Kombo dashboard](https://app.kombo.dev/logs?kind=CONNECTION_FLOW).

### Identifying User Sessions

The logs are grouped by user sessions, with a 'broken' line indicating a break between two sessions. Viewing sessions allows you to gain insights on when a user exited and/or re-entered the connection flow.

<Frame>
  <img alt="flow-log-sessions" />
</Frame>

## Sync Metrics

The sync metrics tab allows you to gain insights into which data was read and whether any issues occurred. Use this to quickly verify that the expected data is being synced without having to make any API calls.

<Frame>
  <img alt="sync-metrics" />
</Frame>


# Passthrough API
Source: https://docs.kombo.dev/hris/features/passthrough-api

Implement any edge case feature with our passthrough API.

## Overview

The Passthrough API lets you call the native API of any connected integration directly, while Kombo handles authentication for you. This bridges the gap between the unified API and integration-specific requirements — you get the consistency of Kombo's auth layer with the flexibility of the underlying tool's full API surface.

## When to Use It

Use the Passthrough API when you need integration-specific data or actions that the unified API does not cover. Common examples:

* Reading provider-specific resources (e.g., HiBob work history, Workday compensation plans)
* Calling write endpoints that Kombo doesn't offer as a unified action
* Accessing tool-specific configuration (e.g., ATS picklists, custom templates)

<Tip>
  For reading additional fields on standard models, prefer [custom
  fields](./custom-fields) — they're simpler and work across integrations.
  [Integration fields](./integration-fields) cover a narrow niche and are rarely
  the right choice. The Passthrough API is best for accessing entirely different
  endpoints or performing writes that aren't part of the unified API.
</Tip>

## How It Works

1. **Authentication**: Authenticate with your Kombo API key as usual. Kombo forwards the request with the correct tool-specific credentials.
2. **Choose the API**: Find the API identifier for your integration in the [passthrough endpoint reference](../v1/post-passthrough-tool-api).
3. **Build your request**: Specify the HTTP method, endpoint path, headers, query parameters, and request body — exactly as the tool's native API expects.

## The `api_options` Parameter

Most integrations don't require `api_options` — simply set the `path` and Kombo routes to the right API.

However, some integrations have multiple underlying APIs or services that share the same authentication but use different base URLs or protocols. For these, `api_options` tells Kombo which specific service to target.

Integrations that use `api_options` document the required fields directly on their passthrough endpoint specification. Common examples:

* **Workday REST**: requires `service_name` (e.g., `"staffing"`, `"compensation"`) and optionally `version` to select the correct REST service
* **Workday SOAP**: requires `service_name` (e.g., `"Staffing"`, `"Recruiting"`) and optionally `service_version` to target the right SOAP service
* **SOAP-based tools** (Nmbrs, HR Office, Taleo): require `service_name` or `operation_name` to route to the correct SOAP service

If an integration doesn't document `api_options`, you don't need to provide it.

## Testing with Komboman

Use [Komboman](./komboman), the built-in API client in the Kombo dashboard, to test passthrough calls interactively. It handles authentication automatically and saves request history, making it easy to experiment with native API endpoints.

Find the full passthrough endpoint specification [here](../v1/post-passthrough-tool-api).


# Performance data
Source: https://docs.kombo.dev/hris/features/performance-data

Performance data endpoints overview, data structure, types, cycles, ratings, and API usage.

# Overview

The performance data endpoints allow you to retrieve performance review and performance review cycle data from HRIS systems and convert them into a unified data model. Each performance review represents the feedback exchanged between a reviewer and the reviewee, delivered in a consistent data structure regardless of the underlying HRIS system.

## Key Use Cases

* Compensation Benchmarking
  * Compare manager performance ratings with employee pay to ensure compensation is tied to performance and fairness.
* HR Analytics
  * Link performance results with outcomes like employee turnover to uncover what drives attrition or retention.
* Talent Intelligence and Internal Mobility
  * Measure whether internal moves, promotions, or hires actually lead to stronger performance.
* Assessment calibration
  * Check if hiring or development assessments predict real performance, and use that insight to improve future decisions.

## Scope config and filtering recommendations

### Scope config

**Important**: Employee performance is employee-centric, so you must include `employees` in your scope config to properly sync performance data.

The reviewee and reviewer properties are foreign models. For example: if you have `employee.display_full_name` disabled in your scope config, both the reviewee and reviewer `display_full_name` will be `null`.

```jsx theme={null}
{
  "reviewee": {
    ...
    "display_full_name": null
  },
  "reviewer": {
    ...
    "display_full_name": null
  }
}
```

### Filtering

When employee filters are applied, only filtered employees’ reviews are synced. If the reviewer is filtered out their Kombo ID and remote\_id values will still be present, but the other properties will be nulled.

```jsx theme={null}
{
  "reviewer": {
    "id": "J3iiLb4k1PXfkFN1oF8Sv2LB",
    "remote_id": "9ccd305a-6dde-49f6-9ad2-2e5c0f4fd7d4"
    "first_name": null,
    "last_name": null,
    "display_full_name": null,
    "work_email": null
  }
}
```

# Understanding Performance Data Structure

## Performance Review Cycles

<Frame>
  <img alt="image" />
</Frame>

Performance Review Cycles are used to categorize individual performance reviews into logical buckets. They feature a `name` and `review_period_start_date` property. The `review_period_start_date` is the date when the review period for this cycle starts and it is the date from which on reviews can be submitted for this cycle. We recommend to use this date for sorting reviews within a single employee view and for a review cycles view.

```jsx theme={null}
{
  "name": "2025 Annual Performance Review Cycle",
  "review_period_start_date": "2025-01-01T00:00:00.000Z"
}
```

Some HRIS systems use different processes to schedule performance reviews and it can therefore happen that the `review_period_start_date` property is `null`. This will be marked as `UNSUPPORETED` on our coverage grid accordingly.

```jsx theme={null}
{
  "name": "2025 Annual Performance Review Cycle",
  "review_period_start_date": null,
}
```

## Performance Reviews

As explained in the **Scope config** section the performance review comes with reviewee and reviewer properties. Use the `display_full_name`, `first_name`, `last_name`, `work_email` to display a reviewee or reviewers identity in your application. Use the `id`, `remote_id` or `work_email` to implement hyperlinks to these entities within your application. You can also link to the review cycle via it’s `id`/`remote_id` property.

The `type` property describes the relationship between the reviewer and reviewee. The following values are possible: `MANAGER`, `DIRECT_REPORT`, `PEER` and `SELF`. If the relationship cannot be determined or the reviewer is missing it will be `null` instead. If your application is primarly consuming the type `MANAGER` but it is not available for a certain integration it can make sense to add a fallback to type `null` with a warning in your UI. The query parameter `types` can be used to filter our a API response for a single or multiple types.

The `summary_comment` gives the summary/overall comment of the reviewer.

```jsx theme={null}
{
  "summary_comment": "Good job this year! Let's keep it up for 2024!"
}
```

The `summary_rating` gives you the summary/overall/average rating. It is never calculated by Kombo. It can have two different formats:

<Tabs>
  <Tab title="SINGLE_SELECT">
    ```jsx theme={null}
    {
      "summary_rating": {
        "type": "SINGLE_SELECT",
        "ordered_options": [
          "Needs improvement",
          "Below expectations",
          "Meets expectations",
          "Exceeds expectations",
          "Exceptional"
        ],
        "value": "Exceeds expectations"
      }
    }
    ```
  </Tab>

  <Tab title="NUMERIC">
    ```jsx theme={null}
    {
      "summary_rating": {
        "type": "NUMERIC",
        "value": 3.2,
        "min": 0,
        "max": 5
      }
    }
    ```
  </Tab>
</Tabs>

In the `SINGLE_SELECT` format `ordered_options` will be an array of available options (strings) ordered from bad to good. You can use the index of the `value` to display the range and where this review lands. For tools that do not expose all available options the `ordered_options` array will be `null`.
If the type is `NUMERIC` the value will be any floating point or integer between and including the given `min` and `max` value. `min` and `max` can be `null` if the tool does not expose the possible range.

# UI Examples

<Frame>
  <img alt="image" />
</Frame>

<Frame>
  <img alt="image" />
</Frame>

<Frame>
  <img alt="image" />
</Frame>

<Frame>
  <img alt="image" />
</Frame>

<Frame>
  <img alt="image" />
</Frame>

# Common Integration Scenarios

## Compensation Benchmarking

You can offer two distinct views in your UI:

### Reviewee View

1. Retrieve the Performance reviews for the individual employee (reviewee).
   * GET /performance-reviews?types=MANAGER\&reviewee\_ids=\<Kombo ID>
2. Sort by `review_period_start_date` if available or take the latest.
3. Display the summary\_rating and summary\_comment of the manager review

### Performance Review Cycle View

1. Retrieve all Performance Review Cycles.
   * GET /performance-review-cycles
2. After a user expands a Performance Review Cycle, retrieve the reviews for this cycle with the `review_cycle_ids` query parameter or load them from your database/cache.
   * GET /performance-reviews??types=MANAGER\&review\_cycles=\<Kombo ID>
3. Display the reviewees name and their `summary_rating`

## HR Analytics

1. Get employee attrition or retention with our `employment_status`, `start_date`, `termination_date` properties from our employee model
2. Compare the data with the corresponding performance reviews
   * GET /performance-reviews?types=MANAGER,SELF
   * Discrepancies between the self and manager review might indicate dissatisfaction and flight-risk.

## Talent Intelligence and Internal Mobility

1. Get internal mobility and promotion data with `job_title`, `effective_date` and `employment_type` properties from our employment model
2. Compare the data with the corresponding performance review history
   * GET /performance-reviews?types=MANAGER
   * Use the `review_period_start_date` to sort the review scores by time

## Assessment calibration

1. Retrieve all Performance reviews and categorize them by type
   * You can use the `reviewee_ids` query parameter to only get reviews for employees which were assessed.
2. Calibrate the self assessment with the `SELF` reviews
   * GET /performance-reviews?types=SELF\&reviewee\_ids=\<Kombo ID>
3. Calibrate the social/leadership skills assessment with the `PEER`/`DIRECT_REPORT` reviews
   * GET /performance-reviews?types=PEER,DIRECT\_REPORT\&reviewee\_ids=\<Kombo ID>
4. Calibrate the overall assessment performance indicator with the `MANAGER` reviews.
   * GET /performance-reviews?types=MANAGER\&reviewee\_ids=\<Kombo ID>


# Real-time Data
Source: https://docs.kombo.dev/hris/features/real-time-data

Get near-real-time updates when any data changes in connected HRIS systems.

## Overview

Many applications require real-time or near real-time data access, particularly
for employee onboarding, absence management, time tracking, and integrated HRIS
workflows. Our unified **real-time data** approach enables these use cases,
significantly improving the UX for your customers.

We provide real-time data through upstream webhooks to all customers. However,
for systems without webhook support, near real-time data access requires
accelerated sync frequencies, which are available on our Scale and Enterprise
plans.

## How It Works

### Upstream Webhooks

For integrations that support [upstream webhooks](/hris/guides/upstream-webhooks), Kombo subscribes directly to
the HRIS system's webhook events during setup of the integration. When data
changes occur, we receive notifications within seconds and immediately process
the updates, making them available through our `data-changed` webhook. With active webhooks,
regular sync frequency is reduced since webhooks already keep the data fresh.

### Enhanced Sync Frequencies

For integrations without upstream webhook support, Kombo can sync data at
configurable intervals to ensure data freshness while maintaining system
performance.

<Note>
  **Plan-based sync frequencies:** Faster sync intervals are available on Scale
  and Enterprise plans.
</Note>

## Key Benefits

### Immediate Data Updates

With webhook-enabled integrations, your application receives updates within 20
seconds of changes occurring in the connected HRIS system. This enables real-time
employee onboarding, instant organizational updates, and immediate absence
notifications.

### Efficient Data Processing

Our data-changed webhook system ensures you only process data when actual
changes occur, reducing unnecessary API calls and improving your application's
performance.

### Comprehensive Coverage

Whether an integration supports webhooks or relies on sync intervals, Kombo
ensures consistent data delivery across all supported HRIS systems through our
unified `data-changed` approach.

## Implementation

Learn more about implementing real-time data updates:

<CardGroup>
  <Card title="Fetching Data Guide" icon="download" href="/hris/getting-started/fetching-data">
    Learn how to implement the data-changed webhook and fetch data efficiently.
  </Card>

  <Card title="Upstream Webhooks" icon="cloud-arrow-down" href="/ats/guides/upstream-webhooks">
    Understand how upstream webhooks enable real-time data updates.
  </Card>
</CardGroup>


# Remapping array fields
Source: https://docs.kombo.dev/hris/features/remapping/array-remapping

Learn how to use the remapping feature to adjust Kombo array fields based on fields in your customer's systems.

## Remapping an array field

Array fields in the Kombo data model can have multiple entries per entity. For example our HRIS employee can have multiple `bank_accounts` and an ATS candidate can have multiple `email_addresses`.
These fields will offer two mapping modes: `Replace` and `Append`

<Frame>
  <img alt="image" />
</Frame>

This will decide wether you would like to persist the Kombo default mappings in
the array or replace the array entirely.

After deciding on the mapping mode you can start adding entries to the array. Please note that all required fields for an entry need to be mapped.

<Frame>
  <img alt="image" />
</Frame>

For `bank_accounts` you need to select an account type before the fields show up. You can mix multiple types in the array.

<Frame>
  <img alt="image" />
</Frame>

## Fallbacks

Fallbacks are not available for these fields. Instead you can add multiple values to the array. If any required field (marked with red asterix) of single entry is missing, the entry will not be added to the array.

<Frame>
  <img alt="image" />
</Frame>


# Remapping date fields
Source: https://docs.kombo.dev/hris/features/remapping/date-remapping

Learn how to use the remapping feature to adjust Kombo date fields based on fields in your customer's systems.

## Remapping a date field

1. Select the source field of the date. It can bei either a string or number.
   <Frame>
     <img alt="image" />
   </Frame>
2. Pick a date format from our presets or choose `Custom format`.
   <Frame>
     <img alt="image" />
   </Frame>
3. (optional) If you have custom field examples enabled we will display a validation section below. Adjust the format until the dates are parsed as desired.
   <Frame>
     <img alt="image" />
   </Frame>
4. Press the `Save configuration` button on the bottom right.
   <Frame>
     <img alt="image" />
   </Frame>


# Remapping enum fields
Source: https://docs.kombo.dev/hris/features/remapping/enum-remapping

Learn how to use the remapping feature to adjust Kombo enum fields based on fields in your customer's systems.

## Remapping an enum field

1. Select the source field to map the enum from.
   <Frame>
     <img alt="image" />
   </Frame>
2. Define a default value. This will be the result in case the value is not mapped or null. If you want to use `fallbacks` make sure to select `None (null)` here.
   <Frame>
     <img alt="image" />
   </Frame>
3. Define an enum map. For this you first input the source string on the left. Then click the `Add mapping` button.
   <Frame>
     <img alt="image" />
   </Frame>
   After adding the source string, select one of the Kombo enum values.
   <Frame>
     <img alt="image" />
   </Frame>


# Introduction
Source: https://docs.kombo.dev/hris/features/remapping/introduction

Learn how to use the remapping feature to adjust Kombo default fields based on fields in your customer's systems.

## Prerequisits

The remapping UI is located on each individual integration right next to the "Custom Field Mappings" tab.

<Frame>
  <img alt="image" />
</Frame>

1. Your scope config for the integration will need either `custom_fields` or `integration_fields` **enabled for each model** you wish to remapp.
   <Frame>
     <img alt="image" />
   </Frame>
2. The initial sync has **finished successfully** and the integration is **not in QA mode**.
   <Frame>
     <img alt="image" />
   </Frame>
3. (optional) To improve your mapping experience we recommend enabling custom field examples for new integrations. The setting can be found under `Configuration` in the left sidebar.
   <Frame>
     <img alt="image" />
   </Frame>

We offer different user interfaces to accomedate the complexity that comes with each specific field:

1. [Simple string/number/boolean fields](./simple-remapping)
2. [Enum fields](./enum-remapping)
3. [Date fields](./date-remapping)
4. [Address fields](./struct-remapping)
5. [Reference fields](./reference-remapping)
6. [Array fields](./array-remapping)

Additionally, you can use the [Kombo Default Fallback](./kombo-default-fallback) to include Kombo's standard mapping logic as a priority in your fallback chain — available for simple, enum, and date fields.


# Kombo default fallback
Source: https://docs.kombo.dev/hris/features/remapping/kombo-default-fallback

Learn how to use Kombo's standard mapping logic as a fallback priority in your remapping configuration, giving you full control over the mapping order.

## What is the Kombo Default Fallback?

When you [override a field mapping](./introduction), you replace Kombo's built-in mapping logic with your own custom configuration. This is powerful, but sometimes you don't want to *replace* Kombo's logic entirely — you want to **combine** your custom mapping with Kombo's standard logic in a specific priority order.

The **Kombo Default Fallback** lets you insert Kombo's standard mapping logic as one of the priorities in your fallback chain. This means you can:

* Use a custom integration field as the primary source, and **fall back to Kombo's default** if that field is empty
* Use Kombo's default mapping as the **primary value**, but override it with a custom field when Kombo's value is empty
* Place Kombo's default logic **between** two custom field sources in a multi-level fallback chain

<Note>
  The Kombo Default Fallback is available for **simple** (string, number,
  boolean), **enum**, and **date** field remappings. It is not available for
  address, reference, or array field types.
</Note>

## When should you use it?

Consider using the Kombo Default Fallback when:

* **Kombo's default mapping works well in most cases**, but a small number of your customer's records store the value in a different field. You can set Kombo's default as Priority 1 and your custom field as a fallback.
* **A custom field is your preferred source**, but it isn't always populated. By adding Kombo's default as a fallback, you ensure no data is lost when the custom field is empty.
* **You want to experiment with a custom mapping** without losing the safety net of Kombo's proven default logic. If your custom source produces `null`, Kombo's standard mapping takes over automatically.

## How it works

The remapping engine evaluates your fallback chain **from top to bottom** (Priority 1 first, then Priority 2, and so on). For each record (employee, candidate, job, etc.), it checks each priority in order and **stops as soon as a valid, non-empty value is found**.

When the engine reaches a "Default Kombo value" entry in the chain, it uses the value that Kombo's standard mapping logic would have produced for that field — exactly as if no remapping had been configured.

### Example: Custom field with Kombo default as safety net

Suppose you want to map the `first_name` field from a custom integration field called `preferred_name`, but not every record has a preferred name set.

| Priority | Source                               | Behavior                                                                           |
| -------- | ------------------------------------ | ---------------------------------------------------------------------------------- |
| 1        | `preferred_name` (integration field) | Used when the field has a value                                                    |
| 2        | Default Kombo value                  | Falls back to Kombo's standard `first_name` mapping when `preferred_name` is empty |

**Result**: Records with a `preferred_name` get that value. Records without it seamlessly fall back to whatever Kombo would have mapped by default.

### Example: Kombo default with a custom override

You trust Kombo's mapping for most records, but for a few edge cases you know a specific integration field has better data.

| Priority | Source                             | Behavior                                               |
| -------- | ---------------------------------- | ------------------------------------------------------ |
| 1        | Default Kombo value                | Used when Kombo's standard mapping produces a value    |
| 2        | `backup_field` (integration field) | Only used when Kombo's default mapping produces `null` |

**Result**: Kombo's default logic runs first. Only when it returns nothing does the system check `backup_field`.

## Adding a Kombo Default Fallback

1. Open the remapping modal for the field you want to configure (see [simple](./simple-remapping), [enum](./enum-remapping), or [date](./date-remapping) remapping for details on how to open the modal).
2. At the bottom of the modal, click the **Fallback to Kombo's mapping** button.
   <Frame>
     <img alt="image" />
   </Frame>
3. A new priority entry will appear showing **"Default Kombo value"** with the description *"Uses Kombo's standard mapping logic for this field."*
   <Frame>
     <img alt="image" />
   </Frame>
4. You can **reorder** priorities by removing and re-adding entries. The Kombo Default Fallback can be placed at any position in the fallback chain — it does not have to be last.
5. Click **Save** to apply the configuration. Remember that **a sync is required** for saved changes to take effect.

## Combining with other fallbacks

You can freely mix Kombo Default entries with custom integration field entries. For example, a three-level fallback chain for an enum field might look like:

| Priority | Source                                                      |
| -------- | ----------------------------------------------------------- |
| 1        | `custom_status_field` (integration field) with enum mapping |
| 2        | Default Kombo value                                         |
| 3        | `legacy_status_field` (integration field) with enum mapping |

The engine will try `custom_status_field` first. If it's empty, it falls back to Kombo's default enum mapping. If even that produces `null`, it tries `legacy_status_field` as a last resort.

<Tip>
  If the **only** entry in your fallback chain is a Kombo Default, the
  configuration is equivalent to having no remapping at all. In this case, the
  system will automatically clear the remapping configuration when you save.
</Tip>

## Supported field types

| Field type                                             | Kombo Default Fallback supported |
| ------------------------------------------------------ | -------------------------------- |
| [Simple](./simple-remapping) (string, number, boolean) | Yes                              |
| [Enum](./enum-remapping)                               | Yes                              |
| [Date](./date-remapping)                               | Yes                              |
| [Address](./struct-remapping)                          | No                               |
| [Reference](./reference-remapping)                     | No                               |
| [Array](./array-remapping)                             | No                               |


# Remapping reference fields
Source: https://docs.kombo.dev/hris/features/remapping/reference-remapping

Learn how to use the remapping feature to adjust Kombo reference fields based on fields in your customer's systems.

## Remapping an reference field

Reference fields are fields that reference related entities. For example our employee model has three reference fields: manager\_id, legal\_entity\_id and work\_location.
These fields can offer up to two mapping types.

<Frame>
  <img alt="image" />
</Frame>

## Refernce existing record

1. When choosing `Refernce existing record` the model will be linked to an already existing record.
2. You will need to select a field that contains the same remote id as the model you wish to reference.
   <Frame>
     <img alt="image" />
   </Frame>
   If the referenced record does not exist, it will be created but all other
   fields except the id will be `null`.

## Create new record with mapped data

1. When choosing `Create new record with mapped data` the model will be linked to a new record. You will be able to create a new work location, legal entity, etc.
2. Fill the the remote id with the unique identifier you want to use for the new record.
3. Then fill the rest of the properties.
   <Frame>
     <img alt="image" />
   </Frame>

You will be able to receive the new record on both the `/employees` endpoint, as well as the relations own endpoint (`/work-locations`, `/legal-entities`).
Note: This option is not available for all reference fields.


# Remapping simple fields
Source: https://docs.kombo.dev/hris/features/remapping/simple-remapping

Learn how to use the remapping feature to adjust simple Kombo default fields based on fields in your customer's systems.

## Remapping a simple string/number/boolean field

To start the remapping process open the remapping UI and click on the `Override default Kombo value` button of the field you want to remapp.

<Frame><img alt="image" /></Frame>A new popup will
appear allowing you to configure the remapping for the individual field.

<Frame>
  <img alt="image" />
</Frame>

Under `Priority 1` you can select the source field you would like to use for the
remapping. You can search in the selection box, see the example values and even
use our custom field explorer feature.

<Frame>
  <img alt="image" />
</Frame>

After selecting the field, you can press the `Save` button to save the
configuration.

<Frame>
  <img alt="image" />
</Frame>

If this is your first remapping, a popup will appear, which reminds you that **a
sync is required** for the saved changes to show their effect.

<Frame>
  <img alt="image" />
</Frame>

## Fallbacks

In case the selected field is removed (`undefined`), `null` or changes it's structure (`string` => `array`), the remapping will result in `null` as output.
For these cases it makes sense to define one or multiple fallback values, when configuring a remapping. You can do so by clicking the `Add fallback` button in the configuration UI.

<Frame>
  <img alt="image" />
</Frame>

We will execute the remapping top to bottom. This means the remapping stops for
each the entity (employee, candidate, job...) has soon as valid value is found.

<Frame>
  <img alt="image" />
</Frame>

You can also use the **Fallback to Kombo's mapping** button to include Kombo's standard mapping logic as one of the priorities in your fallback chain. This is useful when your custom field is not always populated and you want to fall back to what Kombo would have mapped by default. Learn more in the [Kombo Default Fallback](./kombo-default-fallback) guide.


# Remapping address fields
Source: https://docs.kombo.dev/hris/features/remapping/struct-remapping

Learn how to use the remapping feature to adjust Kombo address fields based on fields in your customer's systems.

## Remapping an address field

1. An address in Kombo consists out of multiple fields. Select an integration field for each field you wish to fill. Unfilled will result in `null` for the respective property.
   <Frame>
     <img alt="image" />
   </Frame>
2. You might need to scroll to see all available fields.

Note: English country names will get automatically resolved to the ISO 3166-1 alpha-2 country code.

## Fallbacks

Fallbacks are only executed if **all fields** in the priority above are missing (`undefined`), `null` or empty (`''`).


# Extend write endpoints
Source: https://docs.kombo.dev/hris/features/remote-fields

Learn how Kombo allows you to write additional, otherwise unsupported fields with unified write actions.

## Overview

Kombo supports a feature called **Remote Fields** for many write endpoints. This
feature solves a similar problem as the [passthrough API](./passthrough-api) while still allowing you
to use the unified Kombo API.

## How does it help you

While we always try to solve even niche use cases with our unified API, there are cases
where an integration requires particular data (for example, because your customer
uses required custom fields or customizes their system a lot). In these cases, the
remote fields feature allows you to pass this data to the connected system.

Remote fields also allow you to customize specific endpoints even more, as it
would be out of scope for the unified model.

If you need to read additional data from connected systems instead, use
[custom fields](./custom-fields).

## How to use it

Write actions that support this feature support have a property called `remote_fields`
on the root level request body. This object follows a record structure where the
key is the name of the tool (e.g., `greenhouse`), and the value is an object
highly specific to the tool. On a high level, most available fields are documented in the endpoint specification.

A good example of a write endpoint supporting this feature is [the ATS API endpoint to create a new application](/ats/v1/post-jobs-job-id-applications) (search for 'remote fields').

### Example

A SuccessFactors instance requires the nationality of applicants as an attribute.
`nationality` isn't an attribute that is ordinarily supported by our
'Create application' endpoint. Because application creation generally works the
same otherwise, you can use `remote_fields` to extend the requests that we send
to SuccessFactors with the `nationality` field.

### Remote fields in practice

You will likely find out about any required remote fields during testing.
You may try to submit a dummy candidate, however, you receive an error message like the
following:

```
{'status': 'error', 'error': {'message': {'remote_http_status': 500, 'remote_error': {'error': {'code': 'COE_GENERAL_SERVER_FAILURE', 'message': {'lang': 'en-US', 'value': '[COE0019]Unexpected error occurred: custNationality required for external candidate, custFutSponsor required for external candidate as per field override,  for templateId 579 ,  with the index 0'}}}}}}
```

For example, for the above error message, you would then need to add the following fields to your create candidate call for the parameter `remote_fields`:

```
{
    "successfactors": {
        "Candidate": {
            "custNationality": "some-nationality",
            "custFutSponsor": "some-sponsor"
        }
    }
}
```

You can then use an iterative process based on the error messages
("trial-and-error") to tell whether you are now submitting the correct remote fields.

### Help

Don't hesitate to contact us if you have any questions about this feature
or you need help with a specific use case.


# SCIM Integrations
Source: https://docs.kombo.dev/hris/features/scim

Learn about SCIM integration and their potential benefits.

## Overview

SCIM (System for Cross-domain Identity Management) is an open standard that simplifies user identity management across different applications. Kombo supports integrating to Identity Providers (IDPs) using the SCIM standard such as Azure Active Directory and Okta, enabling synchronization of user and group information.
By using SCIM with Kombo, your customers can automatically provision and de-provision users and manage their attributes and group memberships within their HR systems, all through a standardized interface. This eliminates manual user management and ensures consistent data across systems.

When a customer sets up a SCIM integration with Kombo, their Identity Provider (the SCIM client) will push user and group data to Kombo's SCIM endpoint (the SCIM server). Kombo then processes this data and makes it available in our unified data model, just like all other integrations.

<Note>
  SCIM integrations are currently exclusively available to our enterprise-tier
  customers. If you're interested in establishing a connection, please get in
  touch with us for assistance in setting it up.
</Note>

## Potential Benefits

### Automated User Management for End Customers

SCIM automates the creation, modification, and deletion of user accounts. When a user is added, updated, or removed in the Identity Provider, these changes are automatically reflected in Kombo and subsequently in connected HR systems. This reduces administrative overhead and ensures data accuracy.

### Industry Standard Integration

SCIM is a widely adopted industry standard for identity management. Integrating with Kombo via SCIM ensures compatibility with a broad range of Identity Providers and future-proofs your integration strategy.

### Granular Data Control

SCIM allows Identity Providers to explicitly define which user attributes and group memberships are shared with Kombo. This gives your customers control over the data being synchronized, ensuring compliance and data privacy.


# Scopes
Source: https://docs.kombo.dev/hris/features/scopes

Scopes allow you to customize what data is being synced by Kombo.

By default, Kombo syncs all available data from connected systems. This can be
pretty convenient for exploring what's available during development, but as soon
as you take Kombo into production, you'll likely want to restrict what data is
extracted and stored for privacy and security reasons.

For this purpose, Kombo provides what we call "Scopes." These allow you to
configure precisely which models and data points are being extracted and stored.
Scopes can, for example, be used to anonymize data by removing all personal
identifiable information from the data we store.

## Configuring scopes

To get started configuring scopes, log into the
[Kombo Dashboard](https://app.kombo.dev) and open the "Scope Config" page. It
should look something like this:

<Frame>
  <img alt="1464" />
</Frame>

### Configure scope config

When editing your scope configs or creating a new one, a page similar to this
one will open:

<Frame>
  <img alt="1464" />
</Frame>

All of Kombo's Data Models are listed here, and you can disable, enable or
mark an entire Data Model as optional.
We do not sync data from disabled data models. Optional Data Models aren't
synced if your customer opts out of having the field exposed. Enabled
models are always synced.

We recommend turning all Data Models off that you are not interested in. For example,
if you want to sync employee, employment and organization data
but are not interested in absences, turning off the absence type, absences and
time off balance Data Models is recommended. This will simplify the setup for your customer, improve sync times, and
not expose any data that does not need to be exposed.

### Configuring fields

If you only want to turn off individual model fields, you can expand
each model in the edit page. You will now see all the fields it supports:

<Frame>
  <img alt="1426" />
</Frame>

For example, if you don't want to sync sensitive data like SSNs or Tax IDs,
you can turn them off here. Similarly, if you would like to read
personal identifiable information but it is not required for your use-case,
consider marking the field as optional. This will give your customers the choice
of whether they want to expose it or not.

## Building trust with your customers

Some of the systems we help you integrate contain very sensitive data (like
personal addresses or tax IDs of employees). That's why
communicating which data points you access and which you don't is critical to
building trust and eradicating concerns during the sales process.

To help you with this, we're exposing your scope config to the end user as part
of our connection flow:

<Frame>
  <img alt="1002" />
</Frame>

This way, your customers can see exactly which data points you're accessing.


# Setup Flow
Source: https://docs.kombo.dev/hris/features/setup-flow/introduction

Let your customers configure their integration end-to-end.

<img alt="Setup Flow" />

The [Connection Flow](/kombo-connect) lets your customers authenticate and
validate their credentials. The Setup Flow covers everything that comes after:
any additional configuration the integration needs before it can sync the right
data. It is presented to your customers as a self-serve UI inside the Kombo
Connect SDK, so they can complete it without you building anything yourself.

## What appears in the Setup Flow

Each integration decides which steps it actually needs. The most common ones
are:

* **[Field mapping](../custom-fields#self-serve-custom-field-configuration)**,
  where customers connect your custom fields to fields in their tool. Available
  for any category as long as you've defined custom fields.
* **[Employee filtering](/hris/features/filtering/introduction)**, where HRIS
  customers choose which employees Kombo should sync.
* **Tool-specific steps**, surfaced automatically by some connectors (for
  example Greenhouse, Teamtailor, or SCIM) to handle one-time configuration that
  the tool itself requires, like activating webhooks or providing additional
  credentials.

Steps only show up when they are relevant. If a customer connects a tool that
does not support filtering, the filtering step is hidden even when the feature
is enabled on the integration.

## Enabling Setup Flow steps

Field mapping and employee filtering are opt-in per integration. Tool-specific
steps require no configuration on your side, they appear automatically when
needed.

### When creating a new integration

In the Dashboard, open the [Integrations
page](https://app.kombo.dev/integrations) and toggle the steps you want at the
bottom of the create-link form.

<img
  alt="Integration Creation Form Setup Flow
Toggles"
/>

You can do the same via the API by setting `enable_field_mapping` and/or
`enable_filtering` (HRIS only) to `true` on the [Create Connection Link
endpoint](../../v1/post-connect-create-link).

### For an existing integration

Open the integration in the Dashboard and use the toggles in the **Integration
Settings** tab.

<img alt="Integration Settings Setup Flow Toggles" />

## Showing the Setup Flow to your customers

Setup Flow steps run automatically as part of the [Connection
Flow](/kombo-connect) the first time a customer connects a tool, so the
embedded flow you already have in place will pick them up without any changes.

To send customers back into the Setup Flow later, for example to update field
mappings or change which employees are synced, create a setup link with the
[Create Setup Flow link
endpoint](../../v1/post-integrations-integration-id-setup-link) and pass it to
`showKomboConnect` from the [Kombo Connect
SDK](../../guides/connect/embedded-flow#opening-the-flow), the same way you do
with a connection link.

You can also generate a setup link from the Integration Details page in the
Dashboard if you'd rather not wire up the API yourself.


# SFTP connections
Source: https://docs.kombo.dev/hris/features/sftp

Learn about SFTP transfers and their potential benefits.

## What is SFTP?

SFTP (Secure File Transfer Protocol) is a standard, secure way for systems to exchange files. Most enterprise HR systems can be configured to upload exports to a remote SFTP server on a recurring schedule, including on-premise ones that don't expose an API.

Kombo runs an SFTP server that acts as the destination for these uploads. Your customer's HR system pushes employee data (and optionally absences and timesheets) to Kombo on a fixed cadence, Kombo parses and maps the contents into the unified model, and your application reads or writes that data through the same Kombo API you use for any other integration.

This makes SFTP the right fallback whenever a customer's HR system can't be reached via API. Typical examples are on-premise SAP HCM, legacy bespoke tools, and systems where the customer is uncomfortable sharing API credentials.

## Overview

Your customer can set up a recurring schedule of exporting data from their system to a Kombo-hosted SFTP server, where we offer to set up a custom connection that maps your customers' exports to the unified Kombo model.

Each export that we receive will trigger a sync for the corresponding integration. That means all the functionality you've built around standard Kombo integrations will work the same way for SFTP integrations.

<Note>
  SFTP integrations are currently exclusively available to our scale and
  enterprise-tier customers. If you're interested in establishing a connection,
  please get in touch with us for assistance in setting it up.
</Note>

## Potential Benefits

### No API Credentials

An SFTP transfer eliminates the need for API credentials. To authenticate SFTP transfers, your customer will create a key pair and share the public key with Kombo. This way, we ensure that the data comes from the correct source. Not requiring API credentials can be helpful for customers who are uncomfortable with sharing them.

### Explicit Data Point Sharing

The first step in the connection flow will prompt you to select which data should be accessible in this integration.

For SFTP exports, you are responsible for selecting which data is included in the file you transfer.

In that first step, you'll find an overview of the data points that need to be provided in your file export. You can toggle OFF optional data fields if you don't want to include them. Please make sure all required data fields are included in your export file.

### Expanded Compatibility

SFTP transfers allow you to offer integrations for tools that Kombo does not yet support as API-based connections.


# Staffing entities
Source: https://docs.kombo.dev/hris/features/staffing-entities

Staffing entities endpoints overview, data structure, model_types, and API usage.

<Warning>
  **Beta Feature:** These endpoints are currently in beta. Please reach out to
  our support team if you need assistance with implementation.
</Warning>

## Overview

The staffing entities endpoint provides a unified way to read hiring structures
from HRIS systems. It normalizes records that are often called **positions**,
**requisitions**, or **jobs** so you can implement one integration flow across
different providers.

This feature is especially useful when your product needs to:

* show available hiring slots for the creation of job requisitions or job postings
* assign newly hired employee to the correct org structure and legal entity
* compare employees' skills with the skills expected for a role
* build approvals or workflows around hiring demand
* distinguish one-off backfills from evergreen hiring

<Note>
  For full request/response details and all supported query parameters, see
  <a href="/hris/v1/get-staffing-entities">GET staffing entities</a>.
</Note>

## Understanding Position vs Requisition vs Job

HRIS systems do not use these terms consistently, but a common pattern is:

* **Position**: structural slot in the organization, often tied to department,
  manager, location, and budget
* **Requisition**: request to fill a role, usually approval-driven and often
  linked to a parent position
* **Job**: generic hiring object in some systems, frequently used for
  lightweight or evergreen hiring flows

In Kombo, each record includes `model_type` with one of:

* `POSITION`
* `REQUISITION`
* `JOB`

If your workflow creates employees, we strongly recommend asking each customer
whether they hire into positions or requisitions first, then filtering data
using `model_types`.

## API Surface

<CardGroup>
  <Card title="Get staffing entities" icon="list" href="/hris/v1/get-staffing-entities">
    Retrieve staffing entities and filter by model type or status.
  </Card>

  <Card title="Get employee form" icon="users" href="/hris/v1/get-employees-form">
    Get an adjusted employee creation form after selecting the correct target
    staffing entity.
  </Card>

  <Card title="Create employee with form" icon="user-plus" href="/hris/v1/post-employees-form">
    Create employees with the target staffing entity.
  </Card>

  <Card title="Implementation guide" icon="book-open" href="/hris/implementation-guide/staffing-entities-in-create-employee">
    End-to-end walkthrough: how to use staffing entities when creating
    employees, including the picker flow and form scoping.
  </Card>
</CardGroup>

## Key Properties

### Identity and classification

* `id`: Kombo ID
* `remote_id`: provider ID
* `name`: title/name of the entity
* `model_type`: `JOB`, `POSITION`, or `REQUISITION`
* `parent_id`: parent staffing entity (commonly a requisition -> position link)

### Hiring context

* `status`: one of `OPEN_LIMITED`, `OPEN_UNLIMITED`, `PENDING`, `FROZEN`,
  `FILLED`, `CLOSED`
* `number_of_openings`: number of openings (mainly meaningful for
  `OPEN_LIMITED`)
* `description`: often equivalent to a job description and can include HTML
* `employment_types`: unified + remote labels for contract type classification

### Organizational links

* `locations`: related work locations
* `legal_entities`: related employing entities/sub-companies
* `groups`: related departments/teams/cost centers

### Skill expectations

* `skills`: skills expected for the role, including the skill's proficiency scale
  and the expected proficiency where available

Use [Get skills](/hris/v1/get-skills) to retrieve the full skill catalog. You can
also [upsert a staffing entity skill expectation](/hris/v1/post-staffing-entities-staffing-entity-id-skills)
for integrations that support writing role skills.

### Integration metadata

* `remote_url`: deep link to the record in the source HRIS
* `custom_fields`: normalized custom fields for this model
* `integration_fields`: provider-specific passthrough fields (if enabled)
* `remote_created_at`, `remote_updated_at`, `changed_at`, `remote_deleted_at`
* `remote_data`: raw provider payload (if configured)

## Filtering and Retrieval Patterns

Common query filters include:

* `model_types`: filter to `POSITION`, `REQUISITION`, `JOB`
* `statuses`: filter by lifecycle status
* standard list filters like IDs, pagination, and update windows

Example patterns:

```bash theme={null}
GET /hris/staffing-entities?model_types=POSITION,JOB&statuses=OPEN_LIMITED,OPEN_UNLIMITED
GET /hris/staffing-entities?model_types=REQUISITION&statuses=PENDING,OPEN_LIMITED,OPEN_UNLIMITED
```

## Implementation Tips

1. Pick one primary hiring object per customer (`POSITION` and `JOB`, or `REQUISITION`)
   and persist that choice in your integration settings.
2. Treat `OPEN_UNLIMITED` as evergreen hiring and avoid interpreting
   `number_of_openings` as a hard limit there.
3. Use `parent_id` to build drill-down UIs (for example requisition -> position
   lineage).
4. Use `remote_url` for "Open in HRIS" backlinks in operational workflows.
5. Prefer `remote_label` for UI components and `unified_type` for internal filtering logic when using
   `employment_types`.

<Card title="Using staffing entities when creating employees" icon="user-plus" href="/hris/implementation-guide/staffing-entities-in-create-employee">
  Full workflow for the hire-into-position flow — from picker UI through form
  scoping to POST submission.
</Card>


# Time and Attendance
Source: https://docs.kombo.dev/hris/features/time-and-attendance

Timesheets endpoint overview, data structure, validation, time zones, payable hours, approvals, breaks, and API usage.

<Warning>
  **Beta Feature:** This endpoint is currently in beta. Please reach out to our
  support team if you need assistance with implementation.
</Warning>

## Overview

The timesheets endpoint allows you to retrieve attendance data from HRIS systems and convert them into a unified data model. Each timesheet represents work time tracking for a single employee, delivered in a consistent data structure regardless of the underlying HRIS system.

### Key Use Cases

* Monitor employee attendance and working hours
* Verify if employees worked their expected hours
* Process payroll data with approved timesheets
* Track break times and compliance
* Generate attendance reports

## Prerequisites

**Important**: Timesheets are employee-centric, so you must include `employees` in your integration scope to properly sync timesheet data.

* **Default window**: Only the last 2 months of timesheets are kept up to date during sync (configurable via the "Historical timesheet months to sync" setting)
* **Employee filtering**: When employee filters are applied, only filtered employees' timesheets are kept up to date
* **Retention**: Kombo only deletion-tracks timesheets inside that window. Timesheets that age out of the window are kept and are not marked as deleted just because they weren't re-fetched. Within the window, timesheets that disappear from the remote system are marked with `remote_deleted_at` as usual. Configure a larger window upfront or archive timesheets on your side if you need history beyond what you've kept up to date.

<Note>
  For the full API data model and all query/filter options, see the
  <a href="/hris/v1/get-timesheets">GET timesheets</a> endpoint.
</Note>

## Understanding Timesheet Data Structure

### Complete vs Incomplete Timesheets

Timesheets can exist in various states of completion depending on the employee's clocking behavior and system reliability:

**Complete Timesheet** (Ideal scenario)

```jsx theme={null}
{
  "started_at": "2025-04-16T09:02:00.000Z",
  "ended_at": "2025-04-16T16:59:00.000Z",
  "payable_hours": 8
}
```

**Incomplete Timesheets**

*Start time only:*

```jsx theme={null}
{
  "started_at": "2025-04-16T09:02:00.000Z",
  "ended_at": null,
  "payable_hours": null
}
```

*End time only:*

```jsx theme={null}
{
  "started_at": null,
  "ended_at": "2025-04-16T16:59:00.000Z",
  "payable_hours": null
}
```

* **Open timesheet**: Missing end time, could indicate ongoing work or system issues
  * **Start time only**: Employee clocked in but hasn't clocked out (may still be working)
  * **End time only**: Clock-in wasn't registered, only clock-out recorded
* **Sync updates**: Incomplete timesheets are often updated and completed during the next sync cycle once the employee clocks out

<Warning>
  If timesheets remain incomplete or validation issues persist, reach out to
  your customer with the specific employee name and timesheet times so they can
  correct the data in their HRIS system. After the next full sync, the corrected
  data should be properly reflected.
</Warning>

### Timesheet Overlap Validation

Important rule: timesheets cannot overlap for the same employee.

* ❌ Invalid: Timesheet from 09:00–17:00 and another from 16:00–19:00 has a 1-hour overlap
* ✅ Valid: Timesheet from 09:00–12:00 and another from 13:00–17:00 with no overlap

When overlapping timesheets are detected:

* Sync continues but generates warnings
* We won’t upsert the overlapping timesheet
* This can indicate a issue or wrong timesheet in the HRIS

### Open Timesheet Validation

* An open timesheet, without an end time, cannot exist within the time range of a closed timesheet
* Multiple consecutive open timesheets are allowed since they do not have defined end boundaries

## Time Zones and Time Handling

All timesheet times are provided in UTC format for consistency, along with the local timezone offset:

```json theme={null}
{
  "started_at": "2025-04-16T09:02:00.000Z",
  "ended_at": "2025-04-16T16:59:00.000Z",
  "timezone": "-04:00"
}
```

Implementation tip: Use the timezone offset to display times in the employee's local timezone in your UI.

<Info>
  Timezone awareness is essential for accurate approvals and schedule comparisons:

  * Always show the employee's local time alongside UTC when reviewing/approving.
  * The `timezone` field is an ISO‑8601 offset (e.g., `-04:00`) captured for that shift. Use it to reconstruct the shift's local time historically. Do not recompute using your current local offset — DST changes between then and now can happen.
  * When comparing scheduled vs. received times, convert both into the same local timezone (either the schedule's zone or the record's offset) before comparing.
  * Respect local day boundaries. If a shift crosses midnight, compare by local day if your policies are day-based.
</Info>

## Payable Hours Logic

```json theme={null}
{
  "payable_hours": 8,
  "started_at": "2025-04-16T09:02:00.000Z",
  "ended_at": "2025-04-16T16:59:00.000Z"
}
```

<Warning>
  `payable_hours` is never auto-calculated by Kombo. This value comes directly
  from the HRIS system.
</Warning>

### Grace Periods

Payable hours may differ from calculated work time due to grace periods:

* Employee starts 5 minutes late, for example 07:05 instead of 07:00
* Grace period allows full pay despite late start
* `payable_hours` reflects the grace period adjustment
* If `payable_hours` is null, the HRIS does not support this feature

### Fallback Calculation

When `payable_hours` is null, meaning the HRIS doesn't support this feature, you can calculate payable hours using: `end_time - start_time - unpaid_break_minutes`. This provides a reasonable approximation for payroll purposes when grace period data is not available.

<Warning>
  This calculation is at your own risk, as the HRIS system might still apply
  grace periods or overtime calculations that aren't exposed through the API.
  Your calculated values may differ from the official payroll figures.
</Warning>

## Approval Workflow

### Approval Status

```json theme={null}
{
  "approval_status": "APPROVED",
  "approved_at": "2025-04-16T17:05:31.000Z"
}
```

Use cases:

* Payroll processing: Only process approved timesheets
* Manager oversight: Identify pending approvals
* Compliance: Track approval timestamps for audit trails

## Break Time Implementation Patterns

Break handling varies significantly across HRIS systems. Check the coverage grid for system-specific support levels.

<Tip>
  **Need implementation support?**

  Break patterns can vary across HRIS systems and use cases. If you need
  guidance on implementing break logic for your specific requirements, our
  support team is ready to help. Reach out to schedule a call where we can
  discuss the best approach for your integration.
</Tip>

Break data rules:

* Only complete breaks, with both start and end times, are included
* Open breaks are never accepted and won’t be upserted, but we will show a warning.
* `unpaid_break_minutes` is calculated from unpaid breaks or provided directly by the HRIS

<Tabs>
  <Tab title="Detailed break tracking">
    ```json theme={null}
    {
      "started_at": "2025-04-16T09:00:00.000Z",
      "ended_at": "2025-04-16T17:00:00.000Z",
      "unpaid_break_minutes": 90,
      "breaks": [
        {
          "started_at": "2025-04-16T12:00:00.000Z",
          "ended_at": "2025-04-16T13:00:00.000Z",
          "paid": false
        },
        {
          "started_at": "2025-04-16T15:00:00.000Z",
          "ended_at": "2025-04-16T15:30:00.000Z",
          "paid": false
        }
      ]
    }
    ```

    <Frame>
      <img alt="image" />
    </Frame>
  </Tab>

  <Tab title="Break minutes only">
    ```json theme={null}
    {
      "started_at": "2025-04-16T09:00:00.000Z",
      "ended_at": "2025-04-16T17:00:00.000Z",
      "unpaid_break_minutes": 30,
      "breaks": null
    }
    ```

    The HRIS indicates 30 minutes of breaks were taken but does not provide specific break times.

    <Frame>
      <img alt="image" />
    </Frame>
  </Tab>

  <Tab title="Split timesheets">
    ```json theme={null}
    [
      {
        "started_at": "2025-04-16T09:00:00.000Z",
        "ended_at": "2025-04-16T12:00:00.000Z"
      },
      {
        "started_at": "2025-04-16T13:00:00.000Z",
        "ended_at": "2025-04-16T17:00:00.000Z"
      }
    ]
    ```

    <Frame>
      <img alt="image" />
    </Frame>
  </Tab>

  <Tab title="Split timesheets + standalone breaks">
    This pattern occurs in HRIS tools where break data doesn't belong to a specific work timesheet. Instead, Kombo creates a standalone timesheet entry that represents the entire break period, with the actual break details nested within it. This provides complete break tracking while maintaining the tool's original data structure.

    ```json theme={null}
    [
      {
        "started_at": "2025-04-16T09:00:00.000Z",
        "ended_at": "2025-04-16T12:00:00.000Z",
        "remote_id": "Timesheet 1"
      },
      {
        "started_at": "2025-04-16T13:00:00.000Z",
        "ended_at": "2025-04-16T17:00:00.000Z",
        "remote_id": "Timesheet 2"
      },
      {
        "started_at": "2025-04-16T12:00:00.000Z",
        "ended_at": "2025-04-16T13:00:00.000Z",
        "remote_id": "Timesheet 3",
        "unpaid_break_minutes": 60,
        "breaks": [
          {
            "started_at": "2025-04-16T12:00:00.000Z",
            "ended_at": "2025-04-16T13:00:00.000Z",
            "paid": false
          }
        ]
      }
    ]
    ```

    <Frame>
      <img alt="image" />
    </Frame>
  </Tab>
</Tabs>

## API Usage Examples

### Basic Timesheet Retrieval

```
GET /hris/timesheets?employee_id=H77fDF8uvEzGNPRubiz5DvQ7
```

### Date Range Filtering

```
GET /hris/timesheets?started_after=2025-04-01T00:00:00.000Z&ended_before=2025-04-30T23:59:59.000Z
```

## Implementation Best Practices

1. Handle multiple break patterns
   * Parse detailed break arrays when available
   * Fall back to break minutes calculation
   * Detect break periods from split timesheets
2. Timezone considerations
   * Always store times in UTC
   * Use timezone offsets for display purposes
   * Consider employee location for compliance reporting
3. Error handling
   * Handle cases where `payable_hours` is null
   * Account for missing break data
   * Plan for partial timesheet data
4. Filtering and performance
   * Use date range filters to limit data volume
   * Implement pagination for large datasets
   * Filter by specific employees when possible

## Common Integration Scenarios

### Payroll Processing

1. Filter timesheets by approval status, for example `APPROVED`
2. Use `payable_hours` when available, otherwise calculate from time ranges
3. Factor in `unpaid_break_minutes` for accurate pay calculations
4. Verify approval timestamps meet payroll cutoff requirements

### Attendance Monitoring

1. Check for incomplete timesheets that are missing start or end times
2. Monitor for unusual patterns such as very short or very long shifts
3. Track break compliance based on company policies
4. Generate alerts for timesheet anomalies


# Overview
Source: https://docs.kombo.dev/hris/getting-started

Let's get you up and running with our API!

<Note>
  This guide assumes you already have a Kombo account. If that's not the case,
  visit [our website](https://www.kombo.dev/) to learn more and get access.
</Note>

# Getting started

There are a few simple steps that you should follow to get started with our API.

1. [Get access to a sandbox integration](./getting-started/sandbox-integrations)
2. [Create an integration](./getting-started/create-integrations)
3. [Call our API](./getting-started/authentication)
4. [Querying the API](./getting-started/querying-api)
5. [Fetching Data](./getting-started/fetching-data)


# Authentication
Source: https://docs.kombo.dev/hris/getting-started/authentication

Learn how to authenticate with the Kombo API and manage API keys securely.

## Authentication

You need to get an API key from the Kombo dashboard to call our API.
You can create one on the [Secrets page](https://app.kombo.dev/secrets).

You might have multiple environments in your Kombo account. Each API key is
specific to an environment.

This will allow you to call some general endpoints that are not
integration-specific. For example, try calling the following test API key endpoint:

```bash theme={null}
curl --request GET \
  --url https://api.kombo.dev/v1/check-api-key \
  --header 'Authorization: Bearer <YOUR_API_KEY>'
```

## Calling Integration Endpoints

To call integration-specific endpoints, you need the integration ID. An integration ID identifies a specific
instance of a tool connected to Kombo. If you haven't created an integration yet,
read the [creating integrations guide](./create-integrations).
Get the integration ID from the details of integration on the [integrations dashboard page](https://app.kombo.dev/integrations).

Pass the integration ID with the `X-Integration-Id` header in your API requests. For example:

```bash theme={null}
curl --request GET \
  --url https://api.kombo.dev/v1/hris/employees \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'X-Integration-Id: <integration_id>'
```

<Note>
  Find out more about the integration-specific endpoints for
  [HRIS](/hris/getting-started) or [ATS](/ats/getting-started)
</Note>

## API Key Security

Kombo provides several features to help you manage API keys securely.

### Key Scoping

Each API key is scoped to a single [environment](../guides/environments) (Production or Development). Keys created in Production cannot access Development data and vice versa. The key prefix reflects the environment: `ks_prod_...` for production, `ks_dev_...` for development.

### Expiration

When creating an API key, you can set an optional expiration date. Once expired, any request using the key will return an authentication error. To rotate keys without downtime, you must overlap the old and new keys: create a new key, migrate all of your services to use it, and only then let the old key expire (or revoke it).

### IP Allowlisting

You can restrict each API key to a set of IP addresses or CIDR ranges. When an allowlist is configured, requests from non-listed IPs are rejected. An empty allowlist (the default) permits any IP. You can update the allowlist at any time without recreating the key.

### Revocation

API keys can be individually disabled from the dashboard. Disabling a key takes effect immediately — all subsequent requests using that key will fail. Disabled keys cannot be re-enabled; create a new key instead.

### Audit Trail

All key operations — creation, disabling, and IP allowlist changes — are recorded in the [audit log](../features/audit-logs).


# Creating Integrations
Source: https://docs.kombo.dev/hris/getting-started/create-integrations

Learn how to connect tools to Kombo.

<Note>
  This guide assumes you already have a Kombo account. If that's not the case,
  visit [our website](https://www.kombo.dev/) to learn more and get access.
</Note>

## Ways of Creating Integrations

There are three ways of creating integrations in Kombo:

1. **For you in development**: Use the Kombo Dashboard and enter the integration credentials yourself.
   This is the easiest way to get started if you want to test out Kombo.
2. **For customers with a magic link**: Create a magic link and send that to your customer to create the integration.
   This is the simplest way to launch integrations for selected customers (for example, as a POC).
3. **For customers with Kombo embedded**: Embedding Kombo into your application and allowing the customer to create the integration there.
   This will give your customer the best experience and is generally recommended when rolling out Kombo to your customers.

If you are testing Kombo or developing the integration to us, make sure to
select the development environment in the top left corner.
This will not count against your billing and will have useful features like saving
the credentials that you entered and filled out some fields by default.

# Creating Integrations in the Dashboard

<Tip>Recommended for development purposes.</Tip>

Go to the [dashboard integrations page](https://app.kombo.dev/integrations) and
click on the "Create Integration" button. Select `Create the integration yourself`.

<Frame>
  <img alt="image" />
</Frame>

Select a category and continue (if you use the development environment,
the organization and email will be auto-filled). Select a tool that you have
access to and enter the credentials. The flow will explain, in most cases, what
you need to do to get the credentials out of the tool.

# Creating a magic link

<Info>Use this to get started immediately with a selected customer.</Info>

Open the [dashboard integrations page](https://app.kombo.dev/integrations) and
click on the "Create Integration" button. Select *Let your customer create the integration*.

Select the category and fill out the organization name and email address.
This data is only for you to identify who created the integration and will be used
as a label in the dashboard.

Features that you can use with the embedded flow are:

* Pre-defining a tool
* Defining a language

# Embedding Kombo into your Application

<Info>
  This is only necessary if you want to allow your customer to create
  integrations completely on their own.
</Info>

Embedding Kombo in your application requires implementing the Kombo API into your product.
Embedding Kombo allows you to provide a better experience to your customers and customize the
connection flow the most.

Features that you can use with the embedded flow are:

* Pre-defining a tool
* Defining a language
* Specifying the `remote_environment` (for using sandbox credentials with some tools)
* Using a scope config template
* Setting the `origin_id` (id of the customer in your system)

<Note>
  Read more about embedding Kombo into your application
  [here](../guides/connect/embedded-flow).
</Note>


# Fetching Data
Source: https://docs.kombo.dev/hris/getting-started/fetching-data

Learn how to get the newest data back from Kombo.

To minimize latency between data changes in the connected tool and your system,
and to prevent data drift, we recommend combining data-changed notifications
with periodic full fetches.

Best-practice implementation:

* Listen to our **data-changed webhook** to receive notifications of data
  changes.
* Fetch only updated data.
* Periodically **fetch all data** to fully align your dataset and correct any
  potential data drift.
* Combine both strategies for a setup that is robust and efficient.

## Overview

```mermaid theme={null}
sequenceDiagram
    participant K as Kombo
    participant YS as Your System
    participant T as Timer

    Note over K,YS: Data-changed notifications
    K->>YS: Webhook: Data Changed
    YS->>K: Fetch Updated Data
    K-->>YS: Updated Data Response

    Note over T,YS: Periodic full fetch
    T->>YS: Periodic Trigger
    YS->>K: Fetch All Data
    K-->>YS: Full Data Response
```

## Listening to data-changed webhook

We provide a webhook called `data-changed`. This is sent to your system whenever
data has changed inside Kombo. For example, after:

* We finish syncing (full or delta sync)
* We receive an update through [upstream
  webhooks](/hris/guides/upstream-webhooks)

By listening to this webhook, you can receive updates from Kombo efficiently,
allowing for the best possible UX.

<Note>
  For near real-time updates, the connected tool must have upstream webhooks
  enabled for the integration. Some tools allow Kombo to enable these
  automatically, while others require a one-time manual step in the
  integration's Setup Flow by the end-customer. If upstream webhooks are not
  enabled or not supported, `data-changed` will reflect updates after the next
  scheduled sync.
</Note>

The webhook will look similar to this, with an array of models that have changed
in our database since we last sent you that webhook:

```json theme={null}
{
  "id": "FhghqjnCi9WuAoLT8Z75CFcs",
  "type": "data-changed",
  "data": {
    "integration_id": "bombohr:hris-dev",
    "integration_tool": "bombohr",
    "integration_category": "HRIS",
    "changed_models": [
      {
        "name": "hris_employees"
      }
    ]
  }
}
```

**Simplified approach**

To make things simple, you can, whenever you receive a new data-changed webhook,
pull the models you're interested in, independent of the models we're telling
you changed.

**Recommended approach**

You can also listen to the data models we're telling you changed and pull data
based on those models. For that please look into the [list of
models](#all-models) that can appear.

Based on this list of changed models, figure out which requests you would like
to send. Keep in mind that models do not map 1:1 to our endpoints. For example,
you might be using the `/employees` endpoint to fetch both employees and their
employments and team memberships.

Furthermore, after every successful fetch from us, store the timestamp of when
the respective fetch started. Use this timestamp during your next fetch and pass
it with your requests to the Kombo API as the `updated_after` query parameter.
Kombo will then only return the entries that changed since that timestamp. Read
more about this
[here](/hris/implementation-guide/reading-employees#fetching-only-updated-data).

**Good to know:** The `updated_after` filter also considers changes in models
that are returned by the endpoint as nested values. For example, the
`/employees` endpoint will include every employee that has had changes to
related employments or team memberships, even if the employee profile itself did
not change. Read more below.

## All models

You should call the endpoints you care about based on the models we tell you
have changed. The following table shows endpoints connected to the relevant
models that will be part of the data-changed webhook.

We recommend the following approach:

1. **Decide which endpoints are relevant for your use case** (e.g., if your
   system is centered around employees, you primarily use Get employees).
2. **Map changed models to those endpoints** using the table.<br />For instance,
   if both hris\_employees and hris\_employments are listed in the webhook, but
   you primarily care about employees, you only need to call Get employees,
   since employment and team membership data is included there too.

This helps avoid unnecessary API calls while still ensuring your data is up to
date.

| **Endpoint**                                                                         | **Models**                                                                                                                                                               |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [**Get absences**](/hris/v1/get-absences)                                            | hris\_absences<br />hris\_absence\_types                                                                                                                                 |
| [**Get employees**](/hris/v1/get-employees)                                          | hris\_employees<br />hris\_employments<br />hris\_join\_employees\_teams<br />hris\_legal\_entities<br />hris\_locations<br />hris\_teams<br />hris\_time\_off\_balances |
| [**Get employments**](/hris/v1/get-employments)                                      | hris\_employments                                                                                                                                                        |
| [**Get groups**](/hris/v1/get-groups)                                                | hris\_teams                                                                                                                                                              |
| [**Get skills**](/hris/v1/get-skills)                                                | hris\_skills<br />hris\_skill\_proficiency\_scales                                                                                                                       |
| [**Get employee skill proficiency ratings**](/hris/v1/get-skill-proficiency-ratings) | hris\_employee\_skill\_proficiency\_ratings<br />hris\_skill\_rating\_providers                                                                                          |
| [**Get time off balances**](/hris/v1/get-time-off-balances)                          | hris\_time\_off\_balances<br />hris\_absence\_types                                                                                                                      |
| [**Get timesheets**](/hris/v1/get-timesheets)                                        | hris\_timesheets                                                                                                                                                         |

## Preventing Data Drift

In addition to fetching data from Kombo's endpoints in response to receiving the
data-changed webhook, we recommend running a periodic full data fetch for the
data models you care about. In most cases, a 7-day schedule is ideal.

This helps to remedy any drift that may occur in your data, e.g. from accidental
manual changes or lost webhooks.

To implement this, perform GET requests for the Kombo data models you care about
without passing the `updated_after` query parameter. Then upsert the data
returned by Kombo and merge it with your existing data copy.

## Full Example Code

```ts theme={null}
async function handleDataChangedWebhook(body) {
  // Verify webhook sender here

  // Assuming we are using prisma as our ORM
  const integration = await prisma.integration.findUniqueOrThrow({
    where: {
      kombo_integration_id: body.data.integration_id,
    },
    select: {
      id: true, // Need the customer ID for the update
      last_fetched_from_kombo_at: true,
      kombo_integration_id: true, // Also select the integration ID
    },
  })

  // Track when WE start fetching (not when Kombo synced from the HRIS)
  const fetchStartDate = new Date() // This time should be in UTC
  const lastFetchStartDate =
    integration.last_fetched_from_kombo_at?.toISOString()

  // Fetch data only when data-changed webhook indicates a change
  const employeesChanged = !!body.data.changed_models.find(
    entry => entry.name === 'hris_employees',
  )
  if (employeesChanged) {
    await fetchEmployees(integration.kombo_integration_id, lastFetchStartDate)
  }

  await prisma.integration.update({
    where: {
      id: integration.id,
    },
    data: {
      last_fetched_from_kombo_at: fetchStartDate,
    },
  })
}

async function handleCronJob(integration) {
  const fetchStartDate = new Date() // This time should be in UTC

  // Do not pass a starting date here; fetch everything
  // Fetch the models you care about (repeat for employees, employments, groups, ...)
  await fetchEmployees(integration.kombo_integration_id)

  await prisma.integration.update({
    where: {
      id: integration.id,
    },
    data: {
      last_fetched_from_kombo_at: fetchStartDate,
    },
  })
}

async function fetchEmployees(integrationId: string, updatedAfter?: string) {
  let cursor
  do {
    const resp = await axios.get('https://api.kombo.dev/v1/hris/employees', {
      headers: {
        Authorization: `Bearer ${KOMBO_API_KEY}`,
        'X-Integration-Id': integrationId, // Use the stored integration ID
      },
      params: {
        cursor: cursor,
        updated_after: updatedAfter,
      },
    })

    cursor = resp.data.data.next

    // Implement your handling logic here
    // Usually, you will upsert the data into your database and build specific
    // domain logic here.
    await handleEmployeeData(integrationId, resp.data.data.results)
  } while (cursor)
}
```

## Understanding `changed_at` vs `updated_after` Behavior

A common source of confusion is understanding when records are returned by the
`updated_after` filter and how this relates to each record's `changed_at`
timestamp. Here's the key distinction:

### Record-level `changed_at` Field

Each record has a `changed_at` timestamp that **only updates when properties
directly on that record change**. For example:

* If an employee's `first_name` changes, the employee's `changed_at` updates
* If an employment's `job_title` changes, the employment's `changed_at` updates
* **However**: If an employment's job title changes, the related employee's
  `changed_at` field does **NOT** update

### Endpoint Filtering with `updated_after`

The `updated_after` parameter works differently - it returns records when
**either the record itself OR its nested data has been updated**:

#### Example: Employees Endpoint

When you call `GET /employees` with `updated_after`, you'll receive employees
if:

1. **Direct employee changes**: The employee itself was modified (name, email,
   etc.)
2. **Nested employment changes**: Employment data was updated (job title,
   salary, etc.)
3. **Nested team changes**: Team membership or team details were updated
4. **Nested location changes**: Work location details were updated

This means an employee can be returned even if their own `changed_at` timestamp
hasn't changed.

#### Concrete Scenario

Let's say you call `GET /employees` at 9:00 AM and get:

```json theme={null}
{
  "id": "emp123",
  "first_name": "Sarah",
  "changed_at": "2023-10-01T08:00:00Z",
  "employments": [
    {
      "id": "employment456",
      "job_title": "Software Engineer",
      "changed_at": "2023-10-01T08:00:00Z"
    }
  ]
}
```

At 10:00 AM, the employee's job title is changed to "Senior Software Engineer"
in the HRIS. If you then call
`GET/employees?updated_after=2023-10-01T09:00:00Z`, you'll receive:

```json theme={null}
{
  "id": "emp123",
  "first_name": "Sarah",
  "changed_at": "2023-10-01T08:00:00Z", // ← Same timestamp!
  "employments": [
    {
      "id": "employment456",
      "job_title": "Senior Software Engineer", // ← Updated data
      "changed_at": "2023-10-01T10:00:00Z" // ← New timestamp
    }
  ]
}
```

**Key Point**: The employee's `changed_at` remains unchanged, but the employee
is still returned because it contains updated nested employment data.

### Best Practice

When using `updated_after` filtering:

1. **Don't assume** a record was directly modified just because it's returned
2. **Compare nested data** to determine what actually changed
3. **Use the nested objects' `changed_at` fields** to identify which parts were
   updated
4. **Design your sync logic** to handle both direct and indirect changes

## FAQ

### Why do you not provide the changed data inside of data-changed?

We want to make integrating with Kombo as simple as possible for you. Since we
recommend running occasional full fetches anyways, it means you can re-use most
of your logic for both fetch types. Furthermore, this allows you to iterate and
upsert data at your own pace. Unlike if we were to send you a *really* large
payload after an initial sync. By listening to just this single unified webhook,
you are always guaranteed to benefit from our latest innovations to help you get
the freshest data.

### How often do you send the data-changed event? Do you debounce the webhook?

Yes, by default we debounce data-changed with a 30-second window. That means no
matter how many events we're receiving, you'll receive at most one webhook every
30 seconds.

This works as follows: The first time this event fires, we will pass it through
to you right away. Then we will wait 30 seconds. All the events we receive in
those 30 seconds will then be sent to you as a single update with the next
webhook.

For more details, please refer to the
[webhooks](/hris/guides/webhooks#data-changed) page.


# Querying the API
Source: https://docs.kombo.dev/hris/getting-started/querying-api

Learn how to filter and paginate the Kombo `GET` endpoints. This will help you implement incremental fetching and more.

## SDKs

You can use our officially supported SDKs to interact with our API. For more information, see the [Libraries and SDKs](/libraries-and-sdks) section.

## General Response Format

All *GET* endpoints of Kombo follow the same principle. All of them return a list
of results and a next cursor. All results follow the same basic structure with the
following properties:

* `id`: An ID generated by Kombo, also referred to throughout the documentation as "Kombo ID".
* `remote_id`: The ID of the object in the remote system. This can be null for some objects.
* `changed_at`: Part of Kombo's change tracking — this is the timestamp of the last change that was detected by Kombo.
* `remote_deleted_at`: Part of Kombo's change tracking — this is the timestamp where the object was not found anymore in the remote system.

*Other properties are model-specific.*

### A note on Kombo IDs and their uniqueness

We generate the Kombo ID by referencing the remote ID and the integration ID.

This results in the following statements being true:

* A Kombo ID is unique across all integrations for *the same model*.
  * This is because we reference the integration ID itself when generating the Kombo ID.
* A Kombo ID is *not* unique across different models for the same integration.
  * This will occur for remote systems that follow a sequential ID pattern. For example, both the first employee and department have the ID `1`. As the integration ID is the same, so will the Kombo ID.

## Pagination

Each request returns either a value on the `next` field or `null`. The
value will be a cursor which you can use to get the next page of results. Use
the `cursor` query parameter to request the next page. (Please note that you
still need to add the relevant filters while paginating.)

In addition, you can use the `page_size` parameter to specify the number of results per page.

```bash theme={null}
curl --request GET \
  --url 'https://api.kombo.dev/v1/hris/employees?cursor=eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0&page_size=100' \
  --header 'Authorization: Bearer <YOUR_API_KEY>'
```

## Filtering

All models provide the same filters in addition to some model-specific filters.
The following filters apply to all models:

* `updated_after`: Only return objects where the `changed_at` value is after
  the given timestamp. This can be used to fetch data incrementally.
  This filter also includes all expanded relations — so if only they have
  changed (but none of the primary attributes of the object), this will still
  count as the object having changed and it will still be returned.
* `include_deleted`: By default, all values with a `remote_deleted_at` value are
  not returned. If you want to include them, set this to `true`. This is helpful
  if you want to remove them from your database.
* `ids`: List of comma-separated ids. Only return objects with these IDs.
* `remote_ids`: List of comma-separated remote ids. Only return objects with
  these remote IDs.

## Error Codes

When the Kombo API encounters an error, it returns a structured error response with a specific `code` for programmatic handling.
For a complete list of error codes and detailed explanations see the [Error Handling guide](/guides/errors).

```json theme={null}
{
  "status": "error",
  "error": {
    "code": "REMOTE.INPUT_INVALID",
    "title": "The remote system returned validation errors.",
    "message": "Candidate field 'email' must be a valid email address for Greenhouse"
  }
}
```

## Rate limiting

The rate limiter restricts the number of API requests you can send to Kombo. Currently, we permit 300 requests over 60 seconds **per environment** (i.e., PROD or DEV environment). After the time window has passed, the limit is reset. If you need a higher quota, reach out to the Kombo team.

Independent of this cap, [concurrency limiting](../guides/concurrency-limiting) limits how many unified actions can run at the same time per integration.

This information is exposed as headers on the response of every authenticated API request:

| Header              | Sample Value | Description                                           |
| ------------------- | ------------ | ----------------------------------------------------- |
| ratelimit-limit     | 300          | The maximum number of requests permitted              |
| ratelimit-remaining | 298          | The remaining number of requests permitted            |
| ratelimit-reset     | 57           | The remaining seconds until the rate limiter is reset |

When exceeded, you will receive a failed response with the [error `code`](/guides/errors) of `PLATFORM.RATE_LIMIT_EXCEEDED`:

```json theme={null}
{
  "status": "error",
  "error": {
    "code": "PLATFORM.RATE_LIMIT_EXCEEDED",
    "title": "Rate limit exceeded.",
    "message": "Maximum requests are 300 every 60 seconds. Try again in 57 seconds.",
    "log_url": null
  }
}
```

### Concurrency limiting

In addition to rate limiting, Kombo applies [concurrency limiting](../guides/concurrency-limiting) to unified actions. While rate limiting caps total requests over a time window, concurrency limiting caps simultaneous in-flight unified actions per integration to prevent backpressure buildup on downstream tools. Endpoints for reading synced model data are not affected by concurrency limiting.

### Handling 429 responses

Both rate limiting and concurrency limiting return HTTP `429`, but they have different error codes and require different responses:

* **`PLATFORM.RATE_LIMIT_EXCEEDED`** -- You've sent too many requests in the current time window. This applies to all endpoints. Wait for `ratelimit-reset` seconds or retry with exponential backoff.
* **`PLATFORM.CONCURRENCY_LIMIT_EXCEEDED`** -- Too many unified actions are in flight for this integration. The underlying tool can't keep up. Retry the failed request after a short backoff (e.g., 1s, 2s, 4s). You likely still have rate limit quota remaining, so waiting for `ratelimit-reset` is unnecessary. See the [concurrency limiting guide](../guides/concurrency-limiting) for details.


# Remote Data
Source: https://docs.kombo.dev/hris/getting-started/remote-data

Learn how to use remote data to access any available field.

Remote data is a feature exposing the raw, unchanged data
that we receive from the APIs, allowing you to read data that might
not be available in our unified API model.

It is disabled by default because it has compliance implications
(we need to store all data we receive, not just the data points selected in the
scope configs) and because you will need to write parsing logic for each
integration/tool.

It is mainly used to read data that might not be available in our unified Data Models.
Some customers are for example interested in some specific government-issued
company IDs, which are currently not part of our Data Model, but can be extracted
from these raw responses. An example response might be:

```json theme={null}
{
  "status": "success",
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "first_name": "John",
        "last_name": "Doe",
        ...
        "remote_data": {
          "EmployeeData": {
            "Names": {
              "FirstName": "John",
              "LastName": "Doe"
            },
            "Company": {
              "GovernmentID": "123456789"
            }
          }
        }
      }
    ]
  }
}
```

<Info>
  `remote_data` gives you the raw API response from the connected system. If you
  need **structured** extra fields for reading, see [Custom
  Fields](../features/custom-fields). If you need to **write** additional data
  when creating records, see [Remote
  Fields](/extending-the-model#remote-fields).
</Info>

## When to use remote data

Remote data should be used when our unified Data Model does not offer specific
fields that you are interested in. Note that we do not unify remote data, so the
data structure might differ between tools and might even differ between
individual integrations of the same tool.

## When not to use remote data

Remote data might potentially expose sensitive data, even if your customers
opt out of it. We might, for example, always receive personally identifiable
information (e.g. emails, names and addresses). If your customers opt out of
these data fields, we will discard this data and never store it.
If remote data is active, however, we will expose the raw responses and therefore
information that should optimally not be stored.

We also offer [custom fields](../features/custom-fields), which are a more versatile and compliant variant
of remote data.

## How to use remote data

Remote data can be enabled on a per-model basis in the scope config. To enable
it, please contact us.


# Sandbox Integrations
Source: https://docs.kombo.dev/hris/getting-started/sandbox-integrations

Learn how to access tools you can connect to Kombo for development purposes.

If you wish to get started as quickly as possible, use our built-in **Sandbox Integration (HRIS/ATS/LMS)**.
You can find it in the **"Integrations"** section in the Kombo dashboard. The sandbox integration
is only available in your [development environment](../guides/environments#development).

<Card title="Sandbox Integration" icon="flask" href="../connectors/sandbox">
  Connect the built-in sandbox to start exploring the API right away — no
  credentials required.
</Card>

### What the sandbox covers

The sandbox requires **no credentials** and can be set up in minutes. It
provides a representative dataset that covers common edge cases you'll encounter
in production — including active, terminated, and pending employees, multiple
currencies, and various bank account formats.

**Read data** — the sandbox includes data for all major models:

* **HRIS**: Employees, employments, groups, locations, legal entities, absences,
  absence types, time-off balances, timesheets, performance reviews, skills,
  and employee skill proficiency ratings
* **ATS**: Candidates, applications, jobs, job posts, stages, offers,
  interviews, rejection reasons, users
* **LMS**: Users, courses, skills, providers, progress records

**Write actions** — all major write operations work against the sandbox:

* **HRIS**: Create employees, create/delete absences, upsert employee skill
  proficiency ratings
* **ATS**: Create candidates (with applications), move applications to stages,
  add attachments, add/remove tags, add notes
* **LMS**: Enroll users, mark completions, create and manage courses

The sandbox dataset is **deterministic** — syncs always return the same base
data, making it well-suited for automated testing with stable assertions.
Records created through write actions persist in Kombo's database and appear in
subsequent API calls, but don't modify the base dataset.

### Third-party sandboxes

Some tools also offer free demo accounts that you can use to test out Kombo.

We recommend the following tools, as they provide great coverage and are broadly used:

* When testing HRIS integrations, we recommend using [Personio](https://www.personio.com/free-trial/).
* When testing ATS integrations, we recommend using [Recruitee](https://auth.recruitee.com/sign-up). If you want to gain access to a sandbox instead of using the free trial, please fill out [this form](https://www.tellent.com/technology-partner-application). In the section “Please describe the use case for this integration on a high-level”, mention “Referred by Kombo”.

Additionally, here are some more tools that offer free trials or test accounts: [BambooHR (HRIS)](https://www.bamboohr.com/signup/), [Sage HR (HRIS/ATS)](https://sage.hr/register), [Deel (HRIS)](https://app.deel.com/signup), [CharlieHR (HRIS)](https://www.charliehr.com/join), [Planday (HRIS)](https://www.planday.com/signup/), [Factorial (HRIS)](https://factorialhr.com/get-started), [Humaans (HRIS)](https://app.humaans.io/signup), [BreezyHR (ATS)](https://breezy.hr/signup), [Jazzhr (ATS)](https://info.jazzhr.com/free-trial.html), [Join (ATS)](https://join.com/auth/signup/recruiter), [Teamtailor (ATS)](https://tt.teamtailor.com/users/new?locale=en), [Workable (ATS)](https://www.workable.com/free-trial)

### Enterprise tools

Enterprise tools like Workday, SAP SuccessFactors, or SmartRecruiters usually
don't offer free sandbox access. However, for customers on the enterprise plan,
we offer joint testing sessions with these enterprise tools.


# Concurrency Limiting
Source: https://docs.kombo.dev/hris/guides/concurrency-limiting

Concurrency limiting caps simultaneous in-flight unified actions per integration, giving you fast feedback instead of slow timeouts.

## What is concurrency limiting?

When you invoke unified actions in Kombo (e.g., creating a candidate, moving
an application, reading attachments), each call is forwarded to the underlying HR or ATS tool.
These tools have their own rate limits, which are often significantly lower than
what Kombo allows.

If many unified actions run in parallel, they all compete for limited
downstream throughput. Completion times grow, your HTTP clients may hit
timeouts while work is still in flight, and retries can overlap with operations
that are still running.

Concurrency limiting solves this by capping how many unified actions
can be processed simultaneously per integration. When the cap is
reached, additional requests are immediately rejected with a `429` status code.
This gives you a fast, clear signal to retry with backoff instead of stacking
unbounded in-flight work that might eventually time out on your side.

<Note>
  Concurrency limiting only applies to unified actions (calls that run work
  against the underlying tool). Model endpoints for reading synced data are not
  affected.
</Note>

<Frame>
  <img alt="Two-panel diagram comparing overload (client timeout before completion, ambiguous retries) with concurrency limiting (429 and controlled in-flight work)." />
</Frame>

## How it differs from rate limiting

For Kombo-wide request volume over time, see [Rate limiting](../getting-started/querying-api#rate-limiting).

|                    | Rate Limiting                  | Concurrency Limiting                  |
| ------------------ | ------------------------------ | ------------------------------------- |
| **What it caps**   | Total requests per time window | Simultaneous in-flight requests       |
| **Scope**          | All API requests               | Unified actions only                  |
| **When it resets** | After the time window elapses  | As in-flight requests complete        |
| **Error code**     | `PLATFORM.RATE_LIMIT_EXCEEDED` | `PLATFORM.CONCURRENCY_LIMIT_EXCEEDED` |

Both return HTTP `429`, but with different error codes and headers.

## Response headers

When concurrency limiting is active, every unified action response includes two headers:

| Header                  | Example | Description                                                                             |
| ----------------------- | ------- | --------------------------------------------------------------------------------------- |
| `Concurrency-Limit`     | `30`    | The maximum number of concurrent in-flight unified actions allowed for this integration |
| `Concurrency-Remaining` | `12`    | How many additional concurrent unified actions can be accepted right now                |

The limit may vary per integration. Sensitive integrations (e.g.,
reverse-engineered APIs) may have significantly lower limits. Use the response
headers to discover the actual limit rather than assuming a specific number. The
default limit is 30.

These headers appear on both successful responses and `429` rejections, so you can monitor utilization proactively.

## Handling concurrency limit errors

When you exceed the concurrency limit, you receive a `429` response with the error code `PLATFORM.CONCURRENCY_LIMIT_EXCEEDED`. The response includes both concurrency and rate limit headers:

```
HTTP/1.1 429
concurrency-limit: 30
concurrency-remaining: 0
ratelimit-limit: 1000
ratelimit-remaining: 834
ratelimit-reset: 44
```

```json theme={null}
{
  "status": "error",
  "error": {
    "code": "PLATFORM.CONCURRENCY_LIMIT_EXCEEDED",
    "title": "Concurrency limit exceeded.",
    "message": "Maximum concurrent action requests per integration is 30. Currently 30 in flight."
  }
}
```

Notice how the rate limit headers show remaining quota (`ratelimit-remaining: 834`) while the concurrency headers show no remaining slots (`concurrency-remaining: 0`). This tells you:

* The underlying tool is at capacity for this integration, not Kombo itself.
* You still have rate limit quota, so waiting for `ratelimit-reset` is unnecessary.
* Slots free up quickly as in-flight requests complete, so a short retry is effective.

### How to retry

For `PLATFORM.CONCURRENCY_LIMIT_EXCEEDED`, retrying the same request is
expected and does not run the unified action twice. Kombo rejects the call
before the unified action runs (no concurrency slot was acquired). That differs
from failures where the outcome is unclear, e.g., a timeout after a write may
still have succeeded, so retries need extra care.

1. Retry the failed request with exponential backoff: start with a short delay (e.g., 1s) and increase on repeated `429`s (2s, 4s, 8s, ...).
2. Optionally, throttle proactively: check `Concurrency-Remaining` on successful responses to slow down before hitting the limit.

## What this means for your integration

Concurrency limiting does not cap steady-state throughput below what the
downstream tool can sustain. The integrated system still bounds how fast work
completes. The limit turns that constraint into immediate `429` responses
instead of long waits and unbounded in-flight unified actions.


# Embedded flow
Source: https://docs.kombo.dev/hris/guides/connect/embedded-flow

Embed Kombo Connect into your app for the most seamless experience.

If you've gone through the general [Kombo Connect](./introduction) documentation,
you'll know there are
[different ways of using the flow](./introduction#getting-started). Our embedded flow
provides the most seamless experience to your customers but also involves some
engineering on your side. In this guide, we'll go over what that means exactly.

## Implementing the flow

The embedded flow requires you to:

* Add an **endpoint** to your back-end for initiating the flow
* Add a **button** to your frontend to show the flow to your user using the SDK
* React to a flow being completed through the "activation token" returned by the SDK or by listening to a webhook

Let's go over each of these steps in detail.

### Adding the endpoints

Both endpoints are mostly just wrappers around endpoints of the Kombo API and
mainly exist for security reasons (so that malicious actors can't set up
arbitrary integrations in your Kombo environment).

#### Initiating the flow

The first one initializes the flow by calling the Kombo API and returns a link
that we then use in the frontend:

```js Node.js (Express + Axios) theme={null}
app.post('/integrations/kombo/init', async (req, res) => {
  // TODO: Get user details from your database
  const user = await getUser()

  const response = await axios.post(
    'https://api.kombo.dev/v1/connect/create-link',
    {
      end_user_email: user.email,
      end_user_organization_name: user.company.name,
      end_user_origin_id: user.company.id,

      integration_category: 'HRIS',
    },
    {
      headers: {
        authorization: `Bearer ${KOMBO_API_KEY}`,
      },
    },
  )

  res.send({ link: response.data.data.link })
})
```

The `end_user_*` fields identify which of your customers an integration belongs to:

* **`end_user_email`** (required): Contact email for this end user. Used as a label in the dashboard and included in webhooks.
* **`end_user_organization_name`** (required): Company name. Used as a label in the dashboard and included in webhooks.
* **`end_user_origin_id`** (optional): Your internal ID for this customer. Echoed back in webhooks and API responses so you can map integrations to your own records.

These fields are metadata — they do not affect integration identity. Changing the email or organization name in a subsequent `create-link` call with the same `end_user_origin_id` does **not** update an existing integration; it creates a new flow link.

<Warning>
  Kombo does **not** deduplicate integrations based on these fields. Each
  completed flow creates a new integration. You are responsible for preventing
  customers from connecting the same tool twice. Use the [reconnection
  link](../../v1/post-integrations-integration-id-relink) if a customer needs to
  update their credentials for an existing integration.
</Warning>

#### Reacting to the flow being completed

After your user completes the flow, you can retrieve the integration details and store them in your database for future use. There are two ways to achieve this:

1. By using the ["Get integration by token" endpoint](../../v1/get-connect-integration-by-token-token)
2. By listening to the `integration-created` webhook

**Option 1: Using the endpoint**

The activation token is returned from the frontend after the user completes the integration flow. You can use this token to retrieve the integration details via the ["Get integration by token" endpoint](../../v1/get-connect-integration-by-token-token) and store them in your database.

Here's how you might implement the activation endpoint:

```js Node.js (Express + Axios) theme={null}
app.post('/integrations/kombo/activate', async (req, res) => {
  const response = await axios.get(
    `https://api.kombo.dev/v1/connect/integration-by-token/${req.body.token}`,
    {
      headers: {
        authorization: `Bearer ${KOMBO_API_KEY}`,
      },
    },
  )

  const integrationId = response.data.data.id

  // TODO: Store the integration ID in your database

  res.sendStatus(200)
})
```

**Option 2: Listening to the `integration-created` Webhook**

Alternatively, you can set up a webhook endpoint on your backend to listen for the `integration-created` event that Kombo sends when a new integration is created. This webhook contains the integration ID and other relevant details, allowing you to associate the integration with your user in your database.

Here's how you might set up the webhook endpoint:

```js Node.js (Express) theme={null}
app.post('/webhooks/kombo/integration-created', async (req, res) => {
  const integration = req.body.data

  // TODO: Verify the webhook signature for security purposes

  // TODO: Store the integration ID in your database

  res.sendStatus(200)
})
```

* Make sure to [verify the webhook signature](../../guides/webhooks#validate-the-data) to ensure that the request comes from Kombo.
* Make sure to set up the webhook in the [dashboard](https://app.kombo.dev/configuration/webhooks).

### Adding the button

For now, we're all set on the back-end side, so let's switch to the front-end:

Here we'll have to add a button that lets your users start the flow. Most of our
customers already have an "Integrations" page within their product's settings.
If you do, too, then that's the perfect place to add the button.

How exactly you're going to do this will depend on your tech stack, but it's
probably going to look something like this:

<CodeGroup>
  ```jsx React theme={null}
  <button onClick={() => connectHris()}>Connect HRIS</button>
  ```

  ```jsx Vue.js theme={null}
  <button @click="connectHris()">
    Connect HRIS
  </button>
  ```

  ```html HTML theme={null}
  <button onclick="connectHris()">Connect HRIS</button>
  ```
</CodeGroup>

<br />

<Note>
  Right now, we require you to specify the integration category when
  initializing the flow, so you'll likely want to label your button accordingly
  (e.g., "Connect HRIS" or "Connect ATS").
</Note>

When a user clicks on the button, two things need to happen:

* An integration link has to be retrieved through your endpoint
* The embedded flow has to be started

#### Getting a link

Here's what the first part might look like:

```js JavaScript theme={null}
async function getKomboConnectLink() {
  // Note: The URL below points to *your* API and could be different
  const response = await fetch('/integrations/kombo/init')
  const data = await response.json()

  return data.link
}
```

#### Opening the flow

Now it's time to actually show the flow to the user. This can be through
[the @kombo-api/connect JavaScript library](https://www.npmjs.com/package/@kombo-api/connect).
It's tiny (about 50 lines of JavaScript as of now) and basically just
initializes an `<iframe>` to display the flow.

<Note>
  **Important:** Since the Kombo Connect flow is displayed in an iframe, you'll need to ensure your Content-Security-Policy allows it. Add `frame-src https://connect.kombo.dev` to your CSP header:

  ```
  Content-Security-Policy: frame-src https://connect.kombo.dev;
  ```
</Note>

Let's, first of all, add it as a dependency to our front-end:

<CodeGroup>
  ```bash npm theme={null}
  npm install @kombo-api/connect
  ```

  ```bash yarn theme={null}
  yarn add @kombo-api/connect
  ```

  ```bash pnpm theme={null}
  pnpm add @kombo-api/connect
  ```
</CodeGroup>

Then, import it like so:

```js JavaScript theme={null}
import { showKomboConnect } from '@kombo-api/connect'
```

##### Can't use npm packages or imports?

You can also load the library from the unpkg CDN:

```html HTML theme={null}
<script src="https://unpkg.com/@kombo-api/connect@1/dist/index.js"></script>
```

This makes the library available globally as `KomboConnect`.

#### Reacting to the flow being completed

After the user completes the flow, you'll receive an activation token. This token can be used to retrieve the integration details from Kombo. Depending on the method you choose (activation endpoint or webhook), you'll handle this token differently.

If you're using the activation endpoint, send the token to your backend:

```js JavaScript theme={null}
async function activateKomboIntegration(token) {
  // Note: The URL below points to *your* API and could be different
  const response = await fetch('/integrations/kombo/activate', {
    method: 'POST',
    body: JSON.stringify({ token }),
  })
}
```

If you're using the webhook method, you don't need to handle the activation token on the frontend. Instead, the webhook will notify your backend when a new integration is created.

### Putting all together

Now it's time to put it all together:

```js JavaScript theme={null}
// You can call this whatever you want (just attach this to your button)
async function connectHris() {
  // We wrote this function earlier (make sure to import/include it)
  const link = await getKomboConnectLink()

  const activationToken = await showKomboConnect(link)

  // Not necessary if you're reacting to the `integration-created` webhook
  await activateKomboIntegration(activationToken)
}
```

<Info>
  **What if the user doesn't finish?** No integration is created until the user
  completes the entire flow. Abandoned or closed flows leave no orphan records
  in Kombo. You can safely generate a new link via `POST /connect/create-link`
  for the user to retry. To avoid duplicate integrations for users who *do*
  complete the flow, track completed `integration_id`s on your side, ideally via
  webhook.
</Info>

And that's it! You've successfully embedded Kombo Connect!


# Introduction
Source: https://docs.kombo.dev/hris/guides/connect/introduction

Our interactive embeddable connection flow.

<img alt="1376" />

We know that the experience of setting up new integrations is just as core to
your application as the integrations themselves, so we've put special care into
making this as easy and user-friendly as possible for your customers.

*The best part:* **Kombo Connect** — that's what we call our interactive
connection flow — can be
[fully embedded within your own application](./embedded-flow).

## How it works

To get a better idea of how Kombo Connect fits into your application, let's take
a look at the typical flow a customer will go through:

1. They **initiate the flow** within your app (e.g., through a "Connect HRIS"
   button)
2. They are **presented with the Kombo Connect UI** where they can:
   * Select the tool they want to connect (e.g., Factorial)
   * Get an overview of the requested data points (see [Scopes](../../features/scopes))
   * Grant access to the requested data points
   * See which credentials are required to set up the tool and how to get them
   * Enter the necessary credentials (e.g., an API key)
3. They **return to your app**, and their integration has been set up

## Getting started

The flow described above applies to the situation where you've
[*embedded* the Kombo Connect flow](./embedded-flow) into your own app. This
provides the most seamless experience but isn't the quickest way to get started.

If you just want to try out Kombo quickly and **onboard selected customers**,
consider these other options that **don't require any changes to your app**:

<CardGroup>
  <Card title="Manual setup" icon="wrench" href="./manual-setup">
    Perfect when you *already have* the relevant credentials from your customer
    and just want to add the integration to Kombo
  </Card>

  <Card title="Magic links" icon="wand-magic-sparkles" href="./magic-links">
    Similar in that they also don't require any code, but they still allow your
    customers to go through the flow and enter the credentials themselves.
  </Card>
</CardGroup>


# Magic links
Source: https://docs.kombo.dev/hris/guides/connect/magic-links

Let your customers set up integrations without changing your app.

When you're just getting started with Kombo, you might not want to invest in the
time into building a proper integration with [Kombo Connect](./introduction) yet.
Because of that, we allow you to send what we call "Magic links" to your
customers that allow them to go through the connection flow without you having
to change anything about your application.

## Setting up an integration

To get started, open up [the dashboard](https://app.kombo.dev) and click on "New
integration":

<Frame>
  <img alt="1448" />
</Frame>

Then, select "Let your customer create the integration":

<Frame>
  <img alt="764" />
</Frame>

In the next step, select the integration category (e.g., HRIS) and which
customer it's for:

<Frame>
  <img alt="1762" />
</Frame>

After clicking "Continue," you'll get a link that you can share with your
customer:

<Frame>
  <img alt="786" />
</Frame>

Clicking on this link will take your customer to a special version of the Kombo
Connect flow hosted by us:

<Frame>
  <img alt="1376" />
</Frame>

After they've gone through the flow, the integration will be set up and we will
send you a [webhook](../webhooks). You can then start using our unified API. To
learn more about that, check out
[our general Getting Started guide](../../getting-started).


# Manual setup
Source: https://docs.kombo.dev/hris/guides/connect/manual-setup

Manually set up integrations on behalf of your customers.

When you're just getting started with Kombo, you might not want to invest the
time into building a proper integration with [Kombo Connect](./introduction) yet.
Because of that, we allow you to *manually* set up integrations through the
Kombo Dashboard.

## Setting up an integration

To get started, open up [the dashboard](https://app.kombo.dev) and click on "New
integration":

<Frame>
  <img alt="1448" />
</Frame>

Then, select "Create the integration yourself":

<Frame>
  <img alt="758" />
</Frame>

In the next step, select the integration category (e.g., HRIS) and which
customer it's for:

<Frame>
  <img alt="1762" />
</Frame>

After clicking "Continue," you'll then be presented with the regular
[Kombo Connect](./introduction) flow, except that in this case, it's *you* going
through it and not your customer:

<Frame>
  <img alt="1376" />
</Frame>

After going through the flow, the integration will be set up, and you can start
using our unified API. To learn more about that, check out
[our general Getting Started guide](../../getting-started).


# Reconnecting an integration
Source: https://docs.kombo.dev/hris/guides/connect/reconnection

This document explains why and how to reconnect an integration.

## When to reconnect an integration

### Authentication issues

Sometimes customers change integration authentication details, API keys expire,
or other integration setup details are changed and Kombo can no longer
authenticate with an integration that was previously connected.

After three consecutive days of failing authentication (which we check before every
sync), Kombo will pause scheduling syncs and will prompt you to reconnect the
integration.

#### How to Identify Authentication Issues

Authentication issues can be identified in two ways: programmatically (recommended) or operationally via the Kombo dashboard.

1. **Programmatically:**
   Use the [Integration State Changed webhook](../../guides/webhooks#integration-state-changed). This webhook allows you to monitor changes in the `state` value, helping you quickly detect authentication-related issues.

2. **Operationally:**
   Open the [integrations list](https://app.kombo.dev/integrations). An [issue](../../features/issues) appears on the integration as soon as authentication starts failing, and the integration state updates as well.

By leveraging these approaches, you can promptly diagnose and address authentication challenges.

### Changes in data scope

If you want to update which data you're interacting with in your customer's HR
systems, you will likely need to update your [Kombo scope config](../../features/scopes).
Updating your scope config in Kombo will usually go hand in hand with your
customer having to update their API credentials. Therefore, expanding your scope
config will likely end up with syncs showing warnings that not all permissions
are granted to the API credentials.

Syncs failing due to scope-mismatches can be avoided by using reconnection
links, as described [below](#a-note-on-updating-the-scope-config).

## Methods of reconnecting

### Use the dashboard to create an update link

In the [Kombo dashboard](https://app.kombo.dev), navigate to any integration
that you want to reconnect. Scroll down to the **Relink integration** section to
create an update link.

You can send this link to your customer to update the credentials of the
integration. Once they have reconnected successfully, syncs will run using the
newly entered credentials.

<Frame>
  <img alt="image" />
</Frame>

### Use the API to create a reconnection link

You can also create a reconnection link using the [create reconnection link endpoint](../../v1/post-integrations-integration-id-relink).
Specify the `link_type` for it to be used either in the [embedded flow](../connect/embedded-flow),
or sent out as a [magic link](../connect/magic-links).

## A note on updating the scope config

You are able to define the scope config of a reconnection link both in the UI
and using the API.

<Frame>
  <img alt="image" />
</Frame>

Setting a different scope config than the current integration's scope config
results in the following:

* Your customer will see the updated scope config in the connection flow (i.e.,
  they will have to create credentials with the newly desired permissions)
* On connection flow completion, the scope config of the integration will
  automatically be updated to reflect the new scope config

Use this functionality to smoothly migrate your customers to a new scope config,
without running into any sync issues. While the reconnection link has not been
completed, syncs will continue successfully working using the old scope config;
the new scope config will only be used once the reconnection link has been
completed.


# Troubleshoot connection flow problems
Source: https://docs.kombo.dev/hris/guides/debugging/debug-connection-flow

Investigate and resolve issues that prevent your customers from connecting.

<Frame>
  <img alt="Pending connection detail view" />
</Frame>

When a customer cannot finish the connection flow, work through the steps below to isolate whether the problem originates from the customer’s configuration, Kombo, or the remote tool.

## 1. Identify the failing connection

* Open the [Pending Connections page](https://app.kombo.dev/pending-connections) in the dashboard.
* Locate the affected connection and open its detail view. This page aggregates the context you need, including flow status and quick links.
* If you can't find the connection, you can also try to locate it from the [Logs page](../../features/logs).

## 2. Inspect event and request logs

* Use the **Event Log** tab to understand exactly which step failed and what the customer saw in the UI. These entries often include an error message or hints the customer might have missed.
* Switch to the **Logs** tab to inspect the HTTP calls Kombo made:
  * Review failing requests. HTTP `401`/`403` responses typically mean a missing permission on the customer’s side.
  * `500`-level responses usually indicate a temporary issue in the remote tool—confirm their status page or retry later.
  * Other status codes (e.g. validation errors) can surface configuration issues on Kombo’s side.
  * Also inspect the response bodies, they might contain more information on whats failing.

<Frame>
  <img alt="Event log vs. request log tabs" />
</Frame>

For a deeper dive into logs, see [Logs](../../features/logs) and [Komboman](../../features/komboman) for reproducing calls manually.

## 3. Validate setup with connection guides

* Share the [connection guide](https://help.kombo.dev/hc/en-us/sections/14349683218961-Connection-Guides) for the tool with your customer. The guide lists mandatory permissions, API scopes, and any tool-specific prerequisites.
* Confirm that the customer followed the guide
* If the guide highlights optional scopes your product relies on, ensure the customer understands why they must be enabled.


# Diagnosing missing or incorrect data
Source: https://docs.kombo.dev/hris/guides/debugging/debug-data-issues

A step-by-step guide to troubleshooting data discrepancies between Kombo and the remote tool.

When customers report missing, outdated, or incorrect data, the goal is to determine whether the discrepancy exists inside Kombo or originates from the remote tool.

This guide provides a structured workflow to pinpoint the issue and resolve it.

## 1. Verify the data in Kombo

First, check if the data is actually missing or incorrect in Kombo's own database.

### Check Data Quality View

Use the Data Quality View to see how many data points are synced for each model and field. This helps you to get an overview whether the data is complete.

<img alt="Data Quality View" />

### Check Data Explorer

Use the [Data Explorer](../../features/data-explorer) to inspect specific records. The data explorer shows the ground truth inside of Kombo. You can find all records and their fields values inside of the data explorer.

<img alt="Data Explorer" />

### Validate with Komboman

Use [Komboman](../../features/komboman) to make requests to the Kombo API (e.g., `GET /hris/employees` or `GET /ats/applications`) and check the JSON response directly.

<img alt="Komboman" />

<Note>
  If the data is correct and up-to-date in Kombo but missing or incorrect in
  your system, the issue is likely with how you fetch data from Kombo. Ensure
  you are [syncing data correctly](../../getting-started/fetching-data).
</Note>

## 2. Check the data in the remote tool

If the data is missing or wrong inside the Kombo app, we need to verify what Kombo is receiving from the remote tool.

### Use the Custom Field Explorer

The [Custom Field Explorer](../../features/custom-fields#map-fields-based-on-live-data) shows you all the raw fields Kombo has discovered from the remote tool, including those that aren't mapped to Kombo's unified model.

* If you see the field here, Kombo has access to the data, but it just isn't mapped to a standard field. You can use remappings to update the mapping of the field that is wrong.
* This at times might not show all the fields.

<img alt="Custom Field Explorer" />

### Inspect Request Logs

Go to the [Logs page](../../features/logs) to find the actual HTTP requests Kombo performed during the sync.

* Look for the relevant endpoint (e.g., `/GET employees`).
* Inspect the **Response Body** to see the raw data Kombo received.
* You can even replay the request in [Komboman](../../features/komboman) to see the live response.

<img alt="Request Logs" />

### Use Komboman (Passthrough)

If you can't find the request in the logs, use [Komboman](../../features/komboman) to manually send a request to the remote tool's API (using the "Passthrough" mode).

* This uses the customer's actual credentials, so it shows you exactly what the API returns.
* Compare this raw JSON with what you expected to see.

## 3. Resolutions

Once you've identified where the data is missing, use these steps to resolve the issue.

### Data is not available or incorrect in the remote tool

If you cannot find the correct data in the remote tool's API response (via Komboman or Logs), Kombo cannot sync it.

* **Permission Issue**: The most common cause is that the API user/token connected to Kombo does not have permission to view these fields. Ask the customer to check their permissions and scope settings in the remote tool.
* **Setup Issue**: The specific field wasn't exposed. Read the [connection guide](https://help.kombo.dev/hc/en-us/sections/14349683218961-Connection-Guides) for the tool. Some tools require additional setup, for example, to read custom fields.
* **Wrong Endpoint**: Some tools return data only on specific endpoints. Verify in the tool's documentation if the data is expected to be returned by the endpoint Kombo is calling (which you found in the logs).

### Data is correct in the remote tool, but not in Kombo

If you see the correct data in the raw API response but it doesn't appear (or appears incorrectly) in Kombo's unified API:

* **Check Scope Configuration**: Ensure the model or field is enabled in the integration's scope configuration. If a scope is disabled, Kombo will drop that data.
* **Check Filtering**: Verify if the record is being excluded by [filtering](/hris/features/filtering/introduction) configuration. For example, employees might be filtered out based on their employment status or location (HRIS), or applications might be skipped due to [upstream filtering](/ats/features/upstream-filtering) (ATS).
* **Remap the Data**: If the data is present but not in the field you expect (or is a custom field), you can map it manually:
  * Use [Custom Fields](../../features/custom-fields) to map the raw field to a new property in Kombo.
  * Use [Remapping](../../features/remapping/introduction) to override where a standard field gets its value from.


# How to troubleshoot issues with Kombo
Source: https://docs.kombo.dev/hris/guides/debugging/introduction

Identify and resolve issues across connections, data, and actions using Kombo’s troubleshooting tools.

This guide helps you understand how to **troubleshoot and resolve issues in Kombo**—whether that’s missing data, connection problems, or failing actions.

Kombo provides built-in tooling like [Issues](../../features/issues), [Komboman](../../features/komboman), [Logs](../../features/logs), or the [Data Explorer](../../features/data-explorer) so you can investigate what’s happening behind the scenes and often fix problems yourself.

By the end of this guide you will be able to:

* verify whether an issue lies within Kombo or the connected tool
* choose the right troubleshooting tool for each situation
* collect the right evidence before reaching out to Kombo support

## Kombo support

Our support team is always here to help—but in many cases you can diagnose and even resolve issues yourself using the tools described below. When contacting support, include:

* a short description of what’s wrong
* the affected integration(s) or customers
* any screenshots, logs, or links from your troubleshooting steps

The more detail you share, the quicker we can get you back up and running.

## Common issues

<CardGroup>
  <Card title="Connection issues" icon="link-slash" href="./debug-connection-flow">
    Pending connection fails, customers get stuck in the flow, or you need to
    force a connection.
  </Card>

  <Card title="Data quality issues" icon="magnifying-glass" href="./debug-data-issues">
    Records look missing, outdated, or mapped incorrectly inside Kombo or your
    product.
  </Card>

  <Card title="Action issues" icon="bolt" href="./investigate-failing-actions">
    A write, passthrough, or dashboard-triggered action fails and you need to
    see why.
  </Card>
</CardGroup>

## Key tools for troubleshooting

<CardGroup>
  <Card title="Issues" icon="triangle-exclamation" href="../../features/issues">
    See which integrations currently need attention, and how long the problem
    has been observed.
  </Card>

  <Card title="Komboman" icon="terminal" href="../../features/komboman">
    Send manual Kombo or passthrough API requests to validate data or retry
    failing operations.
  </Card>

  <Card title="Logs" icon="scroll" href="../../features/logs">
    Inspect sync, action, and connection flow logs including detailed
    request/response payloads.
  </Card>

  <Card title="Data Explorer" icon="table" href="../../features/data-explorer">
    Inspect specific records and their field values to see the ground truth
    inside of Kombo.
  </Card>

  <Card title="Custom field explorer" icon="list" href="../../features/custom-fields#map-fields-based-on-live-data">
    Discover available custom fields in the remote tool and map them into Kombo.
  </Card>

  <Card title="Remapping" icon="sliders" href="../../features/remapping/introduction">
    Adjust how Kombo maps data into your models when the default setup is not
    the right fit.
  </Card>

  <Card title="Custom & remote fields" icon="grid" href="../../features/custom-fields">
    Learn how to work with Kombo’s field model, including automatic mapping
    rules and remote references.
  </Card>
</CardGroup>


# Investigate failing actions
Source: https://docs.kombo.dev/hris/guides/debugging/investigate-failing-actions

Diagnose failed write actions using Logs and Komboman.

While most actions succeed automatically, occasional failures are inevitable when syncing data with external systems. Strict validation rules, changing permissions, or complex data dependencies can sometimes cause requests to be rejected.

This guide introduces tools like [Logs](../../features/logs) and [Komboman](../../features/komboman) to help you isolate and understand the error.

## 1. Find the action in the logs

<Frame>
  <video />
</Frame>

To find the relevant log entry, head to the [Logs page](../../features/logs) and use the filters on the top:

* **Type**: Select **Action** to see only write operations (excluding syncs and webhooks).
* **Status**: Select **Failed** to focus on the errors.
* **Integration**: Narrow down results to a specific customer connection.
* **Date**: If you know when the error happened, setting a time range helps filter out noise.

Once you've filtered the list, you should see the failed action.

## 2. Inspect the logs

Click on the log entry to open the detail view. This is your view for understanding what happened.

* **Review the input**: Check the `Incoming Request` tab to see exactly what data you sent to Kombo.
* **Inspect the requests**: An action often involves multiple HTTP calls to the remote tool. Check the timeline for any failed requests.
* **Dig deeper**: Click on a specific request in the timeline to see the raw payload Kombo sent and the error response from the remote system. These often contain more specific details than the top-level error message.

<Frame>
  <img alt="Request log details" />
</Frame>

## 3. Common issues

We have a dedicated [Error Handling guide](/guides/errors) that covers how to handle common API errors programmatically. Below, you'll find visual examples of the most common issues specific to actions:

### Missing permissions or Invalid authentication

If you receive a `403 Forbidden` or `401 Unauthorized` error, the integration
likely lacks the necessary permissions or it's authentication is invalid. Below
are some examples of how these errors might look in the logs:

<AccordionGroup>
  <Accordion title="Missing Permissions Example">
    <Frame>
      <img alt="Missing permissions error" />
    </Frame>
  </Accordion>

  <Accordion title="Invalid Authentication Example">
    <Frame>
      <img alt="Invalid authentication error" />
    </Frame>
  </Accordion>
</AccordionGroup>

**Solution**: Identify the missing permission from the error message. Ask your
customer to check their settings or API key, as they might have revoked access
or changed their role. In some cases, they will need to [reconnect the
integration](../connect/reconnection) to grant the missing scopes.

### Invalid input

If the error is a `400 Bad Request`, `422 Unprocessable Entity`, or a validation
error, the remote tool rejected the data you sent. Below are some examples of
how these errors might look in the logs:

<AccordionGroup>
  <Accordion title="Invalid Input Example 1">
    <Frame>
      <img alt="Invalid input error 1" />
    </Frame>
  </Accordion>

  <Accordion title="Invalid Input Example 2">
    <Frame>
      <img alt="Invalid input error 2" />
    </Frame>
  </Accordion>
</AccordionGroup>

**Solution**:

1. Identify the incorrect or missing data in the `Incoming Request` tab.
2. Use [Komboman](../../features/komboman) to replay the action with adjusted inputs and verify the fix.
3. Check the integration's **Field Report** (in the dashboard) to see which fields are required by the remote tool.
4. If a connection always requires specific static inputs, you can set up Remote field overrides.

### Logical errors (e.g., Job closed)

Sometimes the request is valid, but the operation cannot be performed due to the state of the remote system (e.g., applying to a closed job or creating a duplicate candidate). Below are some examples of how these errors might look in the logs:

<AccordionGroup>
  <Accordion title="Logical Error Example 1">
    <Frame>
      <img alt="Logical error 1" />
    </Frame>
  </Accordion>

  <Accordion title="Logical Error Example 2">
    <Frame>
      <img alt="Logical error 2" />
    </Frame>
  </Accordion>

  <Accordion title="Logical Error Example 3">
    <Frame>
      <img alt="Logical error 3" />
    </Frame>
  </Accordion>
</AccordionGroup>

**Solution**: Check the state of the referenced records (e.g., is the `job_id` open?) before sending the action, or handle these specific error codes gracefully in your application.

### Temporary issues

If you see a `500` error or a timeout from the remote tool, it might be a temporary issue. Below is an example of how this error might look in the logs:

<AccordionGroup>
  <Accordion title="Temporary Issue Example">
    <Frame>
      <img alt="Temporary remote tool error" />
    </Frame>
  </Accordion>
</AccordionGroup>

**Solution**: Try resending the action directly from the log details view.

## 4. Still not sure?

If the error is unclear or you suspect a bug in Kombo:

1. Copy the URL of the failing log entry.
2. Reach out to [Kombo support](/support).
3. Paste the link so we can look at the exact same trace you are seeing.


# Environments
Source: https://docs.kombo.dev/hris/guides/environments



In Kombo, you will have access to two environments; a **production** environment (prod) and a **development** environment (dev). You can switch between these in the sidebar:

<Frame>
  <img />
</Frame>

## What differs per environment?

Only your tenant name ("Acme" in the case of the screenshot above) is shared
across environments. That means that all your other configurations, including
scopes, enabled tools, webhooks, custom fields, and secrets,
will be different per environment.

## Production

This is where you should create integrations with your customers. We are stricter
in this environment about default privacy settings and data retention.

### Saving the connection flow input in production

When connecting customers via your production environment, their connection flow
input is saved in [session storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage).
This is done so that while the same tab/window is open, your customer will not
have to enter the same data for the same input if they move back and forth
through the connection flow. When the tab/window is closed, the credentials
are forgotten. This differs from the development credential storage,
as described below.

## Development

The development environment is meant to be used with
your [sandbox environments](../getting-started/sandbox-integrations) during
development and testing. This environment is less strict about privacy settings
and data retention.

### Saving the connection flow input in development

In the development environment, the connection flow input is saved
in [local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage).
This is a quality-of-life feature meant for developers to prevent having
to enter the same inputs when creating multiple connections to the same
sandbox. Local storage will persist between browser sessions until it
is manually cleared.

### Kombo sandbox

You have access to our built-in **Kombo Sandbox** tool in the development
environment. You can create a new integration with this sandbox as you would
with any other integration, and instantly start reading data without having
to connect a HR system.

### Stale integrations

**In the development environment only**, integrations that did not receive an
API requests in the past two weeks will automatically
become [inactive](./integration-states#inactive). If you want to continue
using the integration, you can activate it again.

## Roles and Access Control

Kombo uses role-based access control so you can grant team members the right level of access. Roles are assigned per user in the dashboard.

| Role          | Environments             | Configuration          | API Keys               | User Management             |
| ------------- | ------------------------ | ---------------------- | ---------------------- | --------------------------- |
| **Admin**     | Production + Development | Full access            | Full access            | Can invite and manage users |
| **Developer** | Development only         | Full access (dev only) | Full access (dev only) | No access                   |
| **Operator**  | Production only          | Read + limited writes  | No access              | No access                   |

### Admin

Full access across both environments, including all configuration (scopes, webhooks, custom fields), API key management, and user administration.

### Developer

Full access to the Development environment only, including API keys and all configuration within that environment. Cannot access Production or manage users.

### Operator

Read access to the Production environment plus the ability to create integrations, reconnections, and provisioning links, edit integration settings, and map custom fields. Cannot manage API keys, scopes, audit logs, or users.

### SSO and MFA

Kombo's dashboard authentication supports **SSO** (SAML and OIDC) and **MFA** for users who want additional security. These are not available on all plans — contact the Kombo team to check availability and configure them for your tenant.


# Implementing New Tools
Source: https://docs.kombo.dev/hris/guides/implementing-new-tools

Learn about best practices when using a new tool.

To enable a new tool, navigate to the [tools page](https://app.kombo.dev/tools) in the Kombo dashboard and enable it.

Before enabling it, we highly recommend using Kombo's resources to learn more about the tool. The reason for this is that not all HR tools support the exact same feature set. We try to unify these differences as much as possible, but we also aim to provide the best possible resources to prevent any surprises when using a tool.

Below is a list of the resources Kombo provides, and a short explanation on why they could be useful.

## Coverage Grid

The coverage grid provides a high-level overview of which data point is supported across all of our integrations. Hovering over noteworthy data points will also offer explanations of their implementation.

You can access the [HRIS coverage grid](https://app.kombo.dev/coverage/hris) or the [ATS coverage grid](https://app.kombo.dev/coverage/ats) from your dashboard.

## Tools Page

Our [tools page](https://app.kombo.dev/tools) provides in-depth documentation on each tool. Click on a tool's name to view its content.

### Resources

Under the resources tab, you'll find links to the tool's specific resources and guides.

* **Preview Connection Flow:** An interactive overview of the connection flow. Here, you'll be able to see each step that your customer will take, allowing you to provide support if necessary.
* **Connection Guide:** A written guide meant for customers, where we provide screenshots and explanations for navigating the tool's user interface to generate credentials.
* ***Sandbox***: If the tool allows for free demo accounts, we will provide a link here.

**ATS-Specific**

* **How to View Sources**: A guide to show where your company's desired attribution will be displayed in the customer's system.
* ***How to Set Up a Source***: If a tool has a complicated process for setting up source attribution, we provide an additional guide to assist your customer in doing so here.

### Limitations

The limitations tab provides general and data-point-specific explanations of how Kombo unifies the tools' data and, in some cases, which limitations the tool comes with.

For example, when a tool's data model differs too much from the unified Kombo model, we would explain how the data is mapped to the Kombo model here.


# Integration States
Source: https://docs.kombo.dev/hris/guides/integration-states



## What is an Integration Status

After the connection flow has been completed, the integration will appear on
your [integrations page](https://app.kombo.dev/integrations).

Each integration has a status indicator informing you about the current
operational status.

<Note>
  ### API vs UI Integration States

  The [GET integration states](../v1/get-integrations-integration-id) endpoint returns a subset of the below-listed states, returning only those relating to the actual **sync status**.

  The [integrations page](https://app.kombo.dev/integrations) expands on these states for a more human-readable interface.
</Note>

## Possible Integration States

### Active

<Frame>
  <img />
</Frame>

The integration is running as expected, and data is being synced successfully.

### Sync Failing

<Frame>
  <img />
</Frame>

The last sync was not completed successfully. This can be the result of critical
errors, such as missing data, missing permissions, or the tool's API having downtime.

**Next steps:**

* Check the [logs](../features/logs) of the sync to read the error message.
* Reach out to Kombo for help with resolving an issue.

### Sync Has Warnings

<Frame>
  <img />
</Frame>

The last sync was successful with warnings. This can be the result of smaller
unexpected behavior, such as a specific field not being able to be fetched.

**Next steps:**

* Check the [logs](../features/logs) of the sync to read the warning message.
* Reach out to Kombo for help with resolving an issue.

### Quality Assurance

<Frame>
  <img />
</Frame>

If we detect any issues while performing the first sync, the integration status
will automatically be set to quality assurance mode. Our engineering team will
be notified, and we will contact you once we have resolved the issue and
re-enabled the integration.

### Authentication Failing

<Frame>
  <img />
</Frame>

The last sync failed because the credentials could no longer authenticate the
data transfer. This can be the result of expired credentials.

**Next steps:**

* [Reconnect the integration](./connect/reconnection#methods-of-reconnecting)

### Credentials Invalid

<Frame>
  <img />
</Frame>

The status is moved from **authentication failing** to **credentials invalid**
if every sync over the last 24 hours has failed due to authentication. The
integration will be automatically set to pause future syncs until new
credentials are provided.

**Next steps:**

* [Reconnect the integration](./connect/reconnection#methods-of-reconnecting)

### Setup

<Frame>
  <img />
</Frame>

An integration in the setup state has been successfully connected but no filters have been configured yet.

**Next steps:**

* [Create a provisioning link](/hris/v1/post-provisioning-groups-group-id-setup-links) to set up filters for the integration. You can also do this in the dashboard.

### Inactive

<Frame>
  <img />
</Frame>

An inactive integration will no longer automatically sync data. All credentials
and configuration are preserved — reactivating resumes syncing without
reconnection.

You can set an integration to active/inactive in two ways:

* **Dashboard:** Toggle in the settings page of the integration, as shown below.
* **API:** Use [Set integration enabled](../v1/put-integrations-integration-id-enabled) with `{ "value": false }` to pause or `{ "value": true }` to resume.

<Frame>
  <img />
</Frame>

In your [development environment](./environments#development), integrations will
be set to inactive if you did not send an API request to it over the past two
weeks. If desired, you can always reactivate it.

**Next steps:**

* Reactivate the integration in the dashboard or via the API.

### Deleted

<Frame>
  <img />
</Frame>

You previously deleted the integration. You can read more about our deletion policy [here](../features/deletion-policy).


# Partner Credentials
Source: https://docs.kombo.dev/hris/guides/partner-credentials

Learn how existing partnerships to integrated systems can be used with Kombo.

## Overview

When you are already a partner with some of the tools that we are integrating,
Kombo allows you to bring your own credentials and settings to get the most out of
the partnership.

Partner credentials and options can, for example, be the OAuth master-level credentials
that are used to issue access tokens and initialize OAuth flows. That will allow
you to show your logo and name in the OAuth flow instead of Kombo's.

For most integrations, Kombo provides a set of default credentials and settings
so that you don't need to get a partnership with every tool you want to integrate.
However, if you have your own partnership, you can configure custom partner credentials
that work in a revision system, allowing you to manage multiple credential sets and
safely update them without breaking existing integrations.

## Understanding Credential Revisions

Partner credentials work in a revision system. Each time you create or update
credentials, a new revision is created with a label you can assign (e.g.,
"Production credentials" or "Staging credentials").

### How Revisions Work

The revision system ensures that credential changes are safe and non-destructive:

* **New integrations**: When you create a new integration, it automatically uses
  the latest revision (the most recently created one).
* **Reconnecting integrations**: When you reconnect an existing integration, it
  automatically upgrades to use the latest revision.
* **Existing integrations**: Existing integrations continue using their assigned
  revision and are **not automatically migrated** when you create a new
  revision. This ensures that creating new credentials doesn't break existing
  integrations.

## Managing Credentials and Revisions

You can manage partner credentials and revisions on the [tool settings page](https://app.kombo.dev/tools)
for all tools that support this feature.

<Frame>
  <img alt="image" />
</Frame>

The new revision will become the latest revision, and all new integrations will
automatically use it.

Each integration's details page shows which revision it's currently using,
including whether it's using customer-submitted credentials or Kombo default
credentials.

## Best Practices

Always test new credential revisions in your development environment before
using them in production. This helps you catch common issues like:

* Mismatched redirect URLs
* Insufficient OAuth scopes
* Incorrect API endpoints or base URLs
* Invalid authentication tokens

### Upgrading Existing Integrations

To upgrade an existing integration to a new revision, you must reconnect it
using the [reconnection flow](./connect/reconnection). This ensures
that the integration is properly tested with the new credentials before they're
applied.

The reconnection flow allows your customer to re-authenticate with the updated
credentials, ensuring a smooth transition without breaking the integration.

### Getting Help

We are always improving the support for custom partner credentials. If you are
missing this feature for a tool, or if you encounter any issues while setting
up credentials, please reach out to us.


# SFTP self-serve setup
Source: https://docs.kombo.dev/hris/guides/sftp-self-serve

Configure SFTP integrations using Kombo's self-serve mapping tools.

## Overview

Kombo supports SFTP integrations where your customers can send data to our servers in any format, which we then normalize into our unified model.
Because we accept any file structure as provided by the customer's system, each integration requires its own mapping configuration.

When the first file for an SFTP integration is received, the initial sync will fail because no mappings are set up yet — this is expected.
Our support team is automatically notified and will create the necessary mappings.
Alternatively, you can configure or adjust the mappings yourself using self-serve mapping.

<Warning>
  **Self-serve mapping is only available for SFTP connections that deliver a
  single export file per sync.** If your customer's system exports multiple
  files (e.g., separate files for employees, absences, and time off balances),
  you will need to contact our support team to set up custom mappings.
</Warning>

## Self-serve SFTP mappings

### 1. Inspect the uploaded files

You can view the uploaded files in the Kombo dashboard to review their structure and verify data completeness. Confirm that the exported data meets your expectations before proceeding. This requires admin permissions.

<img alt="image" />

### 2. Select a file parser

Kombo will automatically try to detect the file format. Supported formats are JSON, Excel (XLSX), and CSV. Verify the detected parser or manually select the correct one. Validate that the parsing works correctly by checking the number of rows parsed.

<img alt="image" />

### 3. Choose the employee ID column

Select the column containing a unique and stable identifier for each employee. This identifier must remain consistent across all future uploads to reliably sync and deduplicate employee records.

<img alt="image" />

### 4. Map fields with remapping

Once the ID above is picked, you can run a sync and use our [remapping feature](/hris/features/remapping/introduction) to map all required fields. Once you have mapped the fields, trigger another sync and check that the data is what you expect in the [data explorer](/hris/features/data-explorer)

### 5. Approve the connection

Sync attempts will intentionally fail until the mappings are fully configured to prevent incomplete or incorrect data from syncing into your system. Once you're satisfied with the configuration and have verified the data in the Data Explorer, approve the connection. This approval allows successful syncs to proceed.

## Adjusting mappings

If your customer's export format changes later, you can easily update and adjust the mappings directly within the dashboard at any time.


# Static IPs
Source: https://docs.kombo.dev/hris/guides/static-ips

Route all Kombo API calls through a fixed set of IP addresses so your customers can allowlist them.

## Use Case

Some systems are locked down to only accept inbound requests from a pre-approved set of IP addresses. Without Static IPs, Kombo's API calls to these systems would be rejected because our traffic originates from a dynamic address range.

Enabling Static IPs routes all outgoing API calls for a given integration through a fixed pool of addresses that you can share with your customer's system administrator to allowlist.

## Enabling Static IPs

Static IPs are configured per integration link at the time you create the connection link.

1. In the [Kombo dashboard](https://app.kombo.dev/integrations), click **New integration**.
2. Fill in the required fields and expand **Advanced settings**.
3. Toggle **Static IPs** on.
4. The dialog will display the IP addresses assigned to this integration. Copy them — you'll need to share them in the next step.
5. Click **Continue** and send the link to your customer as usual.

<Frame>
  <img
    alt="Static IPs toggle in the New Integration
dialog"
  />
</Frame>

## Sharing the IPs

Once you have enabled Static IPs, share the displayed IP addresses with the administrator of the connected system and ask them to add the addresses to their allowlist. Kombo's API calls will be rejected by the system until the allowlist is in place.

The exact steps to add IPs to an allowlist depend on the connected system. Refer to your customer's system documentation or share our [connection guides](https://help.kombo.dev) for step-by-step instructions.

## Existing Integrations

If you need to enable Static IPs for an integration that has already been set up, open the integration in the [Kombo dashboard](https://app.kombo.dev/integrations), go to its settings page, and toggle **Static IPs** on. The IPs to allowlist will appear immediately below the toggle.

<Frame>
  <img
    alt="Static IPs section on the Integration Settings
page"
  />
</Frame>


# How Kombo Syncs Data
Source: https://docs.kombo.dev/hris/guides/sync

Understanding how Kombo keeps integration data up-to-date internally without sacrificing API reliability and performance.

# Syncs in Kombo

We're mirroring the data in the source systems into a database at regular
intervals (or when you [manually trigger a sync](../v1/post-force-sync)). When you
call our API, we will simply read from our database, resulting in endpoints that
always respond reliably and quickly.

Through our syncing approach, we can also provide [webhooks](./webhooks) for
systems that don't provide webhooks themselves.

<Info>
  This page explains how Kombo syncs data internally. If you're looking for how
  to fetch data from Kombo into your system, see our [Fetching Data
  guide](../getting-started/fetching-data).
</Info>

<Note>
  Note that syncs adhere to [your scope config](../features/scopes), so if there
  are sensitive data points you're not using, then those will **not** end up in
  our database.
</Note>

## Full Syncs vs. Delta Syncs

Kombo uses two different sync strategies to keep your data up-to-date. Each
serves a different purpose and has different trade-offs regarding speed,
completeness, and frequency.

### Full Syncs

A full sync **re-fetches all data** from the connected system. It pulls every
record (employees, candidates, jobs, etc.) regardless of whether it changed
since the last sync.

**Key characteristics:**

* Fetches the **complete dataset** from the remote system
* **Detects deletions**: records that existed before but are no longer returned
  by the source system are marked as deleted in Kombo
* **Reconciles data quality issues**: because everything is re-fetched, full
  syncs can correct inconsistencies that may have been missed by delta syncs or
  webhooks
* **Picks up configuration changes**: if you update your
  [scope config](../features/scopes) to include new fields, a full sync is needed to
  backfill those fields across all existing records
* Runs at a **lower frequency** than delta syncs
* Takes **longer to complete** since it processes all records

Full syncs are essential because they are the only sync type that can reliably
detect deletions and ensure the complete dataset is consistent.

### Delta Syncs

A delta sync **fetches only data that changed** since the last sync. It uses
upstream filters (like `updated_after` timestamps) to request only new or
modified records from the source system.

**Key characteristics:**

* Fetches only **new and modified records**, making it significantly faster
* **Cannot detect deletions**: since it only asks for changes, it has no way of
  knowing which records were removed
* Runs at a **higher frequency** than full syncs
* **Not available for all integrations**: delta syncing depends on the source
  system's API supporting change-based filtering

### How They Work Together

When an integration supports delta syncs, Kombo runs both types on
complementary schedules:

| Sync type  | Frequency | What it fetches      | Detects deletions |
| ---------- | --------- | -------------------- | ----------------- |
| Full sync  | Lower     | All records          | Yes               |
| Delta sync | Higher    | Only changed records | No                |

For integrations that **don't** support delta syncs, Kombo runs full syncs at a
higher frequency to compensate for the lack of incremental updates.

The exact sync frequency depends on your plan and can be customized on higher
tiers.

<Info>
  Some integrations also support **upstream webhooks**, which provide near
  real-time updates for individual record changes. When webhooks are active, the
  polling sync frequency may be reduced since webhooks already keep the data
  fresh. Learn more about [upstream webhooks](./upstream-webhooks).
</Info>

## Sync Units

For some integrations, Kombo splits a sync into smaller, independent **sync
units**. Instead of syncing all data types together, each unit syncs a focused
part of the dataset (for example, one model or a group of related models) and
completes on its own. This is currently being rolled out for a subset of tools
and environments, and doesn't change how you read data from our API.

Because units run independently, a few behaviors are scoped to the unit rather
than the sync as a whole:

* **Deletion tracking is per unit**: after a unit finishes its full sync, only
  the records belonging to that unit are considered for deletion tracking.
  Records from other units are unaffected until their own unit completes.
* **Webhooks are sent per unit**: "Data changed" [webhooks](./webhooks#data-changed)
  fire as each unit processes its data, so you receive updates progressively
  rather than all at once at the end of a full sync.
* **Endpoints unlock as units finish**: for newly connected integrations, an
  endpoint becomes available as soon as the unit responsible for its data
  completes, rather than waiting for the entire initial sync to finish.

## Sync Scheduling

Kombo uses a frequency-based scheduling system that automatically determines
when syncs should run for each integration.

### How Scheduling Works

The scheduling system works by tracking the **last sync time** and adding the
**configured frequency** to determine when the next sync is due.

For example, if a full sync completed at 2:00 PM and the configured frequency is
10 hours, the next sync will be due at 12:00 AM (midnight).

### Sync Frequencies

Different sync types run at different frequencies:

* **Full syncs** run less often when delta syncs are available, and more often
  when they are not
* **Delta syncs** run more frequently than full syncs

The exact frequency depends on your plan and can be customized on higher tiers.

When you manually trigger a sync, it **moves the schedule forward**:

**Example**: Say automatic full syncs are scheduled every 10 hours:

* Last sync: 10:00 AM → Next due: 8:00 PM
* Manual sync at 2:00 PM → Next due: 12:00 AM (midnight) (not 8:00 PM)

The schedule resets from the time of the manual sync, rather than keeping the
original schedule.

## Real-time Data Updates

In addition to full and delta syncs, we are also able to receive webhooks from
selected tools to keep our data in sync more efficiently. Read more about it
[here](./upstream-webhooks).

## Data Normalization

When syncing data from connected systems, Kombo normalizes records into the
unified model. Here's how different data scenarios are handled:

### Missing and Unsupported Fields

If a field is not available in the source system or the integration doesn't
support it, Kombo sets it to `null`. Records are **never dropped** due to
missing fields — you'll always receive the full record with `null` for any
unavailable properties.

This means you should design your system to handle `null` values gracefully,
since different source systems expose different sets of fields.

### Enum Normalization

For categorical fields like `gender`, `employment_type`, or
`employment_status`, Kombo maintains extensive mapping tables that translate
hundreds of system-specific values into unified enum values. For example,
"Vollzeit" or "CDI" from a German or French system both map to `FULL_TIME`.

If a value from the source system cannot be mapped to a known enum value, Kombo
**passes through the original string** rather than discarding it. This means you
may occasionally see raw values from the source system alongside standardized
ones for less common integrations. See the documentation of the specific
endpoint and enum for more information. Some enums don't pass unknown values through.

You can use [remapping](../features/remapping/introduction) to customize how specific
values are mapped if the defaults don't fit your needs.

### Scope-Based Filtering

Fields that are not included in [your scope config](../features/scopes) are set to `null`
during sync. This ensures that sensitive data points you're not using never
enter the Kombo database, even if the source system provides them.

## How Syncs Write Data to the Database

Understanding how Kombo syncs write data to the database is crucial for
understanding data availability and timing behavior.

### Non-Atomic Data Streaming

**Syncs are not atomic operations**. Instead of waiting to commit all data at
the end of a sync, Kombo streams data directly into the database as it's
processed during the sync. This means:

* **Data becomes available immediately**: Updated records appear in API
  responses as soon as they're processed, even while the sync is still running
* **Partial sync results**: If you query the API with `updated_after` during an
  ongoing sync, you'll receive records that have already been processed
* **No "commit phase"**: There's no single point where all sync data becomes
  available at once

### Change Tracking with `changed_at`

Each record in Kombo's database has a `changed_at` timestamp that tracks when
the record was last modified. This field is automatically updated by database
triggers when any tracked field changes:

* **Immediate updates**: `changed_at` is set as soon as a record is upserted
  during sync
* **API filtering**: The `updated_after` parameter in API requests filters based
  on this `changed_at` timestamp
* **Real-time availability**: Records with updated `changed_at` timestamps
  become immediately visible in API responses that use `updated_after` filtering

### Sync Lifecycle and Database Operations

During a sync, Kombo performs these database operations:

1. **Upsert operations**: Each record is upserted (created or updated)
   immediately when processed. If there were changes, the `changed_at` timestamp
   is updated.
2. **Deletion tracking**: For full syncs, records not seen during the sync are
   marked with `remote_deleted_at` after the sync completes successfully.
3. **Reference validation**: Ensures data integrity by validating relationships
   between records.

### Implications for API Consumers

* **Progressive data updates**: You can start receiving updated data before the
  sync completes
* **Timestamp-based filtering works reliably**: Using `updated_after` will
  correctly capture changes made during ongoing syncs
* **No need to wait**: There's no need to wait for sync completion to access
  newly updated data
* **Consistent behavior**: This works the same way for all sync types (full,
  delta, and default syncs)


# Upstream webhooks
Source: https://docs.kombo.dev/hris/guides/upstream-webhooks

Kombo can subscribe to webhooks of the systems that your customers connect. We call this feature upstream webhooks. This document explains how they work and how you can leverage them.

<Note>
  Please be aware that this page covers upstream webhooks. These are webhooks
  that Kombo receives from the connected ATS/HRIS such as Personio or Recruitee.
  If you try to understand webhooks that Kombo sends to your system for new
  integrations or finished syncs, check out [this page](./webhooks).
</Note>

## Concept

Kombo subscribes to webhooks of the systems that your customers connect.
We call this feature upstream webhooks. The goal of this system is to enable you
to receive data in real-time without waiting for a normal sync to complete. Please
note that this is not available for all integrations and depending on the granted
permissions, this might require a re-connect for existing integrations.

When upstream webhooks are successfully enabled and you're subscribed to the data-changed webhook,
Kombo automatically reduces the sync frequency from 3 hours to 24 hours since most updates
are delivered in real-time.

## Availability

Upstream webhooks are available for a limited set of integrations as not all
integrations support them yet. We are actively working on implementing this
feature for more integrations.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/hris/connectors/personio">Personio</a></li>
    <li><img /><a href="/hris/connectors/okta">Okta</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

## Setup

Whether additional setup is required depends on the connected tool. For many
tools, we are able to subscribe to webhooks automatically through the tool's
API. However, some require a one-time manual configuration by the end-customer
via the integration's Setup Flow. Until this step is completed, real-time
updates will not be available, and changes will arrive after the next scheduled
sync instead.

All configured webhook subscriptions (automatic and manual) are shown in an
integration's settings in the Kombo dashboard and can be managed from there.

## End-Customer Experience

For most integrations, the end-customer only needs to grant a permission to the
credentials to allow us to subscribe to webhooks.

<Frame>
  <img />
</Frame>

Kombo will also diligently only subscribe to webhook event types that are compliant
with the scope config. For example, if you disable candidates and only care about jobs, we
will not subscribe to any candidate events.

## Implementation Guide

By using our [Data changed webhook](./webhooks#data-changed), you will automatically receive updates
about changes we receive from upstream webhooks. That is in addition to any
changes from syncs or other sources. Learn more about how to fetch from Kombo in
our [Fetching Data](../getting-started/fetching-data) guide.

Set up the downstream event in the [webhook config](https://app.kombo.dev/configuration/webhooks) in the Kombo dashboard.

```mermaid theme={null}
sequenceDiagram
    participant ATS as End customer's ATS/HRIS
    participant Kombo as Kombo
    participant Customer as Kombo Customer

    ATS->>Kombo: Send upstream webhook event
    Kombo->>Kombo: Verify event

    Kombo-->>ATS: GET related data
    Kombo->>Kombo: Update Kombo DB


    Kombo->>Customer: Send downstream "data-changed"
    Customer->>Customer: Verify event
    Customer->>Kombo: GET changes via Kombo API
```

You can usually expect to receive events from the connected system within 10-20 seconds.
Most systems take a few seconds before they send the webhook to Kombo.

Kombo will retry the request to your system for up to 5 times with exponential
backoff.

## Troubleshooting

Check out the logs in the Kombo dashboard to see every webhook event that we receive.
The downstream request will also be logged there with any warnings or errors that
we encountered while processing or forwarding the event.

<Frame>
  <img />
</Frame>


# Webhooks
Source: https://docs.kombo.dev/hris/guides/webhooks

Kombo sends you webhooks so that you don't have to poll our API for changes.

<Note>
  Please be aware that this page covers downstream webhooks. These are webhooks
  that Kombo sends to your system for events like new integrations or finished
  syncs. If you try to understand webhooks that Kombo receives from the
  connected ATS/HRIS such as Personio or Recruitee, check out [this
  page](./upstream-webhooks).
</Note>

## Enable Webhooks

You can configure your Kombo webhooks in the dashboard directly in the
[webhooks tab](https://app.kombo.dev/configuration/webhooks). After creating the first
webhook, a random webhook secret will be generated and shown. You can learn
how to use it in [Validate the data](#validate-the-data).

<Frame>
  <img alt="1412" />
</Frame>

## Available webhooks

### Data changed

We send a `data-changed` webhook every time data changes in Kombo. This includes
changes from regular syncs as well as updates from upstream webhooks.
Read more about fetching data [here](../getting-started/fetching-data).

<Note>
  We trigger this webhook, when we receive a change. To speed up delivery of
  changes to Kombo, ensure that upstream webhooks are enabled for the
  integration. If upstream webhooks are not enabled or not supported,
  notifications are sent after the next scheduled sync (latency equals the sync
  frequency).
</Note>

You can use this webhook to keep your database up to date by fetching only
the updated data using the `updated_after` filter.

This webhook is useful to fetch data from Kombo into your system. Read more
[here](../getting-started/fetching-data).

We will only ever send you a `data-changed` webhook if there are changes to the data.

```json data-changed theme={null}
{
  "id": "FhghqjnCi9WuAoLT8Z75CFcs",
  "type": "data-changed",
  "data": {
    "integration_id": "bombohr:ats-dev",
    "integration_tool": "bombohr",
    "integration_category": "ATS",
    "changed_models": [
      {
        "name": "ats_applications"
      }
    ]
  }
}
```

We are debouncing `data-changed` with a 30-second window by default. This means
that you will at most receive one `data-changed` webhook every 30 seconds.

When the webhook is triggered for the first time, we send it out immediately.
After that, we will wait 30 seconds, during which we will collect all events and
send them as a single webhook, thereby starting another 30-second cooldown
window. We do not wait for syncs to finish before sending out the webhook;
instead, we may send you multiple webhooks during a single sync to ensure you
receive changes as soon as possible.

### Sync finished

<Warning>
  The `sync-finished` webhook is deprecated and replaced by the [data-changed
  webhook](#data-changed). It is still available for existing setups, but should
  not be implemented in new setups. Use `data-changed` instead for [fetching
  data updates](../getting-started/fetching-data).
</Warning>

The `sync-finished` webhook is sent every time a sync finishes, regardless of
the sync state. Possible values for `sync_state` are:

* `SUCCEEDED` The sync finished successfully.
* `PARTIALLY_FAILED` The sync succeeded but had non-fatal errors. Kombo will
  take care of it.
* `FAILED` There was a critical error during the sync and the sync did not
  finish. If this happens, we get an alert and will look into the issue to fix
  it ASAP.
* `TIMED_OUT` The sync timed out before completion. This happens rarely and will
  cause an immediate and automatic restart of the sync. Kombo will be notified
  and look into the issue ASAP.
* `CANCELLED` The sync was actively canceled by Kombo. This happens very rarely,
  has no negative side-effects, and if it does happen, we will schedule a new
  sync shortly after.
* `AUTHENTICATION_FAILED` The authentication of the connection is incorrect.
  Please check the Kombo dashboard for further steps.

This webhook is useful for informing customers about when the last sync ran or if
user intervention is required due to authentication issues. This should **not** be
used to trigger data refreshes. Use the [data-changed webhook](#data-changed) for that.

<Note>
  The `sync_started_at` field represents when Kombo started syncing data from
  the connected system, not when you should start fetching from Kombo. Do not
  use this field as your `updated_after` parameter when fetching data.
  Otherwise, you might risk missing data that was created/updated via webhooks
  before the sync started.
</Note>

```json sync-finished theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "sync-finished",
  "data": {
    "sync_id": "B89SCXXho7Yw8PGo8AKJxLn4",
    "sync_state": "SUCCEEDED",
    "sync_started_at": "2021-09-01T12:00:00.000Z",
    "sync_ended_at": "2021-09-01T12:30:00.000Z",
    "sync_duration_seconds": 1800,
    "integration_id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
    "integration_tool": "personio",
    "integration_category": "HRIS",
    "end_user": {
      "origin_id": "36123",
      "creator_email": "user@example.com",
      "organization_name": "Acme, Inc."
    },
    "log_url": "https://app.kombo.dev/env/production/logs/C3xUo6XAsB2sbKC7M1gyXaRX"
  }
}
```

### Integration created

The `integration-created` webhook is sent for every integration that is created.
Please react to this webhook event by adding the integration to your database
or by performing any other business logic that is required when an integration is
created.

```json integration-created theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "integration-created",
  "data": {
    "id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
    "tool": "personio",
    "category": "HRIS",
    "end_user": {
      "origin_id": "36123",
      "creator_email": "user@example.com",
      "organization_name": "Acme, Inc."
    }
  }
}
```

### Integration deleted

The `integration-deleted` webhook is sent when an integration is deleted.
Please react to this webhook event by removing the integration from your database
or by performing any other business logic that is required when an integration is
deleted.

```json integration-deleted theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "integration-deleted",
  "data": {
    "id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
    "tool": "personio",
    "category": "HRIS",
    "end_user": {
      "origin_id": "36123",
      "creator_email": "user@example.com",
      "organization_name": "Acme, Inc."
    },
    "deleted_at": "2022-11-02T10:50:10.242Z"
  }
}
```

### Connection flow failed

The `connection-flow-failed` webhook is sent whenever an error occurs during the
connection flow. These errors could, for example, originate from a user entering
incorrect credentials or from a mismatch between the required and supplied API
permissions.

This is not an alert-type webhook, but should instead be used to collect data
and get insights into user behavior. **The connection flow can still be
successfully completed after this webhook is sent.**

You can check whether the connection flow ended successfully by following the
link under `log_url`. Additionally, the log will display the exact errors your
customer ran into, which you can use to provide support if needed.

```json connection-flow-failed theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "connection-flow-failed",
  "data": {
    "integration_tool": "personio",
    "integration_category": "HRIS",
    "end_user": {
      "origin_id": "36123",
      "creator_email": "user@example.com",
      "organization_name": "Acme, Inc."
    },
    "log_url": "https://app.kombo.dev/env/production/logs/C3xUo6XAsB2sbKC7M1gyXaRX"
  }
}
```

### Assessment order received

The `assessment:order-received` webhook is sent every time an assessment is
ordered for a candidate from within an end-customer's tool.

```json assessment:order-received theme={null}
{
  "id": "Cbfk5sHtDxrSrJBRjsDtbaN9",
  "type": "assessment:order-received",
  "data": {
    "id": "B5KQKhAgTv6ZwzrfAbqbhipd",
    "integration_id": "workday:CBNMt7dSNCzBdnRTx87dev4E",
    "package_id": "typescript_test",
    "status": "OPEN",
    "candidate": {
      "remote_id": "12345",
      "email": "john.doe@gmail.com",
      "first_name": "John",
      "last_name": "Doe",
      "phone": "+1 123 456 7890"
    },
    "application": {
      "remote_id": "54321"
    },
    "job": {
      "remote_id": "67890",
      "name": "Engineering Manager",
      "location": {
        "city": "Berlin",
        "country": "DE",
        "raw": "Berlin, Germany",
        "state": "Berlin",
        "street_1": "Lohmühlenstraße 65",
        "street_2": null,
        "zip_code": "12435"
      },
      "hiring_team": [
        {
          "first_name": "Jane",
          "last_name": "Doe",
          "remote_id": "78901",
          "email": "jane.doe@gmail.com",
          "hiring_team_roles": ["RECRUITER"]
        }
      ]
    }
  }
}
```

### Integration state changed

The `integration-state-changed` webhook is sent when the status of the
integration changes. Use this to detect stale credentials and to reconnect your
customer.

Possible values for the `"state"` key include:

* `ACTIVE` The integration is active and working.
* `INVALID` The connection [requires reconnection](./connect/reconnection) in order to work again.
* `INACTIVE` The integration has been paused, either via the [dashboard or API](./integration-states#inactive). No syncs will run until it is re-enabled.

The payload also includes `qa_status` (`PENDING`, `PASSED`, or `FAILED`) and `setup_status` (`INCOMPLETE`, `FINAL_SYNC_PENDING`, or `COMPLETED`). Together these tell you whether the integration is fully ready to serve data — see [integration states](./integration-states) for details.

```json integration-state-changed theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "integration-state-changed",
  "data": {
    "integration_tool": "personio",
    "integration_category": "HRIS",
    "integration_id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
    "end_user": {
      "origin_id": "36123",
      "creator_email": "user@example.com",
      "organization_name": "Acme, Inc."
    },
    "state": "ACTIVE",
    "qa_status": "PASSED",
    "setup_status": "COMPLETED"
    "updated_at": "2021-09-01T12:00:00.000Z"
  }
}
```

### Issue status changed

The `issue-status-changed` webhook is sent when Kombo [raises or resolves an issue](../features/issues). Subscribe once; every customer-visible issue type uses this webhook. See [issue types](../features/issue-types) for the current list. We will add more types over time, so your handler should treat `issue.type` as an open set and not fail on unknown values.

`change` is `raised` when the issue first appears or comes back after being resolved, and `resolved` when the condition clears. This webhook is only sent when the issue is raised or resolved. Snoozing only hides the issue in the Kombo dashboard, so snoozing, a snooze expiring, or updates to the message or other fields do not trigger it.

```json issue-status-changed theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "issue-status-changed",
  "data": {
    "change": "raised",
    "issue": {
      "id": "8f3a1c2e4b5d6a7c8e9f0a1b",
      "type": "integration.authentication_failed",
      "title": "Authentication failed",
      "status": "OPEN",
      "markdown_message": "**Acme, Inc.**'s personio HRIS integration failed authentication. This is often invalid, expired, or revoked credentials, but it can also be temporary provider downtime.\n\nCheck the [logs](https://app.kombo.dev/env/production/integrations/personio:CBNMt7dSNCzBdnRTx87dev4E/logs) first. If the credentials look invalid, create a reconnection link from the [integration page](https://app.kombo.dev/env/production/integrations/personio:CBNMt7dSNCzBdnRTx87dev4E) so the customer can reconnect.",
      "first_observed_at": "2021-09-01T12:00:00.000Z",
      "resolved_at": null
    },
    "integration": {
      "id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
      "tool": "personio",
      "category": "HRIS",
      "end_user": {
        "origin_id": "36123",
        "creator_email": "user@example.com",
        "organization_name": "Acme, Inc."
      }
    }
  }
}
```

## Validate the data

Anyone could post data to your webhook URL. That's why we're signing each
request with a secret specific to your Kombo account. This secret is called the
**Kombo Webhook Secret** and you can find it [on the Kombo
dashboard](https://app.kombo.dev/configuration/webhooks).

Each valid webhook `POST` request from us will include the `X-Kombo-Signature`
header. To validate it, carefully follow these steps:

1. Decode the `X-Kombo-Signature` header from [`base64url`
   encoding](https://base64.guru/standards/base64url) (without padding) to raw
   bytes.
2. Compute the HMAC-SHA256 over the **raw** JSON request body (Kombo encodes
   this using two-space indentation) with your **Kombo Webhook Secret** as raw
   bytes.
3. Compare the decoded signature bytes to the computed HMAC bytes using a
   constant-time comparison function (like [Node.js's
   `timingSafeEqual`](https://nodejs.org/docs/latest-v22.x/api/crypto.html#cryptotimingsafeequala-b))
   to protect against timing attacks.

<Warning>
  If you're stuck trying to get the signatures to match, please verify that:

  1. You're using the Webhook Secret of the **correct Kombo environment** (e.g.,
     production or development).
  2. You're using the **raw JSON request body**. If your framework already parses
     the JSON body for you, make sure to re-encode it with two-space indentation
     (e.g., `JSON.stringify(body, null, 2)` in JavaScript).
  3. You're decoding the signature header from `base64url` (not standard `base64`)
     and comparing raw bytes (not re-encoding the computed HMAC for string
     comparison).
</Warning>

Here are some examples of how you could achieve this in a few different languages:

<CodeGroup>
  ```ts TypeScript theme={null}
  import { createHmac, timingSafeEqual } from 'node:crypto'

  const signatureHeader = req.headers['x-kombo-signature']

  // Get the raw UTF-8-encoded string body because this was used for signing
  const body = request.body

  // Or if you use a framework that parses the body for you, you can use this.
  // Note: This is not the same as JSON.stringify(request.body)
  const body = JSON.stringify(request.body, null, 2)

  const expected = createHmac('sha256', KOMBO_WEBHOOK_SECRET)
  .update(body, 'utf8')
  .digest()

  // Decode and compare in constant time
  const provided = Buffer.from(signatureHeader, 'base64url')
  const isValidRequest =
  provided.length === expected.length && timingSafeEqual(expected, provided)

  ```

  ```python Python theme={null}
  import base64
  import hmac
  import hashlib

  provided_signature = request.headers.get('X-Kombo-Signature')

  secret = KOMBO_WEBHOOK_SECRET.encode()
  expected = hmac.new(secret, request_body, hashlib.sha256).digest()

  # Decode the provided signature and compare in constant time
  try:
    provided = base64.urlsafe_b64decode(provided_signature + '==')
    is_valid_request = hmac.compare_digest(expected, provided)
  except Exception:
    is_valid_request = False

  return is_valid_request
  ```

  ```kotlin Kotlin theme={null}
  val providedSignature = request.getHeader("X-Kombo-Signature")
  // CharStreams is from com.google.guava:guava library
  val requestBodyAsString = request.reader.use { CharStreams.toString(it) }

  // Calculate the signature
  val algorithm = "HmacSHA256"
  val encoding = Charsets.UTF_8
  val secret = KOMBO_WEBHOOK_SECRET.toByteArray(encoding)
  val signingKey = SecretKeySpec(secret, algorithm)
  val mac = Mac.getInstance(algorithm)
  mac.init(signingKey)

  val expected = mac.doFinal(requestBodyAsString.toByteArray(encoding))

  // Decode and compare in constant time
  val isValidRequest = try {
      val provided = Base64.getUrlDecoder().decode(providedSignature)
      MessageDigest.isEqual(expected, provided)
  } catch (e: Exception) {
      false
  }

  return isValidRequest

  ```
</CodeGroup>

## Testing webhooks

The list of all created webhooks has two buttons on the right. One is for
deleting the webhook, the other is for sending a test request. This test request
will contain dummy data but will use the correct data schema.

Be careful when using this feature in production! It will send invalid data to
your webhook.

### Testing locally

For local development, you can use a service like [localtunnel](https://theboroer.github.io/localtunnel-www/)
or [ngrok](https://ngrok.com/). These tools allow you to expose a local port
through a public URL provided by them. The setup is very straightforward: Once
you've started a tunnel, simply add the provided URL as a webhook in the Kombo
dashboard. You can then send test requests to validate that your endpoint is
working properly.

## Retry behavior

If your webhook endpoint does not acknowledge the webhook (returns an error or
does not respond), Kombo will automatically retry the delivery. This ensures
reliable webhook delivery even when your endpoint is temporarily unavailable.

### Retry attempts

Kombo will retry failed webhook deliveries up to **5 times** before giving up.
Each retry uses exponential backoff with the following delays:

* After 1st failure: 1 second
* After 2nd failure: 2 seconds
* After 3rd failure: 4 seconds
* After 4th failure: 8 seconds
* After 5th failure: 16 seconds

### Error conditions that trigger retries

Kombo will retry webhook deliveries for the following error conditions:

* **Rate limit errors** (HTTP 429): Retries respect `Retry-After` headers when
  provided
* **Server errors** (HTTP 5xx): Temporary server errors that may resolve on retry
* **Connection errors**: Network timeouts, connection resets, DNS failures, and
  other transient network issues
* **Cloudflare errors** (HTTP 409 with Cloudflare 1018 error): Temporary
  Cloudflare blocking errors

### Error conditions that do not trigger retries

The following errors will **not** trigger retries, as they indicate permanent
failures:

* **Client errors** (HTTP 4xx, except 429): These typically indicate issues with
  the webhook configuration or request format
* **DNS not found** (ENOTFOUND): The webhook URL cannot be resolved

### Best practices

To ensure reliable webhook delivery:

1. **Respond quickly**: Return a 2xx status code as soon as you've received and
   validated the webhook, even if you process it asynchronously
2. **Handle idempotency**: Webhooks may be delivered multiple times due to
   retries, so ensure your webhook handler is idempotent
3. **Monitor webhook logs**: Check the Kombo dashboard for webhook delivery
   failures and retry attempts

## Automatic deactivation of webhooks

If we are unable to find your webhook endpoint for more than 7 days (HTTP status
code 404 or 410), we will automatically disable the webhook. You can always
re-enable it in the dashboard.


# Connection setup
Source: https://docs.kombo.dev/hris/implementation-guide/connection-setup



The first part of the implementation is the setup of the connection. Your customer needs to generate and share their API credentials so that we can make the necessary API calls for the integration.

<img alt="1376" />

There are [multiple ways of implementing this step](/hris/getting-started/create-integrations#ways-of-creating-integrations), but during your development and for the first customers we highly recommend just using the Magic Link feature that we provide. This guide will therefore assume that you are using the magic links for setting up the connection.

<Note>
  For your customer-facing implementation, we highly recommend embedding Kombo
  into your product for the best results.
</Note>

1. Generate a link for your customer. You only have to go into the [dashboard](https://app.kombo.dev/integrations) and:
   * Click on New integration

     <img alt="Click on new integration.png" />

   * Click on “Let your customer create the integration” (during development, you can also use the first option).

     <img alt="Click on let your customer create.png" />

   * Click on “Continue”.

     <img alt="Click on continue.png" />

   * Copy the link.

     <img alt="Copy link.png" />

2. Wait for your customer to generate and enter their API credentials. You can see the status of any sent-out connection link in the [Kombo dashboard](https://app.kombo.dev/pending-connections).

   <Note>
     🦉 Setting up the credentials for an integration can be tricky for your non-technical users. That’s why we highly recommend sharing our [step-by-step connection guides](https://help.kombo.dev/hc/en-us/sections/14349683218961-Connection-Guides) with them or guiding them through the process on a short call.
   </Note>

3. Receive the `integration-created` [webhook](/hris/guides/webhooks#integration-created). We send this webhook every time one of your customers creates a new integration.

   ```json theme={null}
   {
     "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
     "type": "integration-created",
     "data": {
       "id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
       "tool": "personio",
       "category": "HRIS",
       "end_user": {
         "origin_id": "36123",
         "creator_email": "user@example.com",
         "organization_name": "Acme, Inc."
       }
     }
   }
   ```

   The `end_user.origin_id` [is submitted by you](/hris/v1/post-connect-create-link#:~:text=HRIS%22%2C%0A%20%20%22integration_tool%22%3A%20%22personio%22%2C-,%22end_user_origin_id%22%3A%20%22123%22%2C,-%22language%22%3A%20%22en%22%0A%7D%27) when creating a connection link and should represent the ID of your customer in your database. You need to store this ID in your database so that you’ll know which HRIS system belongs to which customer. For example, if you have two customers with the IDs “42” and “43”, then your database could look as follows after the integrations have been created:

   | end\_user.origin\_id | kombo\_integration\_id                    |
   | -------------------- | ----------------------------------------- |
   | 42                   | `personio:8d1hpPsbjxUkoCoa1veLZGe5`       |
   | 43                   | `successfactors:B1hu5NGyhdjSq5X3hxEz4bAN` |

   <Note>
     ⚠️ **This ID is not for public display** and should only be accessible to your backend. The ID is not a secret as such but it’s one of two things needed alongside the API key. There is no way to list all integration IDs via the API key so even in the case of an accidental API key leak, the data would still be safe.
   </Note>

**Alerting for customer problems**

We will send you a `connection-flow-failed` [webhook](/hris/guides/webhooks#connection-flow-failed) every time a customer is running into an issue. You should set up some sort of alerting based on this webhook so that you can be fast to offer help to your customer, should they have an error when setting up an integration.

```json theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "connection-flow-failed",
  "data": {
    "integration_tool": "personio",
    "integration_category": "HRIS",
    "end_user": {
      "origin_id": "36123",
      "creator_email": "user@example.com",
      "organization_name": "Acme, Inc."
    },
    "log_url": "https://app.kombo.dev/env/production/logs/C3xUo6XAsB2sbKC7M1gyXaRX"
  }
}
```

**Handling deleted integrations**

It is of course also possible to delete integrations. This can be done in two ways:

* via the [“delete integration”-endpoint](/hris/v1/delete-integrations-integration-id). If you are calling this endpoint you should also take care of deleting the `kombo_integration_id` from your database.
* via the `integration-deleted` [webhook](/hris/guides/webhooks#integration-deleted). This will be sent to you if someone goes into the Kombo dashboard and deletes an integration manually. Also then you’ll have to remove the `kombo_integration_id` from your database.

  ```json theme={null}
  {
    "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
    "type": "integration-deleted",
    "data": {
      "id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
      "tool": "personio",
      "category": "HRIS",
      "end_user": {
        "origin_id": "36123",
        "creator_email": "user@example.com",
        "organization_name": "Acme, Inc."
      },
      "deleted_at": "2022-11-02T10:50:10.242Z"
    }
  }
  ```


# Context
Source: https://docs.kombo.dev/hris/implementation-guide/context



Kombo offers a unified API for HR solutions. We allow our customers to build a single integration to Kombo and instantly launch all the HRIS and Directory integrations in **[Kombo’s ever-growing portfolio](https://www.kombo.dev/categories/hris)** to their customers.

We do this by standardizing the data models exposed by the integrations we support and allowing you to interact with them using a set of clearly defined endpoints.

This way, reading employee data from an enterprise HRIS solution like **[SAP SuccessFactors](https://www.kombo.dev/integrations/successfactors)** will look the same as reading employees from a more SMB-focused tool like **[Personio](https://www.kombo.dev/integrations/personio)**. It’s the same set of data models and fields you can rely on.

This means that you can **implement the logic for your integration only one single time** and offer over 50 HRIS integrations to your customers (and add new ones) without adding one more line of code for a new tool.

The integration can be divided into these three steps, which we will cover in detail later on

<img alt="1376" />


# Creating Employees (v2)
Source: https://docs.kombo.dev/hris/implementation-guide/create-employee

Learn how to create employee records in connected HRIS via Kombo.

## Overview

Kombo's **Create Employee** feature streamlines onboarding by enabling ATS platforms to automatically create employee records in connected HRIS.

Rather than manually entering data, this integration dynamically identifies and retrieves each HRIS's specific requirements for creating employee records (the data schema), letting your platform easily send correctly formatted employee data directly from the ATS to the HRIS–creating new employee records.

### Benefits

* **Consistent data structure** across diverse/customized HR systems.
* **Automated field mapping** associates fields in ATS with fields in HRIS, reducing manual efforts and errors.
* **Consistent and Validated Data:** Ensures data is accurate, complete, and validated, reducing onboarding errors.

### High-level Workflow

To create an employee:

1. **Connect HRIS** – Ensure an HRIS connection is set up via [Kombo Connect](/hris/guides/connect/introduction).
2. **Fetch Schema** – Retrieve fields required by the connected HRIS to create an employee.
3. **Map Fields & Capture Data** – Pre-populate fields from your ATS data and capture any missing data in your UI.
4. **Submit Employee Data** – Push validated employee data to create employee record in connected HRIS.

<Accordion title="Flowcharts of Workflow">
  <Tabs>
    <Tab title="Create Employee">
      <Frame>
        <img alt="create-employee-form.png" />
      </Frame>
    </Tab>

    <Tab title="Create Employee with Mapping">
      <Frame>
        <img alt="create-employee-mapping.png" />
      </Frame>
    </Tab>
  </Tabs>
</Accordion>

### Relevant API endpoints

<CardGroup>
  <Card title="Get employee form" icon="align-left" href="/hris/v1/get-employees-form">
    Get the form definition that you can render on your frontend.
  </Card>

  <Card title="Create employee with form" icon="user-plus" href="/hris/v1/post-employees-form">
    Post the data that you collected from the form to create an employee.
  </Card>
</CardGroup>

## Implementation Steps

<Steps>
  <Step title="Fetching the Form Schema">
    <div>
      <div>
        **Endpoint:**

        `GET` [https://api.kombo.dev/v1/hris/employees/form](https://api.kombo.dev/v1/hris/employees/form)

        <br />

        **Response:**

        You'll receive a JSON schema describing required fields, data types, labels, validation rules, and unified keys. Below is more information on how this schema is built.

        **Note:**

        The schema fields you receive are different for every HRIS and often even by instance.  (e.g. `firstName`, `startDate`, `workLocation` in the example response)

        <Tip>
          **Hiring into a position or requisition?** Pass an optional
          `staffing_entity_id` query parameter to scope the form — whenever possible
          form fields will be pre-filtered to the values linked to the selected staffing entity.
          This includes Kombo unisversal fields like `department` or `location`, but also deeply
          tool specific fields like `payGroup` from UKG Pro.
          See the [staffing entities in create employee guide](/hris/implementation-guide/staffing-entities-in-create-employee)
          for the full workflow.
        </Tip>
      </div>

      <div>
        **Example Response Snippet:**

        ```tsx Example Response [expandable] theme={null}
        {
          "status": "success",
          "data": {
            "properties": {
              "firstName": {
                "label": "First Name",
                "required": true,
                "description": "Employee's first name",
                "unified_key": "first_name",
                "type": "text",
                "min_length": 1,
                "max_length": 100
              },
              "startDate": {
                "label": "Start Date",
                "required": true,
                "description": "Employee's start date",
                "unified_key": "start_date",
                "type": "date"
              },
              "workLocation": {
                "label": "Work Location",
                "required": false,
                "description": "Employee's work location",
                "unified_key": null,
                "type": "object",
                "properties": {
                  "site": {
                    "label": "Site",
                    "required": true,
                    "description": "Employee's site",
                    "unified_key": null,
                    "type": "single_select",
                    "options": {
                      "type": "inline",
                      "entries": [
                        {
                          "id": "FXrER44xubBqA9DLgZ3PFNNx",
                          "label": "Office",
                          "remote_id": "office_001"
                        },
                        {
                          "id": "2rv75UKT2XBoQXsUb9agiTUm",
                          "label": "Warehouse",
                          "remote_id": "warehouse_001"
                        }
                      ]
                    }
                  },
                  "keyNumbers": {
                    "label": "Key Numbers",
                    "required": false,
                    "description": "Employee's key numbers",
                    "unified_key": null,
                    "type": "array",
                    "item_type": {
                      "label": "Key Number",
                      "required": false,
                      "description": "The number of the keys which belong to the employee",
                      "unified_key": null,
                      "type": "number",
                      "min": 0,
                      "max": 99
                    },
                    "min_items": 2,
                    "max_items": 5
                  }
                }
              }
            }
          }
        }
        ```
      </div>
    </div>
  </Step>

  <Step title="Auto-fill Standard Fields via Unified Keys">
    <div>
      <div>
        To create an employee record, all fields required by the HRIS must be populated appropriately and submitted. Most HRIS will require some similar standard fields such as `first_name` and `last_name` – which can automatically be pre-populated if the data already exists within your ATS; for that, the `unified_key` property can be used, which is included on standard fields within the schema retrieved in the previous step.
      </div>

      <div>
        **Example:**

        * If an HRIS wants a property with the following key:

          ```
          { "FirstNameOfEmployee": "Jane" }
          ```

        * Kombo automatically maps this property to the `unified_key`:

          ```jsx theme={null}
          "FirstNameOfEmployee":{
             "label":"First Name",
             "required":true,
             "description":"The first name of the employee",
             "unified_key":"first_name",
             "type":"text",
             "min_length":null,
             "max_length":null
          }
          ```
      </div>
    </div>

    **Supported Unified Keys include:**

    ```tsx Unified Keys [expandable] theme={null}
      'first_name',
      'last_name',
      'date_of_birth',
      'gender',
      'home_address.city',
      'home_address.country',
      'home_address.state',
      'home_address.street_1',
      'home_address.street_2',
      'home_address.zip_code',
      'job_title',
      'legal_entity_id',
      'location_id',
      'mobile_phone_number',
      'home_phone_number',
      'nationality',
      'start_date',
      'work_email',
      'private_email',
      'yearly_salary',
    ```

    **Unified Values for Gender Mapping:**

    ```tsx Unified Values theme={null}
      'MALE',
      'FEMALE',
      'NON_BINARY',
      'NOT_SPECIFIED',
    ```

    **After fetching the schema:**

    * Automatically populate fields with unified keys (e.g. `first_name` or `start_date`) if the data is already available in your ATS.
  </Step>

  <Step title="Add Field Mapping (highly recommended, but optional)">
    <div>
      <div>
        To create an employee record, all fields required by the HRIS must be populated appropriately and submitted. Most HRIS will require some similar basic fields such as `first_name` and `last_name` – which can automatically be pre-populated if the data already exists within your ATS; for that, we use the `unified_key`.

        However, an individual employer might also have less common or custom fields that are required to create an employee record in their specific HRIS instance. For example, a travel-related company might have a field for `nationality` configured in their HRIS, which they require to create an employee record (this field would be included in the form schema retrieved in the previous step).
      </div>

      <div>
        ```json Required Field Example theme={null}
        "nationality": {
                        "label": "Nationality",
                        "required": true,
                        "description": "Nationality of the employee.",
                        "unified_key": null,
                        "type": "text",
                        "min_length": null,
                        "max_length": null
                    },
        ```
      </div>
    </div>

    In this example, if you already have data for a person's nationality stored within your ATS (e.g. because it was captured as part of a job application), then the ATS field with the nationality value can be mapped to the `nationality` field returned in the HRIS form schema.

    We recommend providing your users the option to manually map ATS fields to HRIS fields via an intuitive UI.

    <Accordion title="Guidance for UI Implementation">
      * **Automatically populate fields** such as `first_name` or `start_date` if already available in your ATS.
      * **Field Mapping UI:** For HRIS admins, provide an intermediate mapping step after the HRIS connection, that verifies and adjusts the correspondence between ATS data fields and the HRIS schema.
      * **Responsive Design:** Ensure the form displays correctly on both desktop and mobile devices.

      <Frame>
        <img alt="image.png" />
      </Frame>
    </Accordion>
  </Step>

  <Step title="Capturing Any Missing Data (highly recommended, but optional)">
    There might be situations in which an employer's HRIS might require specific fields to be populated, where you either:

    1. Do not have the specific data available within your ATS
    2. Require user input to decide on the correct value

    <Tabs>
      <Tab title="Example 1: Data Unavailable in ATS">
        <div>
          <div>
            For example, an employer might have a field for `dateOfBirth` configured in their HRIS, which they require to create an employee record (these fields would be included in the form schema retrieved in step 1).

            In the example of the `dateOfBirth` field, you might not have data stored within the ATS that you can map into this field. Therefore, you'd want to expose an input field to the user while creating the employee record, prompting the user to enter this missing information, required by the HRIS.
          </div>

          <div>
            ```json Example Field theme={null}
            "dateOfBirth": {
                            "label": "Date of Birth",
                            "required": true,
                            "description": "Date of birth of the employee.",
                            "unified_key": "date_of_birth",
                            "type": "date"
                        }
            ```

            <Frame>
              <img alt="image.png" />
            </Frame>
          </div>
        </div>
      </Tab>

      <Tab title="Example 2: User Input Required">
        <div>
          <div>
            For example, an employer might have a field for `department` configured in their HRIS, which they require to create an employee record.

            In the example of the department field, you might have the relevant department options stored within your ATS. But it might be necessary for the ATS user (e.g. an HR manager) to decide which specific department should apply to this employee. In this case, you could display an input field to the user, with dropdown options to choose the correct department.

            For `single_select` and `multi_select` fields, the options can be set as `referenced` rather than provided `inline`. This means that the selectable options won't be included directly in the form; instead, you'll need to query them separately from Kombo or your database.

            This method is commonly used for scenarios such as selecting supervisors (employees) or referencing departments. To support this, we provide you with a query link from the Kombo model, which you can use to retrieve and display relevant information—such as the department name—and return the corresponding ID as the selected value or values.
          </div>

          <div>
            ```json Example Field theme={null}
            "department": {
                            "label": "Department",
                            "required": true,
                            "description": "Department of the employee.",
                            "unified_key": null,
                            "type": "single_select",
                            "options": {
                                "type": "referenced",
                                "link": "https://api.kombo.dev/v1/hris/groups?types=DEPARTMENT"
                            }
                        }
            ```

            <Frame>
              <img alt="image.png" />
            </Frame>
          </div>
        </div>
      </Tab>
    </Tabs>

    <Accordion title="Guidance for UI Implementation">
      * **Dynamically generate fields to display:** Parse the schema to render appropriate inputs (e.g., text boxes, date pickers, dropdowns, checkboxes).
      * **Auto-populate fields when possible:** Pre-populate fields such as `first_name` or `start_date` if already available in your ATS. You can also consider not displaying pre-populated fields at all, for a simplified UI/UX.

      **More UX/UI Examples:**

      <Frame>
        <img alt="image.png" />
      </Frame>

      <Frame>
        <img alt="image.png" />
      </Frame>
    </Accordion>
  </Step>

  <Step title="Submitting Employee Data">
    <div>
      <div>
        **Endpoint:**

        `POST` [https://api.kombo.dev/v1/hris/employees/form](https://api.kombo.dev/v1/hris/employees/form)

        **Request:**

        Submit data matching the retrieved schema format to create an employee record.

        **How it works:**

        * **All required fields** from the schema retrieved in the GET call **must be included**
        * The POST payload mirrors the GET schema's nested structure.
        * Data is organized under the properties key.
        * For nested fields (like `workLocation` in the example request snippet), include the corresponding sub-objects or arrays.
      </div>

      <div>
        **Example Request Snippet:**

        ```json Example Result theme={null}
        {
           "properties":{
              "firstName":"UserFirst",
              "startDate":"2025-01-15",
              "workLocation":{
                 "site":"ad67886e26d",
                 "keyNumbers":[
                    2,
                    44,
                    5
                 ]
              }
           }
        }
        ```
      </div>
    </div>
  </Step>

  <Step title="Understanding the Response">
    After submitting employee data, you'll receive a response containing three fields:

    <div>
      <div>
        ```json Example Response theme={null}
        {
          "status": "success",
          "data": {
            "id": "26vafvWSRmbhNcxJYqjCzuJg",
            "remote_id": "12345",
            "prehire": {
              "remote_id": null
            }
          },
          "warnings": []
        }
        ```

        * **`id`** – The Kombo ID of the created employee record. This will be `null` if only a pre-hire was created.
        * **`remote_id`** – The raw ID from the remote HRIS system. This is only populated when `id` is set (i.e., when a full employee was created). For pre-hires, use the `prehire` object instead.
        * **`prehire`** – An object containing the temporary prehire information from the remote system. Includes a `remote_id` field with the prehire ID (or `null` if there is no pre-hire). This ID may change or become invalid when the prehire becomes a full employee. The `remote_id` is only populated when `id` is `null`.
      </div>
    </div>

    ### When is an Employee Upserted?

    The behavior of employee creation depends on the connected HRIS system and how it handles new employee records:

    <Tabs>
      <Tab title="Immediate Employee Creation">
        **Scenario:** The employee record is created immediately in the HRIS and synced to Kombo.

        In this case:

        * ✅ **`id`** contains the Kombo employee ID
        * ✅ **`remote_id`** contains the HRIS system's ID
        * ✅ **`prehire.remote_id`** is `null`
        * ✅ The employee appears immediately in subsequent sync results

        ```json Response Example theme={null}
        {
          "status": "success",
          "data": {
            "id": "26vafvWSRmbhNcxJYqjCzuJg",
            "remote_id": "emp_12345",
            "prehire": {
              "remote_id": null
            }
          }
        }
        ```

        **Use Case:** Most HRIS systems that create employees directly (e.g., Personio).
      </Tab>

      <Tab title="Pre-hire Creation">
        **Scenario:** The HRIS creates a "pre-hire" or "pending employee" that becomes a full employee after completing onboarding steps.

        In this case:

        * ⚠️ **`id`** is `null` (employee not yet in Kombo's database)
        * **`remote_id`** is `null` (no persistent employee ID yet)
        * **`prehire.remote_id`** may contain the temporary prehire/pending employee ID from the HRIS, or be `null` if the system doesn't return an identifier
        * ⏳ The employee will appear in Kombo after the next sync, once onboarding is complete in the HRIS

        ```json Response Example (with prehire) theme={null}
        {
          "status": "success",
          "data": {
            "id": null,
            "remote_id": null,
            "prehire": {
              "remote_id": "prehire_67890"
            }
          }
        }
        ```

        ```json Response Example (without prehire) theme={null}
        {
          "status": "success",
          "data": {
            "id": null,
            "remote_id": null,
            "prehire": {
              "remote_id": null
            }
          }
        }
        ```

        **Use Case:** HRIS systems with multi-step onboarding workflows. Some return a pre-hire identifier (e.g., Paylocity, Workday), while others don't return any identifier (e.g., HiBob's [Hire API](https://apidocs.hibob.com/docs/how-to-integrate-with-ats-hire-api)).
      </Tab>
    </Tabs>
  </Step>
</Steps>

## Field Types & Validation

Our API supports several field types, each with its own validation rules. Below are summarized examples:

<AccordionGroup>
  <Accordion title="Text">
    <div>
      <div>
        Used for any textual input (e.g., first names, last names). Supports length constraints via `min_length`/`max_length` and pattern validation via `reg_exp` (regular expression).
      </div>

      <Warning>
        When a field includes both length constraints and regex patterns (as defined by the API), **all validations must pass**. Ensure your input data meets both the length requirements and matches the specified regex pattern.
      </Warning>

      <div>
        **Schema**

        ```jsx Schema theme={null}
        {
          type: "text";
          label: string;
          required: boolean;
          description: string | null;
          unified_key: string | null;
          min_length: number | null;
          max_length: number | null;
          reg_exp: string | null;
        }
        ```

        **Post Example**

        ```json Post Example theme={null}
        {
          "position": "Data Engineering"
        }
        ```

        **Validation Examples**

        ```json Examples theme={null}
        // ✅ Email validation with length constraints
        {
          "min_length": 3,
          "max_length": 100,
          "reg_exp": "^[^@]+@[^@]+$"
        }
        ```
      </div>
    </div>
  </Accordion>

  <Accordion title="Number">
    <div>
      <div>
        Used for numeric values such as ages or IDs.
      </div>

      <div>
        **Schema**

        ```jsx Schema theme={null}
        {
          type: "number";
          label: string;
          required: boolean;
          description: string | null;
          unified_key: string | null;
          min: number | null;
          max: number | null;
        }
        ```

        **Post Example**

        ```json Post Example theme={null}
        {
          "keyCard": 4
        }
        ```
      </div>
    </div>
  </Accordion>

  <Accordion title="Date">
    <div>
      <div>
        Used for date entries (e.g., employee start dates). The expected format is `YYYY-MM-DD`.
      </div>

      <div>
        **Schema**

        ```jsx Schema theme={null}
        {
          type: "date";
          label: string;
          required: boolean;
          description: string | null;
          unified_key: string | null;
        }
        ```

        **Post Example**

        ```json Post Example theme={null}
        {
          "hireDate": "2025-01-25"
        }
        ```
      </div>
    </div>
  </Accordion>

  <Accordion title="Single Select">
    <div>
      <div>
        Allows selection of a single option from a predefined list, if the type is options. Please submit the value of the Item.

        A link is provided for type reference, from which you can query the specific options. For example, this link can be used to get all `employees`, `departments`, or `staffing-entities` (e.g. positions or requisitions). For this case, please submit the ID as the selected value.
      </div>

      <div>
        **Schema**

        ```jsx Schema theme={null}
        {
              type: 'single_select'
              label: string
              required: boolean
              description: string | null
              unified_key: string | null
              options:
                | {
                    type: 'inline'
                    entries: {
                      label: string
                      id: string
                      unified_value: string
                      remote_id: string | number
                    }[]
                  }
                | {
                    type: 'referenced'
                    link: string
                  }
            }
        ```

        **Post Example**

        ```json Post Example theme={null}
        {
          "department": "2rv75UKT2XBoQXsUb9agiTUm"
        }
        ```

        **Remote ID Support**

        Inline single-select fields support submitting remote IDs directly using the `remote:` prefix:

        ```json Remote ID Example theme={null}
        {
          "department": "remote:dept-123"
        }
        ```

        This allows you to use the original remote system IDs instead of Kombo IDs.

        <Note>Only inline single-select fields support this format. Referenced fields require Kombo IDs.</Note>
      </div>
    </div>
  </Accordion>

  <Accordion title="Multi Select">
    <div>
      <div>
        Allows selection of multiple options from a predefined list. Please submit the values of the items.

        A link is provided for type reference, from which you can query the specific options. For example, this link can be used to get all `employees`, `departments`, or `staffing-entities` (e.g. positions or requisitions). For this case, please submit the IDs as the selected values.

        It is possible to have a minimum and maximum amount of items.
      </div>

      <div>
        **Schema**

        ```jsx Schema theme={null}
        {
              type: 'multi_select'
              label: string
              required: boolean
              description: string | null
              unified_key: string | null
              options:
                | {
                    type: 'inline'
                    entries: {
                      label: string
                      id: string
                      unified_value: string
                      remote_id: string | number
                    }[]
                  }
                | {
                    type: 'referenced'
                    link: string
                  }
            }
        ```

        **Post Example**

        ```json Post Example theme={null}
        {
          "supervisors": ["2rv75UKT2XBoQXsUb9agiTUm","FXrER44xubBqA9DLgZ3PFNNx"]
        }
        ```

        **Remote ID Support**

        Inline multi-select fields support submitting remote IDs directly using the `remote:` prefix:

        ```json Remote ID Example theme={null}
        {
          "supervisors": ["remote:emp-001", "remote:emp-002"]
        }
        ```

        You can also mix remote IDs with Kombo IDs for inline fields:

        ```json Mixed ID Example theme={null}
        {
          "supervisors": ["remote:emp-001", "2rv75UKT2XBoQXsUb9agiTUm"]
        }
        ```

        This allows you to use the original remote system IDs instead of Kombo IDs.

        <Note>Only inline multi-select fields support this format. Referenced fields require Kombo IDs.</Note>
      </div>
    </div>
  </Accordion>

  <Accordion title="Checkbox">
    <div>
      <div>
        A simple checkbox used for binary choices
      </div>

      <div>
        **Schema**

        ```jsx Schema theme={null}
        {
          type: "checkbox";
          label: string;
          required: boolean;
          description: string | null;
          unified_key: string | null;
        }
        ```

        **Post Example**

        ```json Post Example theme={null}
        {
          "hasCar": true
        }
        ```
      </div>
    </div>
  </Accordion>

  <Accordion title="Object">
    <div>
      <div>
        Used for nested fields or grouped data. Each property within the object is defined using a field type.
      </div>

      <div>
        **Schema**

        ```jsx Schema theme={null}
        {
          type: "object";
          label: string;
          required: boolean;
          description: string | null;
          unified_key: string | null;
          properties: {
            [key: string]: FieldObject;
          };
        };
        ```

        **Post Example**

        ```json Post Example theme={null}
        {
           "workLocation":{
              "city":"Berlin",
              ...
           }
        }
        ```
      </div>
    </div>
  </Accordion>

  <Accordion title="Array">
    <div>
      <div>
        Used when multiple items of the same type are expected, such as a list of values. You can define the minimum and maximum number of items. Please note that the item\_type can also be an object.
      </div>

      <div>
        **Schema**

        ```jsx Schema theme={null}
        {
          type: "array";
          label: string;
          required: boolean;
          description: string | null;
          unified_key: string | null;
          min_items: number | null;
          max_items: number | null;
          item_type: FieldObject;
        };
        ```

        **Post Example**

        ```json Post Example theme={null}
        Object Example:
        {
           "<key>":[
              {
                 "<subKey>":"FieldObjectValue"
              },
              {
                 "<subKey>":"FieldObjectValue"
              }
           ]
        }

        Text Example:
        {
           "tags":[
             "Test1", "Test3", "Test4"
           ]
        }
        ```
      </div>
    </div>
  </Accordion>

  <Accordion title="File">
    <div>
      <div>
        Used for uploading files. Restrictions, such as accepted MIME types and the maximum allowed file size, can be specified. Please submit the data as a Base64 string.
      </div>

      <div>
        **Schema**

        ```jsx Schema theme={null}
        {
          type: "file";
          label: string;
          required: boolean;
          description: string | null;
          unified_key?: string | null;
          file_restrictions: {
              accepted_mime_types: string[];
              max_file_size?: number | null;
            }
        }
        ```

        **Post Example**

        ```json Post Example theme={null}
        {
          "CV": "UEsDBBQAAAgIAK...."
        }
        ```
      </div>
    </div>
  </Accordion>
</AccordionGroup>

For each type, ensure client-side and server-side validation is in place (e.g., ensuring required fields are provided, input adheres to defined constraints, and clear error messages are surfaced).

## Referenced Models

When a `single_select` or `multi_select` field uses `options.type: "referenced"`, the `link` points to a Kombo HRIS endpoint you can call to retrieve the selectable entries. The selected value(s) you submit back must be the Kombo `id` of the chosen record(s).

The following Kombo data models can appear as reference targets in the employee form. The exact link — including any pre-applied query parameters — is always provided in the form schema, so you should use it as-is rather than constructing it yourself.

<Tip>
  **Recommended: sync referenced data ahead of time instead of fetching it on
  the fly.**

  All of the models below (employees, legal entities, locations, groups, staffing
  entities) are regular Kombo data models that you should already be syncing
  into your own database as part of your HRIS integration. When rendering the
  employee form, it's generally better to **populate the select options from
  your synced copy** rather than calling the referenced `link` in real time:

  * **Scale:** Some of these lists can be very large (thousands of employees,
    hundreds of positions, etc.). Fetching them on every form render is slow
    and can hit pagination limits.
  * **UX:** You can enrich the options with additional context from your own
    data (e.g. department, job title, location), provide proper search/typeahead,
    and cache them across sessions.

  Only fall back to calling the referenced `link` directly if you don't already
  have the data synced, or for small/static reference lists where the extra
  request is negligible.
</Tip>

<AccordionGroup>
  <Accordion title="Employees">
    Used for fields that reference another employee, most commonly **supervisors/managers**.

    * **Link:** `GET /v1/hris/employees`
    * **Submit:** the Kombo employee `id`
    * **Reference:** [Get employees](/hris/v1/get-employees)

    ```json Example Field theme={null}
    "manager": {
      "label": "Manager",
      "required": true,
      "unified_key": null,
      "type": "single_select",
      "options": {
        "type": "referenced",
        "link": "https://api.kombo.dev/v1/hris/employees?remote_model=employee"
      }
    }
    ```
  </Accordion>

  <Accordion title="Legal Entities">
    Used for fields that reference the legal employer / sub-company the employee should be attached to. Standard fields like `legal_entity_id` use this model.

    * **Link:** `GET /v1/hris/legal-entities`
    * **Submit:** the Kombo legal entity `id`
    * **Reference:** [Get legal entities](/hris/v1/get-legal-entities)

    ```json Example Field theme={null}
    "legalEntity": {
      "label": "Legal Entity",
      "required": true,
      "unified_key": "legal_entity_id",
      "type": "single_select",
      "options": {
        "type": "referenced",
        "link": "https://api.kombo.dev/v1/hris/legal-entities?remote_model=legal_entity"
      }
    }
    ```
  </Accordion>

  <Accordion title="Locations">
    Used for fields that reference a physical work location/site. Standard fields like `location_id` use this model.

    * **Link:** `GET /v1/hris/locations`
    * **Submit:** the Kombo location `id`
    * **Reference:** [Get locations](/hris/v1/get-locations)

    ```json Example Field theme={null}
    "workLocation": {
      "label": "Work Location",
      "required": true,
      "unified_key": "location_id",
      "type": "single_select",
      "options": {
        "type": "referenced",
        "link": "https://api.kombo.dev/v1/hris/locations?remote_model=location"
      }
    }
    ```
  </Accordion>

  <Accordion title="Groups (Departments, Teams, Cost Centers, …)">
    Used for fields that reference an organizational group such as a **department**, **team**, or **cost center**. Kombo models all of these under the unified `groups` endpoint and exposes the sub-type via the `types` query parameter.

    * **Link:** `GET /v1/hris/groups` (typically pre-filtered, e.g. `?types=DEPARTMENT`, `?types=TEAM`, or `?types=COST_CENTER`)
    * **Submit:** the Kombo group `id`
    * **Reference:** [Get groups](/hris/v1/get-groups)

    ```json Example Field theme={null}
    "department": {
      "label": "Department",
      "required": true,
      "unified_key": null,
      "type": "single_select",
      "options": {
        "type": "referenced",
        "link": "https://api.kombo.dev/v1/hris/groups?types=DEPARTMENT"
      }
    }
    ```

    <Note>
      If multiple group sub-types are relevant (e.g. the HRIS exposes both
      departments and cost centers as separate fields), you'll receive multiple
      referenced fields, each with its own pre-filtered link.
    </Note>
  </Accordion>

  <Accordion title="Staffing Entities (Positions, Requisitions, Jobs)">
    Used for fields that target a specific hiring slot the employee is being hired into. See the [Staffing entities feature page](/hris/features/staffing-entities) for a full overview of the model.

    * **Link:** `GET /v1/hris/staffing-entities` (optionally pre-filtered by `model_types` and/or `statuses`)
    * **Submit:** the Kombo staffing entity `id`
    * **Reference:** [Get staffing entities](/hris/v1/get-staffing-entities)

    ```json Example Field theme={null}
    "position": {
      "label": "Position",
      "required": true,
      "unified_key": null,
      "type": "single_select",
      "options": {
        "type": "referenced",
        "link": "https://api.kombo.dev/v1/hris/staffing-entities?model_types=POSITION&statuses=OPEN_LIMITED,OPEN_UNLIMITED"
      }
    }
    ```

    <Note>
      The pre-applied filters reflect what is meaningful for the connected HRIS
      (for example, only `OPEN_UNLIMITED` jobs, or only `REQUISITION` records).
      Use the link as returned in the schema.
    </Note>
  </Accordion>
</AccordionGroup>

## Additional Information

<Tabs>
  <Tab title="Handling Required Fields">
    * Fields marked `"required": true` must be provided.
    * Optional objects, if included, must have their required subfields completed.

    **Example Scenario:**

    If an optional object (`workLocation`) is submitted, then its required properties (like `site`) must be provided:

    ```json Example Result [expandable] theme={null}
    "workLocation": {
            "label": "Work Location",
            "required": false,
            "description": "Employee's work location",
            "unified_key": null,
            "type": "object",
            "properties": {
              "site": {
                "label": "Site",
                "required": true,
                "description": "Employee's site",
                "unified_key": null,
                "type": "single_select",
                "options": {
                  "type": "inline",
                  "entries": [
                    {
                      "id": "FXrER44xubBqA9DLgZ3PFNNx",
                      "label": "Office",
                      "remote_id": "office_001"
                    },
                    {
                      "id": "2rv75UKT2XBoQXsUb9agiTUm",
                      "label": "Warehouse",
                      "remote_id": "warehouse_001"
                    }
                  ]
                }
              }
            }
          }
    ```

    If `workLocation` isn't submitted, then the subfield requirement is bypassed.
  </Tab>

  <Tab title="Unified Keys & Values">
    Kombo uses a property called `unified_key` to standardize common fields between ATS and HRIS systems, allowing automatic data mapping.

    <div>
      <div>
        **Example:**

        * ATS provides first name data as:

          ```json Example theme={null}
          { "first_name": "Jane" }
          ```

        * Kombo automatically maps this into the HRIS's expected field.
      </div>

      <div>
        **Supported Unified Keys include:**

        ```tsx Unified Keys [expandable] theme={null}
          'first_name',
          'last_name',
          'date_of_birth',
          'gender',
          'home_address.city',
          'home_address.country',
          'home_address.state',
          'home_address.street_1',
          'home_address.street_2',
          'home_address.zip_code',
          'job_title',
          'legal_entity_id',
          'location_id',
          'mobile_phone_number',
          'nationality',
          'start_date',
          'work_email',
          'private_email',
          'yearly_salary',
        ```

        **Unified Key Values for Gender Mapping:**

        ```tsx Unified Key Values theme={null}
          'MALE',
          'FEMALE',
          'NON_BINARY',
          'NOT_SPECIFIED',
        ```
      </div>
    </div>
  </Tab>

  <Tab title="Error Handling">
    <div>
      <div>
        **Client Side:**

        Validate that all required fields are provided, validate formats (e.g., dates, numeric ranges), and provide inline validation messages.
      </div>

      <div>
        **Server Side:**

        Ensure the API returns clear error responses (400 for validation errors, 500 for server issues) and include guidance on resolving common errors.
      </div>
    </div>
  </Tab>

  <Tab title="Scopes & Permissions">
    Although **Create Employee** is a *write* feature, it often needs to *read* some information to work. Take a look at the following scenarios:

    ### Scenario 1

    The form schema includes a `manager` field that references another employee's ID.

    You may want to access the list of employees in order to render a select including the names of all employees (or better: only the managers), with their names mapped to IDs.

    ### Scenario 2

    The form schema includes a `location` field that references the company's work location.

    This requires access to the list of company locations.

    ### Scenario 3

    The form schema includes a field that references a [staffing entity](/hris/features/staffing-entities) (e.g. a position or requisition) that the employee should be hired into.

    This requires access to the list of staffing entities, which you can query via the [GET staffing entities](/hris/v1/get-staffing-entities) endpoint. The `referenced` link returned in the form schema will point to this endpoint (optionally pre-filtered by `model_types` and/or `statuses`).

    <Accordion title="Real-world example">
      [Paylocity HRIS](/hris/connectors/paylocity) allows defining the `costCenter1`, `costCenter2`, and `costCenter3` fields when creating an employee.

      Their values reference the cost centers, which are a part of Kombo's [Groups](/hris/v1/get-groups#get-groups) data model.

      In order to access them, make sure that you enable this data model in the [Scope configuration](/hris/features/scopes).
    </Accordion>

    <Tip>
      A quick way to check specifically which scopes are required/useful for create employee, is to visit the integration-specific documentation and look for **Supported Features & Coverage** → **Create Employee with Form**.

      Here are a few examples:

      * [HiBob HRIS](/hris/connectors/hibob#create-employee-with-form)
      * [Personio HRIS](/hris/connectors/personio#create-employee-with-form)
      * [UKG Pro HRIS](/hris/connectors/ukgpro#create-employee-with-form)
    </Tip>
  </Tab>
</Tabs>

## Dashboard Form Preview

The Kombo Dashboard provides a convenient way to preview the employee form for connected HRIS systems:

* **Developer Preview Tool** – Allows you to see exactly what fields you'll receive through the `GET /employees/form` endpoint.
* **Visual Reference** – Shows how the form could look when rendered in a frontend application.
* **Testing Environment** – Helps you understand where created employees will appear in the HRIS and verify field mappings.

<Accordion title="Important Notes">
  <ul>
    <li>
      **Testing Only** – The Dashboard form is intended for development and
      testing purposes, not for production use.
    </li>

    <li>
      **Access Control** – This feature is not enabled by default. Contact Kombo
      Support to have it activated on your instance.
    </li>

    <li>
      **Learning Resource** – Use it to better understand the form structure
      before implementing your own UI.
    </li>
  </ul>
</Accordion>

<Frame>
  <img alt="dashboard-form-preview.png" />
</Frame>

## Summary

By implementing Kombo's Create Employee functionality, your ATS platform simplifies employee onboarding by dynamically adapting to any HRIS schema, automating data mapping, and ensuring reliable data submission.


# Building filtering in-house
Source: https://docs.kombo.dev/hris/implementation-guide/filtering-employees/building-filtering-in-house



<Warning>
  We highly recommend using [Kombo's filtering UI](./using-the-filtering-ui) to
  implement employee filtering. Read why [here](./context).
</Warning>

## Determining the filter

Most of our users go about this by building specific UI components that let your customer choose a set of criteria, like membership of:

* groups (departments, cost centers, teams, etc.)
* legal entities (sub-companies)
* work locations (certain offices, production sites, etc.)

The UI usually includes the following:

* List of all [groups](/hris/v1/get-groups), [legal entities](/hris/v1/get-legal-entities), [work locations](/hris/v1/get-locations), etc. (fetched from the “organization” endpoints) that can be marked as *include* vs *exclude*
* List of all employees that match the current inclusion criteria
* Button to save the current criteria

For example, the Kombo filtering UI looks like this:

<img alt="Filtering UI to share with customers so they can share which employees they want to share with you" />

## Setting up filtering for explicit criteria

Once you have the criteria from your customer, you can use them to make filtered requests against Kombo's endpoints. You should be able to filter all relevant things based on the query parameters that are already provided. Therefore you **do not have to read all the data and filter it on your end.**

When combining top-level filters they are working in an **and** fashion, but comma-separated filters are working in an **or** fashion. For example:

The query parameters `?group_ids=123,321&location_ids=abc` could be translated to "give me all employees that are part of either group `123` or `321`, *and* of location `abc`"

The available query parameters are listed under each endpoint:

<img alt="1376" />

## Optional: Make transparent, which users didn’t get access

Some customers decide to include a UI component on the settings page that shows a list of users who were recently off-boarded due to being moved to a new group or their employment expiring.

While this can provide a cleaner UX to your customer, you should be careful with sharing and exposing data of people that are not entitled to your product anymore due to GDPR data minimization.


# Context
Source: https://docs.kombo.dev/hris/implementation-guide/filtering-employees/context



When reading employees, it's often desired to implement employee filtering. For example, your product might only require syncing employees with a certain employment status, or who work at a specific location.

Kombo offers a [built-in filtering feature](/hris/features/filtering/introduction) that your customers can use to select which data they want to share. Letting your customers select the filter adds an extra layer of trust; they know that only the data that they explicitly want to share is shared. This is also the approach we recommend to most customers as it allows getting into production way **faster and cheaper**.

Alternatively, we provide a guide on building filtering yourself, which allows for **maximal flexibility**, with the downside of having to build complex logic and UI components yourself. As you filter the data when calling Kombo's endpoints, this approach also forces us to cache more data in our database than you will use in production.

<img alt="1376" />


# Using the filtering UI
Source: https://docs.kombo.dev/hris/implementation-guide/filtering-employees/using-the-filtering-ui



## Overview

After setting up Kombo's [data filtering](/hris/features/filtering/introduction) for a connection, all endpoints that handle employee-related data will only return data related to your selected subset. For example, if you choose only to include employees with a work location in Berlin, reading absences will only include the absence data of Berlin-based employees.

## Accessing the filtering UI

There are multiple ways of accessing the filtering UI

### When creating an integration in the dashboard

Create an integration on the integrations page.

<img alt="1376" />

In the integration settings, enable the filtering toggle.

<img alt="1376" />

### When creating a connection link via API

In the [create-link](/hris/v1/post-connect-create-link) endpoint, make sure to include the `enable_filtering` property in the body.

```bash theme={null}
curl --request POST \
  --url https://api.kombo.dev/v1/connect/create-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "end_user_email": "test@example.com",
  "end_user_organization_name": "Test Inc.",
  "enable_filtering": true
}'
```

### Implementing filtering retroactively

If you have already created an integration with a customer or would prefer to separate the filtering step from the connection flow, we allow you to set up a filter in retrospect.

Click on the integration on the integrations page.

<img alt="1376" />

Enter the integration's settings, and press on **configure filters**.

<img alt="1376" />

This will provide a link that you can share with a customer, or open yourself, to configure the filter.

<img alt="1376" />

Alternatively, you can also use the [Create provisioning setup link endpoint](/hris/v1/post-provisioning-groups-group-id-setup-links) to get the same link via API, as shown below. The group ID references the provisioning group; currently only the string `"default"` is supported.

```bash theme={null}
curl --request POST \
  --url https://api.kombo.dev/v1/hris/provisioning-groups/{group_id}/setup-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Integration-Id: <x-integration-id>' \
  --data '{
  "language": "en"
}'
```

## Specifying the filter

Once either your customer or you open the filtering UI, you simply have to select which employee properties should be filtered. For example, selecting **Employment status -> Active** will make the following syncs only include data related to active employees.

Selecting multiple values for the same fields filters with an **or** relationship, while different fields filter with an **and** relation.

For example, selecting **Berlin** and **Amsterdam** for `location`, and **active** for `employment_status`, will include all employees that are currently actively employed, **and** work in either Berlin **or** Amsterdam.

<img alt="Filtering UI to share with customers so they can share which employees they want to share with you" />

Confirm your selection by clicking on the **Share employees** button at the bottom of the filtering UI.

We also provide documentation on how we handle [data deletion](/hris/features/filtering/data-policy) when filtering.


# Reading employees
Source: https://docs.kombo.dev/hris/implementation-guide/reading-employees



<img alt="1376" />

## Before you can read data

Data will start automatically syncing once your customer has successfully completed the connection flow to connect their HRIS.

To prevent returning incomplete data while it's still running, you will not get any data until the *first sync* completes.
If you send a request before that, the API responds with an [error `code`](/guides/errors) like `INTEGRATION.SETUP_SYNC_PENDING`:

```json theme={null}
{
  "status": "error",
  "error": {
    "code": "INTEGRATION.SETUP_SYNC_PENDING",

    "title": "The integration's setup sync is still running.",
    "message": "The first sync of this integration didn't finish successfully yet! You can keep polling this until you get a successful response or react to our webhooks."
  }
}
```

| Code                                                                              | When it appears                              | What to do                                                                  |
| --------------------------------------------------------------------------------- | -------------------------------------------- | --------------------------------------------------------------------------- |
| [`INTEGRATION.SETUP_SYNC_PENDING`](/guides/errors#integration-setup-sync-pending) | Initial sync is still running.               | Keep polling or listen to data-changed.                                     |
| [`INTEGRATION.SETUP_INCOMPLETE`](/guides/errors#integration-setup-incomplete)     | Some steps have not been completed yet.      | Please finish the setup. Then keep polling or listen to data-changed.       |
| [`INTEGRATION.QA_FAILED`](/guides/errors#integration-qa-failed)                   | Incomplete data triggered Quality Assurance. | Wait for Kombo support to fix this. Keep polling or listen to data-changed. |

If you receive one of these error `code`s keep requesting the endpoint until you get a successful response.
Alternatively listen to our `data-changed` webhook, as described in [setting up your webhook](/hris/implementation-guide/setup#set-up-webhooks).

<Note>
  🦉 The first data sync could **take a few seconds up to multiple hours**, depending on your scope config, the system itself (some are heavily rate-limited), and how much data is in your customer's system.

  The UX for your customer should therefore be designed around some delay/waiting time.
</Note>

## Getting employees

Once the first sync is finished, you must [fetch the data](/hris/getting-started/querying-api) from the Kombo API and store it in your system so that you can show it to your customer without having to call the API again.

When querying data from the Kombo API, you should consider the following things:

* We recommend setting the `page_size` query param to the maximum batching (250 elements) to minimize the number of API calls and maximize API response size.
* Our API is optimized to serve a few calls with large payloads at comparatively low latencies. That makes our API perfect for batch-requesting large amounts of data in a few seconds.
* Make sure to implement [pagination](/hris/getting-started/querying-api#pagination), by using the `next` key in our API response and passing it in the `cursor` query param

A request to the [get employees endpoint](/hris/v1/get-employees) could therefore look like this:

```shell theme={null}
curl --request GET \
  --url 'https://api.kombo.dev/v1/hris/employees?cursor=26vafvWSRmbhNcxJYqjCzuJg&page_size=250' \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Integration-Id: <x-integration-id>'
```

Once you have the data, you can perform your specific business logic. Most customers in HRIS define their behavior like this:

* **Users to add:** These are all of the records that, until now, did not appear in your query. They need to be inserted into your database and probably should get an invitation in case it’s the first time they are onboarded to your product.
* **Users to update:** These are users that already have access but were changed in any given property (e.g. changed address, bank details, etc.). Those users can just be updated in the database.
* **Users to remove:** These are users that you currently have in your database but that don’t show up in the API response anymore. This means you should notify the user that their access will be removed and mark them as deleted. It can happen that a user will lose access and get onboarded at a later time. Therefore you should keep track of off-boarded employees so that you can distinguish them from the ones that get access to the product for the first time. Just storing the ID in the HRIS system is a GDPR-compliant and relatively robust way to do so.

## Understanding Organizational Hierarchy

Kombo exposes organizational structure through two complementary data models that you can combine to reconstruct reporting lines and department trees.

### Manager Reporting Lines

Each employee has a `manager_id` field (and an expanded `manager` object) that references another employee in the same dataset. You can use this to build a reporting-line tree:

```json theme={null}
{
  "id": "26vafvWSRmbhNcxJYqjCzuJg",
  "first_name": "Jane",
  "last_name": "Smith",
  "manager_id": "7E2gyuv6TmvtByzBxW9Sxt53",
  "manager": {
    "id": "7E2gyuv6TmvtByzBxW9Sxt53",
    "first_name": "John",
    "last_name": "Doe",
    "work_email": "john.doe@example.com"
  }
}
```

To build a full reporting tree, collect all employees and build an adjacency list keyed by `id` with edges from `manager_id`. Employees where `manager_id` is `null` are at the top of the hierarchy.

### Group Hierarchy

The [GET Groups endpoint](/hris/v1/get-groups) returns departments, teams, cost centers, and other organizational units. Each group has a `parent_id` field that references another group, allowing you to build a department or team tree. Each employee's `groups` array (on the GET Employees response) tells you which groups they belong to.

To reconstruct the full organizational picture:

1. Fetch all groups via [GET Groups](/hris/v1/get-groups) and build a tree using `parent_id`
2. Use employee `groups` memberships to place employees into the tree
3. Use `manager_id` chains for reporting lines within or across groups

<Note>
  Coverage for `manager_id` and group `parent_id` varies by HRIS system. Some
  tools expose rich hierarchies while others may return `null` for these fields.
  Design your implementation to handle missing hierarchy data gracefully.
</Note>

## Fetching only updated data

Instead of reading the entire dataset, we highly recommend reading only employees that have been updated since you last read them. We have implemented change tracking to make this as easy as possible.

The change-tracking of Kombo (which you can learn more about [here](/hris/getting-started/fetching-data)) centers around the `updated_after` query parameter, which you can use in the following way:

1. Store the timestamp at which you start ingesting the data from the first fetch in your own database. This field should probably be called something like this:

| customer\_id           | kombo\_integration\_id              | last\_fetched\_from\_kombo\_at |
| ---------------------- | ----------------------------------- | ------------------------------ |
| `<end_user.origin_id>` | `personio:8d1hpPsbjxUkoCoa1veLZGe5` | `1970-01-01T00:00:00.000Z`     |
| `<end_user.origin_id>` | `hibob:B1hu5NGyhdjSq5X3hxEz4bAN`    | `1970-01-01T01:13:24.000Z`     |

2. Whenever Kombo detects a change, we send you a `data-changed` [webhook](../guides/webhooks#data-changed) that looks like this:

```json theme={null}
{
  "id": "FhghqjnCi9WuAoLT8Z75CFcs",
  "type": "data-changed",
  "data": {
    "integration_id": "personio:8d1hpPsbjxUkoCoa1veLZGe5",
    "integration_tool": "personio",
    "integration_category": "HRIS",
    "changed_models": [{ "name": "hris_employees" }]
  }
}
```

3. You should make a lookup in your database, finding the `last_fetched_from_kombo_at` for this specific integration and then pass it again in the `updated_after` query param of the get endpoint, like this:

```bash theme={null}
curl --request GET \
  --url 'https://api.kombo.dev/v1/hris/employees?updated_after=1970-01-01T00:00:00.000Z' \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Integration-Id: <x-integration-id>'
```

4. We will return all records that have been altered in one of the following ways:
   * property changed (i.e. `employment_status` property of an employee)
   * relation property changed (`name` of a group the employee is part of)

## Implementing Kombo in an existing system (Matching users)

When fetching employees from Kombo, you will encounter three possibilities:

For the case of onboarding a customer that already has some employees onboarded to your system, you need to implement a way to match the existing user records in your database with the ones you’re getting from the Kombo API.

You basically want to have an upsert that finds existing employees and persists the Kombo ID of those employees and creates new entries for employees that are not yet in your database.

Before diving into the matching logic, let’s look at the different values that you can use to identify an employee contained in an API response:

* `id`: This is a unique, Kombo-specific id that is randomly generated and not present in any other system
* `remote_id`: This is the id of the record in the “remote” system (the HRIS, e.g. Personio). The ID is always a string but the format will vary widely across tools. This is a fairly robust value to use as an identifier but it will change in case the employee is deleted and re-created in the HRIS.
* `work_email`: The email address of the employee. While this *should* be guaranteed to be unique, it could be that the email address of people changes over time (e.g. bc the email naming convention is changed [john@example.com](mailto:john@example.com) → [john.d@example.com](mailto:john.d@example.com) or the email domain changes [john@example.com](mailto:john@example.com) → [john@new-example.com](mailto:john@new-example.com)). It could also be that an employee's `work_email` is added 2+ to a tool because they left a company and returned OR moved from a temporary to a full time position. You should make sure you are aware and ready to handle these cases if and when they come up.

Now for the matching logic. You should try to match the incoming records based on those values (in order of reliability):

* `remote_id`: if you are already storing the external ID of a user in your system, you should use this as much as possible
* `work_email`: the next best option is using the email to match. Please note above that emails will not always be unique and you should be ready to handle edge cases (e.g someone leaves a company and returns later on) for duplicate emails when matching. For some tools temporary workers will all have the same email making matching on `work_email` not possible.
* `work_email` but with a changed domain: there might be cases in which the email differs only by the domain. You can probably match based on the “prefix” of the email, but it’s not a 100% reliable operation and should be done cautiously.
* Edge cases:
  * In case you cannot match all employees between the API response and your own database, you should ask your user to match the remainder of the employees.
  * A possible solution is showing a UI with two sides (the new data on the left, and your current data on the right) that displays the mismatched records.
  * You should suggest a mapping based on the full name / private email of the employee but let your customer confirm that those mappings are correct.
  * If after the manual mapping, there are still some mismatched records, you should consider those employees to be removed/added to your system.

Once you match an employee you should persist both the id and remote\_id in your database. This could look like this:

| user\_id          | hris\_id             | kombo\_id                  |
| ----------------- | -------------------- | -------------------------- |
| `<your_user_id1>` | `<kombo_remote_id1>` | `<kombo_id>`               |
| `1234`            | `1239463`            | `7E2gyuv6TmvtByzBxW9Sxt53` |

## Handling failing syncs

It is possible that a sync fails, and if that happens, you will still be able to access the data based on the latest successful sync. Once the sync succeeds again, you will be able to get all updates that have happened since the last time.

When a sync fails, the `sync-finished` has a `data.sync_state` property that is not `"SUCCEEDED"`:

```json theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "sync-finished",
  "data": {
    "sync_id": "B89SCXXho7Yw8PGo8AKJxLn4",
    "sync_state": "AUTHENTICATION_FAILED",
    "sync_started_at": "2021-09-01T12:00:00.000Z",
    "sync_ended_at": "2021-09-01T12:30:00.000Z",
    "sync_duration_seconds": 1800,
    "integration_id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
    "integration_tool": "personio",
    "integration_category": "HRIS",
    "log_url": "https://app.kombo.dev/env/production/logs/C3xUo6XAsB2sbKC7M1gyXaRX"
  }
}
```

If you receive these values it means the **sync went through** and you’ll get updates on the data

| `sync_state`       | Explanation                     | Next Steps                                          |
| ------------------ | ------------------------------- | --------------------------------------------------- |
| `SUCCEEDED`        | Everything went fine            |                                                     |
| `PARTIALLY_FAILED` | Succeeded with non-fatal errors | Kombo will be notified and look into the issue asap |

These values mean the sync failed and the **problem is only fixable by Kombo**

| `sync_state` | Explanation                                                             | Next Steps                                                                                                                             |
| ------------ | ----------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `CANCELLED`  | The sync was actively canceled by Kombo                                 | This happens very rarely, has no negative side-effects, and if it does happen, we will schedule a new sync shortly after               |
| `FAILED`     | There was a critical error during the sync and the sync did not finish. | If this happens, we get an alert and will look into the issue to fix it ASAP                                                           |
| `TIMED_OUT`  | The sync timed out before completion                                    | This happens rarely and will cause an immediate and automatic restart of the sync. Kombo will be notified and look into the issue ASAP |

These values mean the sync failed because we were not able to authenticate. We will try to sync 3 more times. Afterwards we will send the `integration-state-changed` webhook with state `INVALID` and you / your customer will have to re-connect.

| `sync_state`            | Explanation                                                                                                                | Next Steps                                                                                                                        |
| ----------------------- | -------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `AUTHENTICATION_FAILED` | The sync couldn’t complete because the API credentials are invalid or don’t allow requesting all data points in your scope | This can only be fixed by your customer adding additional permissions to the credentials or updating the credentials all-together |


# Setup
Source: https://docs.kombo.dev/hris/implementation-guide/setup



Before you can get started with development, there’s a bit of setup to do. Please follow the steps below carefully so that you won’t have any issues down the line.

## Log into the dashboard

Login to the Kombo dashboard. You should have received an invite via email but if you didn’t, reach out to your team members or to Kombo directly via Slack/Teams

<img alt="Kombo Dashboard" />

## Scope configuration

<Note>
  The scope config allows you to set which models and properties will be included when reading data from Kombo. Additionally, when your customers create an integration, they will only be prompted to grant permission to read the properties included in your scope config.

  To understand more about this feature and how to use it to evoke a great first impression with customers, [read more here](/hris/features/scopes)
</Note>

Go to the [scopes overview](https://app.kombo.dev/scope-config) and click on “**New config**” or “**Edit**” an existing one.

<img alt="1376" />

Select the data models that you need and click on “**Save changes**”.

<img alt="Editing scope config" />

<img alt="Saving scope config" />

## Integration configuration

Go to the [tools overview](https://app.kombo.dev/tools) and select/deselect all tools that you want to offer. You can change this at any time.

You can also select if you want to enable newly released tools; on average Kombo adds one tool per week.

<img alt="Integration configuration" />

## Set up a linked account for development

To call the API you always need to have a linked HRIS account to pull and push data from. You can either use our built-in mock integration to get started quickly (recommended), or [get yourself a sandbox via a free trial](/hris/getting-started/sandbox-integrations).

To use our built-in sandbox, go to the [integrations tab](https://app.kombo.dev/integrations) and click on “**New integration**”, selecting **Kombo Sandbox** as your tool.

<img alt="Create integration" />

<img alt="Select kombo sandbox" />

What you see now is the so-called connection flow. Customers will see the UI when connecting their HRIS to your product via Kombo. You can preview the various connection flows of the different tools on the [tools page](/hris/guides/implementing-new-tools#resources).

Click “**Continue**” and “**Set up integration**”.

<div>
  <img alt="First Image Description" />

  <img alt="Second Image Description" />

  <img alt="Third Image Description" />
</div>

**Click** on the tile that just appeared to get to the details page of the integration.

<img alt="Integration details" />

On this page, you can find all info related to the integration. For now, you will only need the integration ID.

<img alt="Integration details 1.png" />

## Set up webhooks

Webhooks are a fundamental part of your Kombo implementation. There are multiple different webhook types for different purposes (you can find all of them here) but setting them up always works the same:

Go to the [webhooks tab](https://app.kombo.dev/configuration/webhooks)

<img alt="Webhook tab" />

Create a webhook, give it a descriptive label, enter the URL, and select the desired type.

<img alt="Create webhook" />

Send a test webhook by clicking the test button

<img alt="Test webhook" />

<Info>
  Later on in this guide, we will talk more about the most important types of
  webhooks, but you can find an all-encompassing overview on our [webhooks
  page](/hris/guides/webhooks)
</Info>

## Create Kombo API key

Go to the [Secrets tab](https://app.kombo.dev/secrets) and click on “**New API key**”.

<img alt="Secrets tab" />

Name the API key and click “**Create API key**”.

<img alt="Create API key.png" />

Copy the token and store it somewhere safe.

<img alt="Create API key.png" />

## Test your setup

🎉 You made it through the setup and have everything in place to get started developing 🎉

To verify you set up the sandbox integration and API key correctly, try the following HTTP request to the [“get integration details”-endpoint](/hris/v1/get-integrations-integration-id)

```bash theme={null}
curl --request GET \
  --url https://api.kombo.dev/v1/integrations/{integration_id} \
  --header 'Authorization: <api_key>'
```

You can also use any other endpoint like [“get employees”](/hris/v1/get-employees) or [“get legal entities”](/hris/v1/get-legal-entities). The Sandbox integration will return you some sample data for it.

<Tip>
  **Tip:** You can use our [official server-side SDKs](/libraries-and-sdks) to
  interact with the Kombo API in an ergonomic and type-safe manner. Check if
  your tech stack is already supported!
</Tip>

## Optional: set up Postman collection

To make development easier, we recommend setting up a Postman collection. It takes only one minute and can be done like this:

* **Copy** the link of our OpenAPI schema:

  ```bash theme={null}
  https://api.kombo.dev/openapi.json
  ```

* Open Postman, and click **Import**
  <img alt="1376" />

* **Paste** the URL and click **Import**

  <img alt="Postman URL.png" />

  <img alt="Postman Collection.png" />


# Create Employee Form with Staffing Entities
Source: https://docs.kombo.dev/hris/implementation-guide/staffing-entities-in-create-employee

Get a scoped create employee form by implementing and using our **Staffing Entities** model.

## Overview

[Staffing entities](/hris/features/staffing-entities) represent the hiring
structures (positions, requisitions, jobs) inside an HRIS. Many enterprise HRIS
systems (e.g., Workday, UKG Pro, SAP SuccessFactors) require new employees to
be hired **into** one of these entities rather than created as standalone
records.

As an ATS provider, you integrate staffing entities in **two phases**:

1. **Requisition / job posting setup.** When your user creates or edits a
   requisition (or job posting — whatever your ATS calls its hiring object),
   you let them pick a single staffing entity from the connected HRIS and
   store its `staffing_entity_id` on the requisition. Optionally, you prefill
   base requisition fields (title, department, location, employment type, ...)
   from the selected entity.
2. **Hire.** When an application tied to that requisition reaches the hire
   stage, you pass the stored `staffing_entity_id` to
   [`GET`](/hris/v1/get-employees-form) and
   [`POST /hris/employees/form`](/hris/v1/post-employees-form). Kombo uses it
   to both narrow the form (dropdowns are pre-filtered to values linked to the
   entity) and to tell the HRIS which position or requisition the new hire
   fills.

<Note>
  The staffing entities endpoint is currently in **beta**. Reach out to support
  if you'd like it enabled for your instance.
</Note>

## Why this matters for your customers

* **Correct placement** — The new employee lands in the HRIS position the
  customer's HR team has already approved, with the correct reporting line,
  cost center, and budget attached.
* **Requisition-driven hiring** — Each ATS requisition is tied back to an
  approved HRIS position or requisition for headcount tracking and downstream
  approval flows.
* **Prefilled requisition data** — Picking a staffing entity while creating a
  requisition lets you prefill title, department, location, legal entity, and
  employment type, keeping ATS data consistent with the HRIS.
* **Fewer user errors** — The employee form's dropdown options are automatically
  filtered to the values linked to the staffing entity. Users only see values
  that make sense for the position/job/requisition.
* **Unlocks enterprise customers** — Enterprise HRIS suites like Workday and UKG
  Pro won't accept a bare employee; they need a target position/job/requisition,
  making the form bigger and more complex.
  Using staffing entities allows you to prefill up to 40% of the creation form,
  significantly improving your customer experience and satisfaction.

<Tip>
  A quick way to check whether an integration exposes staffing entities (and
  which model type) is to visit the connector's page and look under **Supported
  Features & Coverage**. For example:

  * [UKG Pro HRIS](/hris/connectors/ukgpro)
  * [Workday HRIS](/hris/connectors/workday)
</Tip>

## End-to-end flow

### Phase 1 — Linking a staffing entity to a requisition

<Steps>
  <Step title="Check if the integration supports staffing entities">
    Not every HRIS connector exposes staffing entities. Before exposing the
    staffing entity picker in your requisition / job posting UI, probe
    `GET /hris/staffing-entities` for the target integration.

    If you believe the target integration should support the staffing entity model,
    reach out to us via your dedicated support channel to request the coverage.

    Also make sure the **HRIS Staffing Entities** [scope](/hris/features/scopes)
    is enabled for the integration — the data must be in Kombo's database for the
    endpoint to return results.

    <Note>
      If the integration does **not** support staffing entities or returns no
      results, hide the picker in your requisition editor and call the form
      endpoints **without** `staffing_entity_id` at hire time, just as described
      in the base [create employee guide](/hris/implementation-guide/create-employee).
    </Note>

    <Frame>
      <img alt="Staffing entity model in scope config" />
    </Frame>
  </Step>

  <Step title="Fetch available staffing entities">
    Use [`GET /hris/staffing-entities`](/hris/v1/get-staffing-entities) to pull
    the positions, jobs, or requisitions the customer can hire into. Allow your
    customer to filter down to what they actually care about:

    ```bash Example: open positions/jobs/requisitions only theme={null}
    GET /hris/staffing-entities?statuses=OPEN_LIMITED,OPEN_UNLIMITED
    ```

    ```bash Example: requisitions only theme={null}
    GET /hris/staffing-entities?model_types=REQUISITION
    ```

    ```bash Example: open requisitions only theme={null}
    GET /hris/staffing-entities?model_types=REQUISITION&statuses=OPEN_LIMITED,OPEN_UNLIMITED
    ```
  </Step>

  <Step title="Render the picker inside your requisition editor">
    Expose the staffing entity picker **inside the requisition / job posting
    creation and edit flow**, not at hire time. A single staffing entity
    should be linked to each requisition.

    A good picker shows:

    * `name` - main identifier
    * `model_type` — useful as a badge if the customer mixes positions/jobs/requisitions
    * `status` + `number_of_openings` — so the user knows how many slots are
      left
    * The first `location` and `legal_entity` so they can clearly attribute the
      position inside their organization.
    * `remote_url` — use it to link to the HRIS for a quick verification step

    Avoid:

    * `remote_id` - Often a technical and lengthy UUID. This is usually not the
      requisition ID displayed by most ATS modules and therefore could lead to confusion.
    * `description` - The description property often includes fully rendered HTML
      with a lengthy job description, making it unsuitable for display as part of a
      single-select picker.
    * `groups` - Staffing entities are often part of multiple groups, making it hard
      to render this in a meaningful manner.
    * `remote_created_at` and `remote_updated_at` - Those internal timestamps are
      usually not displayed anywhere in the HRIS UI, making them unsuitable for
      identifying the record.
  </Step>

  <Step title="Prefill requisition fields from the selected entity (recommended)">
    When the user picks a staffing entity, prefill your own requisition fields
    from the entity so the ATS record mirrors the HRIS source of truth:

    * `name` → requisition title
    * `description` → requisition description
    * `employment_types` → requisition contract type
    * `locations` → requisition work location
    * `legal_entities` → employing entity
    * `groups` → department / team / cost center

    Users can still override any field after prefill. This both saves typing
    and reduces drift between what the requisition says in the ATS and what
    the HRIS will ultimately accept at hire time.
  </Step>

  <Step title="Persist `staffing_entity_id` on the requisition">
    Store the Kombo `id` of the chosen staffing entity on your own requisition
    / job posting record. You will reuse this exact id later, at hire time,
    for every applicant that reaches the hire stage for this requisition.

    <Note>
      Ideally, you link exactly **one** staffing entity per requisition/job posting.
      If you want to allow your customer to link multiple staffing entities to a
      single requisition in your system, you need a small staffing entity
      selector when hiring employees.
    </Note>
  </Step>
</Steps>

### Phase 2 — Using the linked staffing entity at hire time

<Steps>
  <Step title="Fetch the form with the stored `staffing_entity_id`">
    When an application tied to the requisition reaches the hire stage, pass
    the `staffing_entity_id` you stored on the requisition to the
    [`GET /hris/employees/form`](/hris/v1/get-employees-form) endpoint:

    ```bash theme={null}
    GET /hris/employees/form?staffing_entity_id=26vafvWSRmbhNcxJYqjCzuJg
    ```

    The response is the **same schema shape** as a normal `GET
            /hris/employees/form` call, but with many reference fields
    already pre-filtered.
  </Step>

  <Step title="Submit the form with the same `staffing_entity_id`">
    When posting back, include the same `staffing_entity_id` alongside your
    collected `properties`:

    ```json Example request theme={null}
    {
      "staffing_entity_id": "26vafvWSRmbhNcxJYqjCzuJg",
      "properties": {
        "firstName": "Jane",
        "lastName": "Doe",
        "startDate": "2025-02-01",
        "workLocation": {
          "site": "remote:office_berlin"
        }
      }
    }
    ```

    Kombo uses this to both **validate** the submitted values against the
    narrowed form and to **tell the downstream HRIS** which position or
    requisition this new hire fills.

    <Warning>
      Use the **same** `staffing_entity_id` for the `GET` form call and the
      `POST` submission. Mixing them (or omitting it on one side) can lead to
      validation errors because the form the user filled in may contain
      scoped options that no longer exist in the POST-side validation.
    </Warning>
  </Step>

  <Step title="Handle the response">
    The response follows the standard
    [create employee response](/hris/implementation-guide/create-employee)
    contract — `id`/`remote_id` on immediate creation, or a `prehire.remote_id`
    when the HRIS uses a multi-step onboarding flow.

    Nothing changes here because the staffing entity was used during creation,
    not returned in the response.
  </Step>
</Steps>

## How the form changes with a staffing entity

Passing `staffing_entity_id` does **not** change the overall field types or
the way you render the form — you still get the same schema shape as a
regular `GET /hris/employees/form` call. What the staffing entity does is
let Kombo tailor the form to the selected position or requisition:

* **Some select fields come back with fewer options.** Dropdowns for things
  like legal entity, location, or department may be limited to the values
  actually linked to the staffing entity, instead of the full org.
* **Some fields may be hidden entirely.** If a property doesn't apply to the
  selected staffing entity (e.g., a salary field on a non-salaried
  position), Kombo may omit it from the form so users never see it.
* **Some fields may appear that weren't there before.** Certain HRIS systems
  expose extra properties that only make sense in the context of a specific
  position or requisition — these only show up when a `staffing_entity_id`
  is passed.

The exact behavior depends on the HRIS and on how the customer has modeled
their staffing entities. Treat the form returned with `staffing_entity_id`
as the source of truth and render whatever comes back.

### Preselect fields with only one option

A common side effect of scoping the form is that select fields can end up
with **exactly one** valid option — for example, a position tied to a
single legal entity produces a `legal_entity_id` field with just one entry.

When this happens, we recommend **preselecting the value and keeping the
field visible** in your UI. Users should still see what's about to be
submitted — they just don't have another option to pick from:

* **Required fields** — render the field with the single option preselected
  and disabled. The user sees the value that will be submitted but can't
  change or clear it.
* **Optional fields** — render the field with the single option preselected
  but allow the user to unselect it if they don't want to submit a value.

Either way, the value the user sees on screen is exactly what gets sent in
the `POST` payload, which keeps the flow transparent and avoids surprises
downstream in the HRIS.

## Recommendations

* **Automatically persist or allow your customer to save the filter configuration**
  used to select the staffing entity in the create/edit view of your requisition/job posting.
* **Put the picker in the requisition editor, not the hire flow.** Selecting
  a staffing entity is a setup-time decision tied to the requisition, not a
  per-hire decision.
* **Prefill requisition fields** (title, description, employment type,
  location, legal entity, groups) from the chosen staffing entity.
* **Store `staffing_entity_id` on the requisition** and reuse the exact same
  value on both `GET` and `POST /hris/employees/form` at hire time.
* **Apply default filters.** `statuses=OPEN_LIMITED,OPEN_UNLIMITED` plus
  `model_types=REQUISITION` or `model_types=POSITION,JOB` is almost always what
  your customers want.
* **Hide the picker on HRISes that don't expose staffing entities** rather
  than showing an empty list.
* **Surface `remote_url`.** Your users often want to confirm the position in the
  HRIS before committing to link it — a one-click deep link builds trust.

## Related reading

<CardGroup>
  <Card title="Staffing entities (feature)" icon="briefcase" href="/hris/features/staffing-entities">
    What staffing entities are, model types, and data structure.
  </Card>

  <Card title="Create employee (guide)" icon="user-plus" href="/hris/implementation-guide/create-employee">
    Base implementation guide for the dynamic employee form.
  </Card>

  <Card title="GET staffing entities" icon="list" href="/hris/v1/get-staffing-entities">
    API reference for fetching positions, requisitions, and jobs.
  </Card>

  <Card title="POST create employee with form" icon="user-plus" href="/hris/v1/post-employees-form">
    API reference for submitting the form.
  </Card>
</CardGroup>


# Important Changes
Source: https://docs.kombo.dev/hris/important-changes

Significant platform changes that may affect your integration.

<Update label="2026-07-21" description="Timesheet retention outside the sync window">
  ## Timesheets that age out of the sync window are no longer marked as deleted

  Kombo only keeps a rolling window of timesheets up to date during sync (default: the last **2 months**, configurable via the **"Historical timesheet months to sync"** setting). Previously, timesheets that fell outside that window were marked as deleted on the next full sync.

  **What changed:** Kombo now only deletion-tracks timesheets **inside** that window. Timesheets that age out of the window are **kept** and are not marked with `remote_deleted_at` just because they were not re-fetched. Within the window, timesheets that disappear from the remote HRIS are still marked as deleted as usual.

  ### Who is affected

  Anyone relying on timesheets outside the window receiving a `remote_deleted_at` value (or disappearing from default list responses) simply because they aged out of the re-fetch window.

  ### What you should do

  * Treat aging out of the window as **retention**, not deletion — do not expect those rows to be marked deleted.
  * If you need history beyond what you've kept up to date, configure a larger window upfront or archive timesheets on your side.
  * Contact Kombo support if you need the window changed for your environment (the setting is read-only in the dashboard).

  See the [Time & Attendance guide](/hris/features/time-and-attendance) and the [GET timesheets](/hris/v1/get-timesheets) endpoint for details.
</Update>

<Update label="2026-05-19" description="New HTTP status code for integration setup errors">
  ## Integration setup errors now return HTTP status code 409 instead of 503

  From **Tuesday, May 19, 2026**, the following [Kombo error codes](/guides/errors) will start returning **HTTP `409 Conflict`** instead of **HTTP `503 Service Unavailable`**:

  | Error code                                                                        | Meaning                                                      |
  | --------------------------------------------------------------------------------- | ------------------------------------------------------------ |
  | [`INTEGRATION.SETUP_INCOMPLETE`](/guides/errors#integration-setup_incomplete)     | The integration setup hasn't been finished yet.              |
  | [`INTEGRATION.SETUP_SYNC_PENDING`](/guides/errors#integration-setup_sync_pending) | The initial sync after connection is still running.          |
  | [`INTEGRATION.QA_FAILED`](/guides/errors#integration-qa_failed)                   | The integration's setup data didn't pass our quality checks. |

  We're making these changes in accordance with [our error handling best practices](/guides/errors#error-format) that we announced with the release of structured error codes in August 2025:

  Error handling logic on top of the Kombo API should, if available, **always make use of the `error.code` field** in the response, and **only** fall back to the HTTP status code if the `error.code` is not present (which should rarely happen).

  We're changing these specific codes because `409 Conflict` ([RFC 7231](https://www.rfc-editor.org/rfc/rfc7231#section-6.5.8)) matches the actual error state better. The `error.code` values themselves are **not changing**.

  ### What you should do

  Start by checking whether your implementation currently branches on the HTTP status code (`503` specifically, or `5xx` in general) when handling any of the three error codes above.

  * **If it doesn't, you're all set** and don't need to take any action.
  * **If it does**, please update that logic to rely on the `error.code` field instead of the HTTP status code, so it keeps behaving correctly once these errors start returning `409`.

  While you're at it, you may want to consider adding explicit handling for [`INTEGRATION.SETUP_INCOMPLETE`](/guides/errors#integration-setup_incomplete), [`INTEGRATION.SETUP_SYNC_PENDING`](/guides/errors#integration-setup_sync_pending), and [`INTEGRATION.QA_FAILED`](/guides/errors#integration-qa_failed) if you don't have it yet:

  * `INTEGRATION.SETUP_INCOMPLETE` and `INTEGRATION.QA_FAILED` should be surfaced to the affected end-customer or admin user because they usually require manual intervention.
  * `INTEGRATION.SETUP_SYNC_PENDING` resolves once the initial sync finishes, but initial syncs can take hours in some cases. We recommend relying on [webhooks](guides/webhooks) instead of retrying silently or polling aggressively.
</Update>

<Update label="2026-03-20" description="Concurrency limiting enforced">
  ## Action concurrency limiting is now enforced

  Kombo now enforces concurrency limits on action endpoints. Previously,
  concurrent requests were measured but not rejected. Now, when more than 30
  action requests are in flight simultaneously for a single integration,
  additional requests are rejected with HTTP `429` and the error code
  `PLATFORM.CONCURRENCY_LIMIT_EXCEEDED`.

  **Who is affected:** Customers sending many parallel action requests (e.g.,
  bulk-creating candidates or moving applications) may start receiving `429`
  responses they were not receiving before. Model read endpoints are not affected
  (e.g. `GET /ats/candidates`)

  **What to do:**

  * Handle the new `PLATFORM.CONCURRENCY_LIMIT_EXCEEDED` error code in your
    retry logic.
  * Use exponential backoff starting at \~1s.
  * Optionally, check the `Concurrency-Remaining` response header to throttle
    proactively.

  See the full [Concurrency Limiting](guides/concurrency-limiting) guide for
  details.
</Update>


# Introduction
Source: https://docs.kombo.dev/hris/introduction

Learn how to get started with Kombo's unified HRIS API.

Kombo's unified HRIS API allows reading data from and
writing data to [dozens of HRIS systems](https://www.kombo.dev/categories/hris)
through a single standardized interface.

Here are some resources to get you started:

<CardGroup>
  <Card title="Explore the API reference" icon="magnifying-glass" href="/hris/v1/get-employees">
    Explore what data you can read and write through our unified endpoints.
  </Card>

  <Card title="Set up your first integration" icon="link" href="/hris/getting-started">
    Understand how you can connect your first integration in a few minutes.
  </Card>

  <Card title="Official SDKs" icon="code" href="/libraries-and-sdks">
    Use our official SDKs for ergonomic and type-safe API interactions.
  </Card>
</CardGroup>


# Delete absence
Source: https://docs.kombo.dev/hris/v1/delete-absences-absence-id

DELETE /hris/absences/{absence_id}
Delete this absence.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/hris/connectors/personio">Personio</a></li>
    <li><img /><a href="/hris/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/hris/connectors/factorial">Factorial</a></li>
    <li><img /><a href="/hris/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/hris/connectors/hibob">HiBob</a></li>
    <li><img /><a href="/hris/connectors/deel">Deel</a></li>
    <li><img /><a href="/hris/connectors/sesamehr">Sesame HR</a></li>
    <li><img /><a href="/hris/connectors/hrworks">HR WORKS</a></li>
    <li><img /><a href="/hris/connectors/alexishr">AlexisHR</a></li>
    <li><img /><a href="/hris/connectors/simployer">Simployer</a></li>
    <li><img /><a href="/hris/connectors/absenceio">Absence.io</a></li>
    <li><img /><a href="/hris/connectors/sandbox">Kombo Sandbox</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

<Note>
  This endpoint requires the permission **Manage absences** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "absence_id": "wXJMxwDvPAjrJ4CyqdV9"
}
```


# Delete integration
Source: https://docs.kombo.dev/hris/v1/delete-integrations-integration-id

DELETE /integrations/{integration_id}
Delete the specified integration.

**⚠️ This can not be undone!**


# Get absence types
Source: https://docs.kombo.dev/hris/v1/get-absence-types

GET /hris/absence-types
Retrieve all absence types.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/hris/connectors/personio">Personio</a></li>
    <li><img /><a href="/hris/connectors/workday">Workday</a></li>
    <li><img /><a href="/hris/connectors/workdaycustomreport">Workday Custom Reports</a></li>
    <li><img /><a href="/hris/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/hris/connectors/factorial">Factorial</a></li>
    <li><img /><a href="/hris/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/hris/connectors/ukgready">UKG Ready</a></li>
    <li><img /><a href="/hris/connectors/adpworkforcenow">ADP Workforce Now</a></li>
    <li><img /><a href="/hris/connectors/adpdecidium">ADP Decidium</a></li>
    <li><img /><a href="/hris/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/hris/connectors/payfit">PayFit Legacy</a></li>
    <li><img /><a href="/hris/connectors/employmenthero">Employment Hero</a></li>
    <li><img /><a href="/hris/connectors/fourth">Fourth</a></li>
    <li><img /><a href="/hris/connectors/kenjo">Kenjo</a></li>
    <li><img /><a href="/hris/connectors/heavenhr">HeavenHR</a></li>
    <li><img /><a href="/hris/connectors/hibob">HiBob</a></li>
    <li><img /><a href="/hris/connectors/cezannehr">Cezanne HR</a></li>
    <li><img /><a href="/hris/connectors/deel">Deel</a></li>
    <li><img /><a href="/hris/connectors/remotecom">Remote</a></li>
    <li><img /><a href="/hris/connectors/iriscascade">IRIS Cascade</a></li>
    <li><img /><a href="/hris/connectors/sagehr">Sage HR</a></li>
    <li><img /><a href="/hris/connectors/humaans">Humaans</a></li>
    <li><img /><a href="/hris/connectors/eurecia">Eurécia</a></li>
    <li><img /><a href="/hris/connectors/oraclehcm">Oracle HCM</a></li>
    <li><img /><a href="/hris/connectors/officient">Officient</a></li>
    <li><img /><a href="/hris/connectors/sesamehr">Sesame HR</a></li>
    <li><img /><a href="/hris/connectors/charliehr">Charlie</a></li>
    <li><img /><a href="/hris/connectors/hrworks">HR WORKS</a></li>
    <li><img /><a href="/hris/connectors/zohopeople">Zoho People</a></li>
    <li><img /><a href="/hris/connectors/breathehr">Breathe HR</a></li>
    <li><img /><a href="/hris/connectors/alexishr">AlexisHR</a></li>
    <li><img /><a href="/hris/connectors/simployer">Simployer</a></li>
    <li><img /><a href="/hris/connectors/hoorayhr">HoorayHR</a></li>
    <li><img /><a href="/hris/connectors/trinet">TriNet (Zenefits)</a></li>
    <li><img /><a href="/hris/connectors/paycor">Paycor</a></li>
    <li><img /><a href="/hris/connectors/insperity">Insperity</a></li>
    <li><img /><a href="/hris/connectors/rippling">Rippling</a></li>
    <li><img /><a href="/hris/connectors/peoplehr">PeopleHR</a></li>
    <li><img /><a href="/hris/connectors/lucca">Lucca</a></li>
    <li><img /><a href="/hris/connectors/boondmanager">BoondManager</a></li>
    <li><img /><a href="/hris/connectors/perbilityhelix">Perbility Helix</a></li>
    <li><img /><a href="/hris/connectors/leapsome">Leapsome</a></li>
    <li><img /><a href="/hris/connectors/absenceio">Absence.io</a></li>
    <li><img /><a href="/hris/connectors/a3innuvanomina">a3innuva Nómina</a></li>
    <li><img /><a href="/hris/connectors/datevlauds">DATEV</a></li>
    <li><img /><a href="/hris/connectors/datev">DATEV LODAS</a></li>
    <li><img /><a href="/hris/connectors/datevlug">DATEV Lohn & Gehalt</a></li>
    <li><img /><a href="/hris/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/hris/connectors/sftp">SFTP</a></li>
    <li><img /><a href="/hris/connectors/sftpfetch">SFTP Fetch</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Get absences
Source: https://docs.kombo.dev/hris/v1/get-absences

GET /hris/absences
Retrieve all absences.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/hris/connectors/personio">Personio</a></li>
    <li><img /><a href="/hris/connectors/workday">Workday</a></li>
    <li><img /><a href="/hris/connectors/workdaycustomreport">Workday Custom Reports</a></li>
    <li><img /><a href="/hris/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/hris/connectors/factorial">Factorial</a></li>
    <li><img /><a href="/hris/connectors/ukgready">UKG Ready</a></li>
    <li><img /><a href="/hris/connectors/adpworkforcenow">ADP Workforce Now</a></li>
    <li><img /><a href="/hris/connectors/adpdecidium">ADP Decidium</a></li>
    <li><img /><a href="/hris/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/hris/connectors/payfit">PayFit Legacy</a></li>
    <li><img /><a href="/hris/connectors/employmenthero">Employment Hero</a></li>
    <li><img /><a href="/hris/connectors/fourth">Fourth</a></li>
    <li><img /><a href="/hris/connectors/kenjo">Kenjo</a></li>
    <li><img /><a href="/hris/connectors/heavenhr">HeavenHR</a></li>
    <li><img /><a href="/hris/connectors/hibob">HiBob</a></li>
    <li><img /><a href="/hris/connectors/cezannehr">Cezanne HR</a></li>
    <li><img /><a href="/hris/connectors/deel">Deel</a></li>
    <li><img /><a href="/hris/connectors/remotecom">Remote</a></li>
    <li><img /><a href="/hris/connectors/iriscascade">IRIS Cascade</a></li>
    <li><img /><a href="/hris/connectors/sagehr">Sage HR</a></li>
    <li><img /><a href="/hris/connectors/humaans">Humaans</a></li>
    <li><img /><a href="/hris/connectors/eurecia">Eurécia</a></li>
    <li><img /><a href="/hris/connectors/oraclehcm">Oracle HCM</a></li>
    <li><img /><a href="/hris/connectors/officient">Officient</a></li>
    <li><img /><a href="/hris/connectors/sesamehr">Sesame HR</a></li>
    <li><img /><a href="/hris/connectors/charliehr">Charlie</a></li>
    <li><img /><a href="/hris/connectors/hrworks">HR WORKS</a></li>
    <li><img /><a href="/hris/connectors/zohopeople">Zoho People</a></li>
    <li><img /><a href="/hris/connectors/breathehr">Breathe HR</a></li>
    <li><img /><a href="/hris/connectors/alexishr">AlexisHR</a></li>
    <li><img /><a href="/hris/connectors/simployer">Simployer</a></li>
    <li><img /><a href="/hris/connectors/hoorayhr">HoorayHR</a></li>
    <li><img /><a href="/hris/connectors/trinet">TriNet (Zenefits)</a></li>
    <li><img /><a href="/hris/connectors/paycor">Paycor</a></li>
    <li><img /><a href="/hris/connectors/rippling">Rippling</a></li>
    <li><img /><a href="/hris/connectors/peoplehr">PeopleHR</a></li>
    <li><img /><a href="/hris/connectors/lucca">Lucca</a></li>
    <li><img /><a href="/hris/connectors/boondmanager">BoondManager</a></li>
    <li><img /><a href="/hris/connectors/haileyhr">Hailey HR</a></li>
    <li><img /><a href="/hris/connectors/perbilityhelix">Perbility Helix</a></li>
    <li><img /><a href="/hris/connectors/leapsome">Leapsome</a></li>
    <li><img /><a href="/hris/connectors/absenceio">Absence.io</a></li>
    <li><img /><a href="/hris/connectors/a3innuvanomina">a3innuva Nómina</a></li>
    <li><img /><a href="/hris/connectors/datevlauds">DATEV</a></li>
    <li><img /><a href="/hris/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/hris/connectors/sftp">SFTP</a></li>
    <li><img /><a href="/hris/connectors/sftpfetch">SFTP Fetch</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Check API key
Source: https://docs.kombo.dev/hris/v1/get-check-api-key

GET /check-api-key
Check whether your API key is working properly.



# Get integration by token
Source: https://docs.kombo.dev/hris/v1/get-connect-integration-by-token-token

GET /connect/integration-by-token/{token}
Use this endpoint with the token you get from the connection flow to retrieve information about the created integration.

It works in a similar way as the OAuth2 code flow to securely retrieve information and connect the integration to your user.

> Check out [our full guide](/connect/embedded-flow) for more details about implementing the connection flow into your app.

This endpoint is used to ensure users can't trick your system connecting their
account in your system to another customers integration. You don't get the integration ID
from the `showKomboConnect(link)` function but only the short lived token used
for this endpoint so that users can't send you arbitrary data that you would put
into your system.


# Get available health insurers from DATEV.
Source: https://docs.kombo.dev/hris/v1/get-custom-datev-health-insurances

GET /custom/datev/health-insurances
This endpoint returns all available health insurers for the given integration. This list can be customized by the DATEV user. It is only available for the DATEV LAUDS variant.



# Get available salary types (Lohnarten) from DATEV.
Source: https://docs.kombo.dev/hris/v1/get-custom-datev-salary-types

GET /custom/datev/salary-types
This endpoint returns all available salary types for the given integration. This list can be customized by the DATEV user. It is only available for the DATEV LAUDS variant.



# Retrieve available documents
Source: https://docs.kombo.dev/hris/v1/get-datev-available-documents

GET /custom/datev/available-documents
Use this endpoint to get all available documents for a specific period.



# Verify service is enabled
Source: https://docs.kombo.dev/hris/v1/get-datev-check-document-permission

GET /custom/datev/check-document-permission
This endpoint returns the available document types for this DATEV integration.



# Verify service is enabled
Source: https://docs.kombo.dev/hris/v1/get-datev-check-eau-permission

GET /custom/datev/check-eau-permission
This endpoint validates that this DATEV integration is ready to use the eAU feature.



# Verify ASCII write is enabled
Source: https://docs.kombo.dev/hris/v1/get-datev-check-write-permission

GET /custom/datev/check-write-permission
This endpoint returns whether DATEV's Lohnimportdatenservice is enabled, which is the service required to submit [ASCII files](/hris/v1/post-datev-passthrough). It works for both DATEV HR and DATEV LAUDS integrations.

<Note>This check says nothing about JSON writes through the [LAUDS API](/hris/v1/post-passthrough-tool-api). Those go through the Lohnaustauschdatenservice that every DATEV LAUDS integration connects with, so they are always available on DATEV LAUDS.</Note>


# Get DATEV data pushes
Source: https://docs.kombo.dev/hris/v1/get-datev-data-pushes

GET /custom/datev/data-pushes
Returns all "DATEV Data Pushes" of the last 2 months. You can use this endpoint to give your users transparency about submitted "ASCII-Files" and their status. Each data push can contain multiple files that were submitted.



# Query the status of the eAU request
Source: https://docs.kombo.dev/hris/v1/get-datev-eau-requests-eau-id

GET /custom/datev/eau-requests/{eau_id}
This endpoint queries the status of the eAU request for the given DATEV integration.



# Get DATEV system information
Source: https://docs.kombo.dev/hris/v1/get-datev-system-information

GET /custom/datev/system-information
This endpoint returns BeraterNr (consultant_number), MandantenNr (client_number) and the payroll system (LODAS or Lohn und Gehalt). Useful to generate a DATEV ASCII file for the passthrough endpoint.



# Get employee document categories
Source: https://docs.kombo.dev/hris/v1/get-employee-document-categories

GET /hris/employee-document-categories
Get employee document categories.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/hris/connectors/personio">Personio</a></li>
    <li><img /><a href="/hris/connectors/workday">Workday</a></li>
    <li><img /><a href="/hris/connectors/afas">AFAS Software</a></li>
    <li><img /><a href="/hris/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/hris/connectors/hibob">HiBob</a></li>
    <li><img /><a href="/hris/connectors/nmbrs">Nmbrs</a></li>
    <li><img /><a href="/hris/connectors/sagehr">Sage HR</a></li>
    <li><img /><a href="/hris/connectors/hrworks">HR WORKS</a></li>
    <li><img /><a href="/hris/connectors/youserve">Visma YouServe</a></li>
    <li><img /><a href="/hris/connectors/hansalog">Hansalog</a></li>
    <li><img /><a href="/hris/connectors/hr4you">HR4YOU</a></li>
    <li><img /><a href="/hris/connectors/sdworx">SD Worx</a></li>
    <li><img /><a href="/hris/connectors/sftp">SFTP</a></li>
    <li><img /><a href="/hris/connectors/sftpfetch">SFTP Fetch</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Get employees
Source: https://docs.kombo.dev/hris/v1/get-employees

GET /hris/employees
Retrieve all employees.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/hris/connectors/personio">Personio</a></li>
    <li><img /><a href="/hris/connectors/workday">Workday</a></li>
    <li><img /><a href="/hris/connectors/workdaycustomreport">Workday Custom Reports</a></li>
    <li><img /><a href="/hris/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/hris/connectors/factorial">Factorial</a></li>
    <li><img /><a href="/hris/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/hris/connectors/ukgprowfm">UKG Pro WFM</a></li>
    <li><img /><a href="/hris/connectors/ukgready">UKG Ready</a></li>
    <li><img /><a href="/hris/connectors/adpworkforcenow">ADP Workforce Now</a></li>
    <li><img /><a href="/hris/connectors/adpdecidium">ADP Decidium</a></li>
    <li><img /><a href="/hris/connectors/rexx">rexx systems</a></li>
    <li><img /><a href="/hris/connectors/afas">AFAS Software</a></li>
    <li><img /><a href="/hris/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/hris/connectors/payfitcustomer">PayFit Customer</a></li>
    <li><img /><a href="/hris/connectors/payfitpartner">PayFit Partner</a></li>
    <li><img /><a href="/hris/connectors/payfit">PayFit Legacy</a></li>
    <li><img /><a href="/hris/connectors/employmenthero">Employment Hero</a></li>
    <li><img /><a href="/hris/connectors/fourth">Fourth</a></li>
    <li><img /><a href="/hris/connectors/kenjo">Kenjo</a></li>
    <li><img /><a href="/hris/connectors/heavenhr">HeavenHR</a></li>
    <li><img /><a href="/hris/connectors/hibob">HiBob</a></li>
    <li><img /><a href="/hris/connectors/cezannehr">Cezanne HR</a></li>
    <li><img /><a href="/hris/connectors/entraid">Microsoft Entra ID</a></li>
    <li><img /><a href="/hris/connectors/azuread">Microsoft Azure AD</a></li>
    <li><img /><a href="/hris/connectors/googleworkspace">Google Workspace</a></li>
    <li><img /><a href="/hris/connectors/nmbrs">Nmbrs</a></li>
    <li><img /><a href="/hris/connectors/deel">Deel</a></li>
    <li><img /><a href="/hris/connectors/remotecom">Remote</a></li>
    <li><img /><a href="/hris/connectors/iriscascade">IRIS Cascade</a></li>
    <li><img /><a href="/hris/connectors/okta">Okta</a></li>
    <li><img /><a href="/hris/connectors/sagehr">Sage HR</a></li>
    <li><img /><a href="/hris/connectors/sagepeople">Sage People</a></li>
    <li><img /><a href="/hris/connectors/humaans">Humaans</a></li>
    <li><img /><a href="/hris/connectors/eurecia">Eurécia</a></li>
    <li><img /><a href="/hris/connectors/oraclehcm">Oracle HCM</a></li>
    <li><img /><a href="/hris/connectors/officient">Officient</a></li>
    <li><img /><a href="/hris/connectors/sesamehr">Sesame HR</a></li>
    <li><img /><a href="/hris/connectors/charliehr">Charlie</a></li>
    <li><img /><a href="/hris/connectors/hrworks">HR WORKS</a></li>
    <li><img /><a href="/hris/connectors/abacus">Abacus</a></li>
    <li><img /><a href="/hris/connectors/zohopeople">Zoho People</a></li>
    <li><img /><a href="/hris/connectors/gusto">Gusto</a></li>
    <li><img /><a href="/hris/connectors/breathehr">Breathe HR</a></li>
    <li><img /><a href="/hris/connectors/catalystone">CatalystOne</a></li>
    <li><img /><a href="/hris/connectors/mirus">Mirus</a></li>
    <li><img /><a href="/hris/connectors/alexishr">AlexisHR</a></li>
    <li><img /><a href="/hris/connectors/simployer">Simployer</a></li>
    <li><img /><a href="/hris/connectors/peple">Visma Peple</a></li>
    <li><img /><a href="/hris/connectors/youserve">Visma YouServe</a></li>
    <li><img /><a href="/hris/connectors/dayforce">Dayforce</a></li>
    <li><img /><a href="/hris/connectors/hansalog">Hansalog</a></li>
    <li><img /><a href="/hris/connectors/lattice">Lattice</a></li>
    <li><img /><a href="/hris/connectors/latticetalent">Lattice Talent</a></li>
    <li><img /><a href="/hris/connectors/hoorayhr">HoorayHR</a></li>
    <li><img /><a href="/hris/connectors/trinet">TriNet (Zenefits)</a></li>
    <li><img /><a href="/hris/connectors/trinetpeo">TriNet PEO</a></li>
    <li><img /><a href="/hris/connectors/paylocity">Paylocity</a></li>
    <li><img /><a href="/hris/connectors/paycor">Paycor</a></li>
    <li><img /><a href="/hris/connectors/namely">Namely</a></li>
    <li><img /><a href="/hris/connectors/paycom">Paycom</a></li>
    <li><img /><a href="/hris/connectors/insperity">Insperity</a></li>
    <li><img /><a href="/hris/connectors/paychex">Paychex</a></li>
    <li><img /><a href="/hris/connectors/rippling">Rippling</a></li>
    <li><img /><a href="/hris/connectors/sapling">Kallidus (Sapling)</a></li>
    <li><img /><a href="/hris/connectors/peoplehr">PeopleHR</a></li>
    <li><img /><a href="/hris/connectors/lucca">Lucca</a></li>
    <li><img /><a href="/hris/connectors/zelt">Zelt</a></li>
    <li><img /><a href="/hris/connectors/planday">Planday</a></li>
    <li><img /><a href="/hris/connectors/boondmanager">BoondManager</a></li>
    <li><img /><a href="/hris/connectors/haileyhr">Hailey HR</a></li>
    <li><img /><a href="/hris/connectors/oysterhr">OysterHR</a></li>
    <li><img /><a href="/hris/connectors/kiwihr">Tellent HR</a></li>
    <li><img /><a href="/hris/connectors/hr4you">HR4YOU</a></li>
    <li><img /><a href="/hris/connectors/cornerstoneondemand">Cornerstone OnDemand</a></li>
    <li><img /><a href="/hris/connectors/square">Square</a></li>
    <li><img /><a href="/hris/connectors/perbilityhelix">Perbility Helix</a></li>
    <li><img /><a href="/hris/connectors/leapsome">Leapsome</a></li>
    <li><img /><a href="/hris/connectors/loket">Loket</a></li>
    <li><img /><a href="/hris/connectors/workforcecom">workforce.com</a></li>
    <li><img /><a href="/hris/connectors/peoplefirst">MHR People First</a></li>
    <li><img /><a href="/hris/connectors/sdworx">SD Worx</a></li>
    <li><img /><a href="/hris/connectors/itrent">iTrent</a></li>
    <li><img /><a href="/hris/connectors/absenceio">Absence.io</a></li>
    <li><img /><a href="/hris/connectors/a3innuvanomina">a3innuva Nómina</a></li>
    <li><img /><a href="/hris/connectors/scim">SCIM</a></li>
    <li><img /><a href="/hris/connectors/datevlauds">DATEV</a></li>
    <li><img /><a href="/hris/connectors/datevhr">DATEV HR</a></li>
    <li><img /><a href="/hris/connectors/sympa">Sympa</a></li>
    <li><img /><a href="/hris/connectors/youforce">Visma Raet - Youforce</a></li>
    <li><img /><a href="/hris/connectors/nibelis">Nibelis</a></li>
    <li><img /><a href="/hris/connectors/peoplexd">PeopleXD</a></li>
    <li><img /><a href="/hris/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/hris/connectors/sftp">SFTP</a></li>
    <li><img /><a href="/hris/connectors/sftpfetch">SFTP Fetch</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

<Note>Not interested in most fields? You can use our [our Scopes feature](/scopes) to customize what data points are synced.</Note>

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Get employee form
Source: https://docs.kombo.dev/hris/v1/get-employees-form

GET /hris/employees/form
Get the form for creating an employee. This form can be rendered dynamically on your frontend to allow your customers to create employees in their HRIS.

Follow our [create employee guide here](/hris/features/create-employee) to learn how this form is generated and how you can use it.
The usage and impact of the staffing\_entity\_id parameter is described in the our [Create Employee Form with Staffing Entities guide](/hris/implementation-guide/staffing-entities-in-create-employee).

### Example Form

```json theme={null}
{
  "properties": {
    "firstName": {
      "type": "text",
      "label": "First Name",
      "required": true,
      "description": "Employee's first name",
      "unified_key": "first_name",
      "min_length": 1,
      "max_length": 100
    },
    "startDate": {
      "type": "date",
      "label": "Start Date",
      "required": true,
      "description": "Employee's start date",
      "unified_key": "start_date"
    },
    "workLocation": {
      "type": "object",
      "label": "Work Location",
      "required": false,
      "description": "Employee's work location",
      "unified_key": null,
      "properties": {
        "site": {
          "type": "single_select",
          "label": "Site",
          "required": true,
          "description": "Employee's site",
          "unified_key": null,
          "options": {
            "type": "inline",
            "entries": [
              {
                "label": "Site 1",
                "id": "FXrER44xubBqA9DLgZ3PFNNx",
                "unified_value": "1",
                "remote_id": "site_1"
              },
              {
                "label": "Site 2",
                "id": "2rv75UKT2XBoQXsUb9agiTUm",
                "unified_value": "2",
                "remote_id": "site_2"
              }
            ]
          }
        },
        "keyNumbers": {
          "type": "array",
          "label": "Key Numbers",
          "required": false,
          "description": "Employee's key numbers",
          "unified_key": null,
          "min_items": 2,
          "max_items": 5,
          "item_type": {
            "type": "number",
            "label": "Key Number",
            "required": false,
            "description": "The number of the keys which belong to the employee",
            "unified_key": null,
            "min": 0,
            "max": 99
          }
        }
      }
    }
  }
}
```


# Get employments
Source: https://docs.kombo.dev/hris/v1/get-employments

GET /hris/employments
Retrieve all employments.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/hris/connectors/personio">Personio</a></li>
    <li><img /><a href="/hris/connectors/workday">Workday</a></li>
    <li><img /><a href="/hris/connectors/workdaycustomreport">Workday Custom Reports</a></li>
    <li><img /><a href="/hris/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/hris/connectors/factorial">Factorial</a></li>
    <li><img /><a href="/hris/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/hris/connectors/ukgready">UKG Ready</a></li>
    <li><img /><a href="/hris/connectors/adpworkforcenow">ADP Workforce Now</a></li>
    <li><img /><a href="/hris/connectors/adpdecidium">ADP Decidium</a></li>
    <li><img /><a href="/hris/connectors/afas">AFAS Software</a></li>
    <li><img /><a href="/hris/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/hris/connectors/payfitcustomer">PayFit Customer</a></li>
    <li><img /><a href="/hris/connectors/payfitpartner">PayFit Partner</a></li>
    <li><img /><a href="/hris/connectors/payfit">PayFit Legacy</a></li>
    <li><img /><a href="/hris/connectors/employmenthero">Employment Hero</a></li>
    <li><img /><a href="/hris/connectors/fourth">Fourth</a></li>
    <li><img /><a href="/hris/connectors/kenjo">Kenjo</a></li>
    <li><img /><a href="/hris/connectors/heavenhr">HeavenHR</a></li>
    <li><img /><a href="/hris/connectors/hibob">HiBob</a></li>
    <li><img /><a href="/hris/connectors/cezannehr">Cezanne HR</a></li>
    <li><img /><a href="/hris/connectors/nmbrs">Nmbrs</a></li>
    <li><img /><a href="/hris/connectors/deel">Deel</a></li>
    <li><img /><a href="/hris/connectors/remotecom">Remote</a></li>
    <li><img /><a href="/hris/connectors/iriscascade">IRIS Cascade</a></li>
    <li><img /><a href="/hris/connectors/sagehr">Sage HR</a></li>
    <li><img /><a href="/hris/connectors/sagepeople">Sage People</a></li>
    <li><img /><a href="/hris/connectors/humaans">Humaans</a></li>
    <li><img /><a href="/hris/connectors/eurecia">Eurécia</a></li>
    <li><img /><a href="/hris/connectors/oraclehcm">Oracle HCM</a></li>
    <li><img /><a href="/hris/connectors/officient">Officient</a></li>
    <li><img /><a href="/hris/connectors/sesamehr">Sesame HR</a></li>
    <li><img /><a href="/hris/connectors/charliehr">Charlie</a></li>
    <li><img /><a href="/hris/connectors/hrworks">HR WORKS</a></li>
    <li><img /><a href="/hris/connectors/gusto">Gusto</a></li>
    <li><img /><a href="/hris/connectors/breathehr">Breathe HR</a></li>
    <li><img /><a href="/hris/connectors/catalystone">CatalystOne</a></li>
    <li><img /><a href="/hris/connectors/alexishr">AlexisHR</a></li>
    <li><img /><a href="/hris/connectors/simployer">Simployer</a></li>
    <li><img /><a href="/hris/connectors/peple">Visma Peple</a></li>
    <li><img /><a href="/hris/connectors/youserve">Visma YouServe</a></li>
    <li><img /><a href="/hris/connectors/dayforce">Dayforce</a></li>
    <li><img /><a href="/hris/connectors/lattice">Lattice</a></li>
    <li><img /><a href="/hris/connectors/hoorayhr">HoorayHR</a></li>
    <li><img /><a href="/hris/connectors/trinet">TriNet (Zenefits)</a></li>
    <li><img /><a href="/hris/connectors/trinetpeo">TriNet PEO</a></li>
    <li><img /><a href="/hris/connectors/paylocity">Paylocity</a></li>
    <li><img /><a href="/hris/connectors/paycor">Paycor</a></li>
    <li><img /><a href="/hris/connectors/namely">Namely</a></li>
    <li><img /><a href="/hris/connectors/paycom">Paycom</a></li>
    <li><img /><a href="/hris/connectors/insperity">Insperity</a></li>
    <li><img /><a href="/hris/connectors/paychex">Paychex</a></li>
    <li><img /><a href="/hris/connectors/rippling">Rippling</a></li>
    <li><img /><a href="/hris/connectors/sapling">Kallidus (Sapling)</a></li>
    <li><img /><a href="/hris/connectors/peoplehr">PeopleHR</a></li>
    <li><img /><a href="/hris/connectors/lucca">Lucca</a></li>
    <li><img /><a href="/hris/connectors/zelt">Zelt</a></li>
    <li><img /><a href="/hris/connectors/boondmanager">BoondManager</a></li>
    <li><img /><a href="/hris/connectors/haileyhr">Hailey HR</a></li>
    <li><img /><a href="/hris/connectors/oysterhr">OysterHR</a></li>
    <li><img /><a href="/hris/connectors/hr4you">HR4YOU</a></li>
    <li><img /><a href="/hris/connectors/cornerstoneondemand">Cornerstone OnDemand</a></li>
    <li><img /><a href="/hris/connectors/square">Square</a></li>
    <li><img /><a href="/hris/connectors/perbilityhelix">Perbility Helix</a></li>
    <li><img /><a href="/hris/connectors/leapsome">Leapsome</a></li>
    <li><img /><a href="/hris/connectors/loket">Loket</a></li>
    <li><img /><a href="/hris/connectors/workforcecom">workforce.com</a></li>
    <li><img /><a href="/hris/connectors/peoplefirst">MHR People First</a></li>
    <li><img /><a href="/hris/connectors/sdworx">SD Worx</a></li>
    <li><img /><a href="/hris/connectors/itrent">iTrent</a></li>
    <li><img /><a href="/hris/connectors/a3innuvanomina">a3innuva Nómina</a></li>
    <li><img /><a href="/hris/connectors/datevlauds">DATEV</a></li>
    <li><img /><a href="/hris/connectors/datevhr">DATEV HR</a></li>
    <li><img /><a href="/hris/connectors/sympa">Sympa</a></li>
    <li><img /><a href="/hris/connectors/youforce">Visma Raet - Youforce</a></li>
    <li><img /><a href="/hris/connectors/nibelis">Nibelis</a></li>
    <li><img /><a href="/hris/connectors/peoplexd">PeopleXD</a></li>
    <li><img /><a href="/hris/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/hris/connectors/sftp">SFTP</a></li>
    <li><img /><a href="/hris/connectors/sftpfetch">SFTP Fetch</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Get groups
Source: https://docs.kombo.dev/hris/v1/get-groups

GET /hris/groups
Retrieve all "groups" (teams, departments, and cost centers).

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/hris/connectors/personio">Personio</a></li>
    <li><img /><a href="/hris/connectors/workday">Workday</a></li>
    <li><img /><a href="/hris/connectors/workdaycustomreport">Workday Custom Reports</a></li>
    <li><img /><a href="/hris/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/hris/connectors/factorial">Factorial</a></li>
    <li><img /><a href="/hris/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/hris/connectors/ukgprowfm">UKG Pro WFM</a></li>
    <li><img /><a href="/hris/connectors/ukgready">UKG Ready</a></li>
    <li><img /><a href="/hris/connectors/adpworkforcenow">ADP Workforce Now</a></li>
    <li><img /><a href="/hris/connectors/adpdecidium">ADP Decidium</a></li>
    <li><img /><a href="/hris/connectors/afas">AFAS Software</a></li>
    <li><img /><a href="/hris/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/hris/connectors/payfitcustomer">PayFit Customer</a></li>
    <li><img /><a href="/hris/connectors/payfitpartner">PayFit Partner</a></li>
    <li><img /><a href="/hris/connectors/payfit">PayFit Legacy</a></li>
    <li><img /><a href="/hris/connectors/employmenthero">Employment Hero</a></li>
    <li><img /><a href="/hris/connectors/fourth">Fourth</a></li>
    <li><img /><a href="/hris/connectors/kenjo">Kenjo</a></li>
    <li><img /><a href="/hris/connectors/heavenhr">HeavenHR</a></li>
    <li><img /><a href="/hris/connectors/hibob">HiBob</a></li>
    <li><img /><a href="/hris/connectors/cezannehr">Cezanne HR</a></li>
    <li><img /><a href="/hris/connectors/entraid">Microsoft Entra ID</a></li>
    <li><img /><a href="/hris/connectors/azuread">Microsoft Azure AD</a></li>
    <li><img /><a href="/hris/connectors/googleworkspace">Google Workspace</a></li>
    <li><img /><a href="/hris/connectors/nmbrs">Nmbrs</a></li>
    <li><img /><a href="/hris/connectors/deel">Deel</a></li>
    <li><img /><a href="/hris/connectors/remotecom">Remote</a></li>
    <li><img /><a href="/hris/connectors/iriscascade">IRIS Cascade</a></li>
    <li><img /><a href="/hris/connectors/okta">Okta</a></li>
    <li><img /><a href="/hris/connectors/sagehr">Sage HR</a></li>
    <li><img /><a href="/hris/connectors/sagepeople">Sage People</a></li>
    <li><img /><a href="/hris/connectors/humaans">Humaans</a></li>
    <li><img /><a href="/hris/connectors/eurecia">Eurécia</a></li>
    <li><img /><a href="/hris/connectors/oraclehcm">Oracle HCM</a></li>
    <li><img /><a href="/hris/connectors/officient">Officient</a></li>
    <li><img /><a href="/hris/connectors/sesamehr">Sesame HR</a></li>
    <li><img /><a href="/hris/connectors/charliehr">Charlie</a></li>
    <li><img /><a href="/hris/connectors/hrworks">HR WORKS</a></li>
    <li><img /><a href="/hris/connectors/abacus">Abacus</a></li>
    <li><img /><a href="/hris/connectors/zohopeople">Zoho People</a></li>
    <li><img /><a href="/hris/connectors/gusto">Gusto</a></li>
    <li><img /><a href="/hris/connectors/breathehr">Breathe HR</a></li>
    <li><img /><a href="/hris/connectors/catalystone">CatalystOne</a></li>
    <li><img /><a href="/hris/connectors/mirus">Mirus</a></li>
    <li><img /><a href="/hris/connectors/alexishr">AlexisHR</a></li>
    <li><img /><a href="/hris/connectors/simployer">Simployer</a></li>
    <li><img /><a href="/hris/connectors/peple">Visma Peple</a></li>
    <li><img /><a href="/hris/connectors/youserve">Visma YouServe</a></li>
    <li><img /><a href="/hris/connectors/dayforce">Dayforce</a></li>
    <li><img /><a href="/hris/connectors/hansalog">Hansalog</a></li>
    <li><img /><a href="/hris/connectors/lattice">Lattice</a></li>
    <li><img /><a href="/hris/connectors/latticetalent">Lattice Talent</a></li>
    <li><img /><a href="/hris/connectors/hoorayhr">HoorayHR</a></li>
    <li><img /><a href="/hris/connectors/trinet">TriNet (Zenefits)</a></li>
    <li><img /><a href="/hris/connectors/trinetpeo">TriNet PEO</a></li>
    <li><img /><a href="/hris/connectors/paylocity">Paylocity</a></li>
    <li><img /><a href="/hris/connectors/paycor">Paycor</a></li>
    <li><img /><a href="/hris/connectors/namely">Namely</a></li>
    <li><img /><a href="/hris/connectors/paycom">Paycom</a></li>
    <li><img /><a href="/hris/connectors/insperity">Insperity</a></li>
    <li><img /><a href="/hris/connectors/paychex">Paychex</a></li>
    <li><img /><a href="/hris/connectors/rippling">Rippling</a></li>
    <li><img /><a href="/hris/connectors/sapling">Kallidus (Sapling)</a></li>
    <li><img /><a href="/hris/connectors/peoplehr">PeopleHR</a></li>
    <li><img /><a href="/hris/connectors/lucca">Lucca</a></li>
    <li><img /><a href="/hris/connectors/zelt">Zelt</a></li>
    <li><img /><a href="/hris/connectors/planday">Planday</a></li>
    <li><img /><a href="/hris/connectors/boondmanager">BoondManager</a></li>
    <li><img /><a href="/hris/connectors/haileyhr">Hailey HR</a></li>
    <li><img /><a href="/hris/connectors/oysterhr">OysterHR</a></li>
    <li><img /><a href="/hris/connectors/kiwihr">Tellent HR</a></li>
    <li><img /><a href="/hris/connectors/hr4you">HR4YOU</a></li>
    <li><img /><a href="/hris/connectors/cornerstoneondemand">Cornerstone OnDemand</a></li>
    <li><img /><a href="/hris/connectors/perbilityhelix">Perbility Helix</a></li>
    <li><img /><a href="/hris/connectors/leapsome">Leapsome</a></li>
    <li><img /><a href="/hris/connectors/loket">Loket</a></li>
    <li><img /><a href="/hris/connectors/workforcecom">workforce.com</a></li>
    <li><img /><a href="/hris/connectors/peoplefirst">MHR People First</a></li>
    <li><img /><a href="/hris/connectors/sdworx">SD Worx</a></li>
    <li><img /><a href="/hris/connectors/itrent">iTrent</a></li>
    <li><img /><a href="/hris/connectors/absenceio">Absence.io</a></li>
    <li><img /><a href="/hris/connectors/scim">SCIM</a></li>
    <li><img /><a href="/hris/connectors/datevlauds">DATEV</a></li>
    <li><img /><a href="/hris/connectors/datevhr">DATEV HR</a></li>
    <li><img /><a href="/hris/connectors/sympa">Sympa</a></li>
    <li><img /><a href="/hris/connectors/youforce">Visma Raet - Youforce</a></li>
    <li><img /><a href="/hris/connectors/peoplexd">PeopleXD</a></li>
    <li><img /><a href="/hris/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/hris/connectors/sftp">SFTP</a></li>
    <li><img /><a href="/hris/connectors/sftpfetch">SFTP Fetch</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Get integration details
Source: https://docs.kombo.dev/hris/v1/get-integrations-integration-id

GET /integrations/{integration_id}
Get the specified integration with everything you need to display it to your customer.



# Get custom fields with current mappings
Source: https://docs.kombo.dev/hris/v1/get-integrations-integration-id-custom-fields

GET /integrations/{integration_id}/custom-fields
Get all custom fields available on the specified integration.

\**This includes the mapping to the corresponding integration field if applicable*


# Get integration fields
Source: https://docs.kombo.dev/hris/v1/get-integrations-integration-id-integration-fields

GET /integrations/{integration_id}/integration-fields
Get all fields available on the specified integration.

**This includes the mapping to your custom fields**


# Get legal entities
Source: https://docs.kombo.dev/hris/v1/get-legal-entities

GET /hris/legal-entities
Retrieve all legal entites.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/hris/connectors/personio">Personio</a></li>
    <li><img /><a href="/hris/connectors/workday">Workday</a></li>
    <li><img /><a href="/hris/connectors/workdaycustomreport">Workday Custom Reports</a></li>
    <li><img /><a href="/hris/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/hris/connectors/factorial">Factorial</a></li>
    <li><img /><a href="/hris/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/hris/connectors/ukgprowfm">UKG Pro WFM</a></li>
    <li><img /><a href="/hris/connectors/ukgready">UKG Ready</a></li>
    <li><img /><a href="/hris/connectors/adpworkforcenow">ADP Workforce Now</a></li>
    <li><img /><a href="/hris/connectors/adpdecidium">ADP Decidium</a></li>
    <li><img /><a href="/hris/connectors/payfitcustomer">PayFit Customer</a></li>
    <li><img /><a href="/hris/connectors/payfitpartner">PayFit Partner</a></li>
    <li><img /><a href="/hris/connectors/payfit">PayFit Legacy</a></li>
    <li><img /><a href="/hris/connectors/employmenthero">Employment Hero</a></li>
    <li><img /><a href="/hris/connectors/kenjo">Kenjo</a></li>
    <li><img /><a href="/hris/connectors/heavenhr">HeavenHR</a></li>
    <li><img /><a href="/hris/connectors/cezannehr">Cezanne HR</a></li>
    <li><img /><a href="/hris/connectors/entraid">Microsoft Entra ID</a></li>
    <li><img /><a href="/hris/connectors/azuread">Microsoft Azure AD</a></li>
    <li><img /><a href="/hris/connectors/nmbrs">Nmbrs</a></li>
    <li><img /><a href="/hris/connectors/deel">Deel</a></li>
    <li><img /><a href="/hris/connectors/okta">Okta</a></li>
    <li><img /><a href="/hris/connectors/sagepeople">Sage People</a></li>
    <li><img /><a href="/hris/connectors/humaans">Humaans</a></li>
    <li><img /><a href="/hris/connectors/oraclehcm">Oracle HCM</a></li>
    <li><img /><a href="/hris/connectors/charliehr">Charlie</a></li>
    <li><img /><a href="/hris/connectors/abacus">Abacus</a></li>
    <li><img /><a href="/hris/connectors/gusto">Gusto</a></li>
    <li><img /><a href="/hris/connectors/breathehr">Breathe HR</a></li>
    <li><img /><a href="/hris/connectors/alexishr">AlexisHR</a></li>
    <li><img /><a href="/hris/connectors/simployer">Simployer</a></li>
    <li><img /><a href="/hris/connectors/youserve">Visma YouServe</a></li>
    <li><img /><a href="/hris/connectors/hansalog">Hansalog</a></li>
    <li><img /><a href="/hris/connectors/trinet">TriNet (Zenefits)</a></li>
    <li><img /><a href="/hris/connectors/paylocity">Paylocity</a></li>
    <li><img /><a href="/hris/connectors/paycor">Paycor</a></li>
    <li><img /><a href="/hris/connectors/namely">Namely</a></li>
    <li><img /><a href="/hris/connectors/paycom">Paycom</a></li>
    <li><img /><a href="/hris/connectors/insperity">Insperity</a></li>
    <li><img /><a href="/hris/connectors/paychex">Paychex</a></li>
    <li><img /><a href="/hris/connectors/peoplehr">PeopleHR</a></li>
    <li><img /><a href="/hris/connectors/lucca">Lucca</a></li>
    <li><img /><a href="/hris/connectors/boondmanager">BoondManager</a></li>
    <li><img /><a href="/hris/connectors/haileyhr">Hailey HR</a></li>
    <li><img /><a href="/hris/connectors/oysterhr">OysterHR</a></li>
    <li><img /><a href="/hris/connectors/hr4you">HR4YOU</a></li>
    <li><img /><a href="/hris/connectors/loket">Loket</a></li>
    <li><img /><a href="/hris/connectors/peoplefirst">MHR People First</a></li>
    <li><img /><a href="/hris/connectors/sdworx">SD Worx</a></li>
    <li><img /><a href="/hris/connectors/a3innuvanomina">a3innuva Nómina</a></li>
    <li><img /><a href="/hris/connectors/sympa">Sympa</a></li>
    <li><img /><a href="/hris/connectors/peoplexd">PeopleXD</a></li>
    <li><img /><a href="/hris/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/hris/connectors/sftp">SFTP</a></li>
    <li><img /><a href="/hris/connectors/sftpfetch">SFTP Fetch</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Get work locations
Source: https://docs.kombo.dev/hris/v1/get-locations

GET /hris/locations
Retrieve all work locations.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/hris/connectors/personio">Personio</a></li>
    <li><img /><a href="/hris/connectors/workday">Workday</a></li>
    <li><img /><a href="/hris/connectors/workdaycustomreport">Workday Custom Reports</a></li>
    <li><img /><a href="/hris/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/hris/connectors/factorial">Factorial</a></li>
    <li><img /><a href="/hris/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/hris/connectors/ukgprowfm">UKG Pro WFM</a></li>
    <li><img /><a href="/hris/connectors/ukgready">UKG Ready</a></li>
    <li><img /><a href="/hris/connectors/adpworkforcenow">ADP Workforce Now</a></li>
    <li><img /><a href="/hris/connectors/adpdecidium">ADP Decidium</a></li>
    <li><img /><a href="/hris/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/hris/connectors/payfit">PayFit Legacy</a></li>
    <li><img /><a href="/hris/connectors/fourth">Fourth</a></li>
    <li><img /><a href="/hris/connectors/kenjo">Kenjo</a></li>
    <li><img /><a href="/hris/connectors/heavenhr">HeavenHR</a></li>
    <li><img /><a href="/hris/connectors/hibob">HiBob</a></li>
    <li><img /><a href="/hris/connectors/cezannehr">Cezanne HR</a></li>
    <li><img /><a href="/hris/connectors/entraid">Microsoft Entra ID</a></li>
    <li><img /><a href="/hris/connectors/azuread">Microsoft Azure AD</a></li>
    <li><img /><a href="/hris/connectors/googleworkspace">Google Workspace</a></li>
    <li><img /><a href="/hris/connectors/nmbrs">Nmbrs</a></li>
    <li><img /><a href="/hris/connectors/deel">Deel</a></li>
    <li><img /><a href="/hris/connectors/remotecom">Remote</a></li>
    <li><img /><a href="/hris/connectors/humaans">Humaans</a></li>
    <li><img /><a href="/hris/connectors/oraclehcm">Oracle HCM</a></li>
    <li><img /><a href="/hris/connectors/sesamehr">Sesame HR</a></li>
    <li><img /><a href="/hris/connectors/charliehr">Charlie</a></li>
    <li><img /><a href="/hris/connectors/hrworks">HR WORKS</a></li>
    <li><img /><a href="/hris/connectors/gusto">Gusto</a></li>
    <li><img /><a href="/hris/connectors/breathehr">Breathe HR</a></li>
    <li><img /><a href="/hris/connectors/catalystone">CatalystOne</a></li>
    <li><img /><a href="/hris/connectors/alexishr">AlexisHR</a></li>
    <li><img /><a href="/hris/connectors/simployer">Simployer</a></li>
    <li><img /><a href="/hris/connectors/youserve">Visma YouServe</a></li>
    <li><img /><a href="/hris/connectors/dayforce">Dayforce</a></li>
    <li><img /><a href="/hris/connectors/trinet">TriNet (Zenefits)</a></li>
    <li><img /><a href="/hris/connectors/trinetpeo">TriNet PEO</a></li>
    <li><img /><a href="/hris/connectors/paylocity">Paylocity</a></li>
    <li><img /><a href="/hris/connectors/paycor">Paycor</a></li>
    <li><img /><a href="/hris/connectors/namely">Namely</a></li>
    <li><img /><a href="/hris/connectors/paycom">Paycom</a></li>
    <li><img /><a href="/hris/connectors/insperity">Insperity</a></li>
    <li><img /><a href="/hris/connectors/paychex">Paychex</a></li>
    <li><img /><a href="/hris/connectors/rippling">Rippling</a></li>
    <li><img /><a href="/hris/connectors/sapling">Kallidus (Sapling)</a></li>
    <li><img /><a href="/hris/connectors/peoplehr">PeopleHR</a></li>
    <li><img /><a href="/hris/connectors/lucca">Lucca</a></li>
    <li><img /><a href="/hris/connectors/zelt">Zelt</a></li>
    <li><img /><a href="/hris/connectors/boondmanager">BoondManager</a></li>
    <li><img /><a href="/hris/connectors/haileyhr">Hailey HR</a></li>
    <li><img /><a href="/hris/connectors/kiwihr">Tellent HR</a></li>
    <li><img /><a href="/hris/connectors/square">Square</a></li>
    <li><img /><a href="/hris/connectors/leapsome">Leapsome</a></li>
    <li><img /><a href="/hris/connectors/workforcecom">workforce.com</a></li>
    <li><img /><a href="/hris/connectors/peoplefirst">MHR People First</a></li>
    <li><img /><a href="/hris/connectors/sdworx">SD Worx</a></li>
    <li><img /><a href="/hris/connectors/absenceio">Absence.io</a></li>
    <li><img /><a href="/hris/connectors/a3innuvanomina">a3innuva Nómina</a></li>
    <li><img /><a href="/hris/connectors/sympa">Sympa</a></li>
    <li><img /><a href="/hris/connectors/youforce">Visma Raet - Youforce</a></li>
    <li><img /><a href="/hris/connectors/peoplexd">PeopleXD</a></li>
    <li><img /><a href="/hris/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/hris/connectors/sftp">SFTP</a></li>
    <li><img /><a href="/hris/connectors/sftpfetch">SFTP Fetch</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Pay Groups
Source: https://docs.kombo.dev/hris/v1/get-pay-groups

GET /hris/pay-groups
Pay Groups

<Warning>**Closed Beta Feature:** This endpoint is currently in closed beta. We're testing it with selected customers before its public release. If you're interested in learning more or getting early access, please reach out.</Warning>

Retrieve all pay groups.


# Pay Runs
Source: https://docs.kombo.dev/hris/v1/get-pay-runs

GET /hris/pay-runs
Pay Runs

<Warning>**Closed Beta Feature:** This endpoint is currently in closed beta. We're testing it with selected customers before its public release. If you're interested in learning more or getting early access, please reach out.</Warning>

Retrieve all pay runs for all legal entities, across all time.


# Payslips
Source: https://docs.kombo.dev/hris/v1/get-payslips

GET /hris/payslips
Payslips

<Warning>**Closed Beta Feature:** This endpoint is currently in closed beta. We're testing it with selected customers before its public release. If you're interested in learning more or getting early access, please reach out.</Warning>

Retrieve all payslips for all employees, across all time.


# Get performance review cycles
Source: https://docs.kombo.dev/hris/v1/get-performance-review-cycles

GET /hris/performance-review-cycles
Get performance review cycles

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/hris/connectors/workday">Workday</a></li>
    <li><img /><a href="/hris/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/hris/connectors/oraclehcm">Oracle HCM</a></li>
    <li><img /><a href="/hris/connectors/lattice">Lattice</a></li>
    <li><img /><a href="/hris/connectors/latticetalent">Lattice Talent</a></li>
    <li><img /><a href="/hris/connectors/leapsome">Leapsome</a></li>
    <li><img /><a href="/hris/connectors/sandbox">Kombo Sandbox</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Retrieve performance review cycles data from HRIS tools.

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Get performance reviews
Source: https://docs.kombo.dev/hris/v1/get-performance-reviews

GET /hris/performance-reviews
Get performance reviews

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/hris/connectors/workday">Workday</a></li>
    <li><img /><a href="/hris/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/hris/connectors/oraclehcm">Oracle HCM</a></li>
    <li><img /><a href="/hris/connectors/lattice">Lattice</a></li>
    <li><img /><a href="/hris/connectors/latticetalent">Lattice Talent</a></li>
    <li><img /><a href="/hris/connectors/leapsome">Leapsome</a></li>
    <li><img /><a href="/hris/connectors/sandbox">Kombo Sandbox</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Retrieve performance review data from HRIS tools.

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Get employee skill proficiency ratings
Source: https://docs.kombo.dev/hris/v1/get-skill-proficiency-ratings

GET /hris/skill-proficiency-ratings
Retrieve all employee skill proficiency ratings.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/hris/connectors/workday">Workday</a></li>
    <li><img /><a href="/hris/connectors/oraclehcm">Oracle HCM</a></li>
    <li><img /><a href="/hris/connectors/sandbox">Kombo Sandbox</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Retrieve skill proficiency ratings on employees. Each row is one rating, differentiated by `rating_source` – the same employee and skill can have several rows (e.g. a `SELF` and an `EXTERNAL` rating).

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Get skills
Source: https://docs.kombo.dev/hris/v1/get-skills

GET /hris/skills
Get skills

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/hris/connectors/workday">Workday</a></li>
    <li><img /><a href="/hris/connectors/oraclehcm">Oracle HCM</a></li>
    <li><img /><a href="/hris/connectors/sandbox">Kombo Sandbox</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Retrieve the skill catalog from the HRIS. These are the skills that can be attached to employees and staffing entities.

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Get staffing entities
Source: https://docs.kombo.dev/hris/v1/get-staffing-entities

GET /hris/staffing-entities
Retrieve all staffing entities.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/hris/connectors/workday">Workday</a></li>
    <li><img /><a href="/hris/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/hris/connectors/sandbox">Kombo Sandbox</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Retrieve all staffing entities (positions, requisitions, and jobs) from the HRIS system.

Many enterprise HRIS platforms distinguish between **positions**, **requisitions**, and **jobs** — three related but different concepts used to manage headcount and hiring. Not every HRIS uses all three, and naming varies across systems, but here is a general overview:

* **Position**: A slot in the organizational structure that represents a role to be filled (or already filled) by one or more employees. Positions typically carry metadata like department, location, cost center, and reporting line. Think of it as "a chair at a desk" — it exists whether someone is sitting in it or not.
* **Requisition**: A formal request to fill a position. When a manager wants to hire for an open position, they usually create a requisition that goes through an approval workflow. Requisitions are time-bound and tied to a specific hiring need. In Kombo's data model, a requisition's `parent_id` points to the position it was opened for.
* **Job**: Some systems use "job" as a more generic or lightweight alternative to a requisition. Jobs often represent an ongoing, unlimited hiring need (e.g., a company that is always hiring for "Software Engineer") rather than a one-off backfill. This is reflected in the `OPEN_UNLIMITED` status.

You can use the `model_types` filter to retrieve only the type(s) relevant to your use case. Each record's `model_type` field tells you which of the three concepts it represents.

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Get time off balances
Source: https://docs.kombo.dev/hris/v1/get-time-off-balances

GET /hris/time-off-balances
Retrieve all time off balances.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/hris/connectors/personio">Personio</a></li>
    <li><img /><a href="/hris/connectors/workday">Workday</a></li>
    <li><img /><a href="/hris/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/hris/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/hris/connectors/adpworkforcenow">ADP Workforce Now</a></li>
    <li><img /><a href="/hris/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/hris/connectors/hibob">HiBob</a></li>
    <li><img /><a href="/hris/connectors/deel">Deel</a></li>
    <li><img /><a href="/hris/connectors/remotecom">Remote</a></li>
    <li><img /><a href="/hris/connectors/iriscascade">IRIS Cascade</a></li>
    <li><img /><a href="/hris/connectors/sagehr">Sage HR</a></li>
    <li><img /><a href="/hris/connectors/humaans">Humaans</a></li>
    <li><img /><a href="/hris/connectors/eurecia">Eurécia</a></li>
    <li><img /><a href="/hris/connectors/charliehr">Charlie</a></li>
    <li><img /><a href="/hris/connectors/hrworks">HR WORKS</a></li>
    <li><img /><a href="/hris/connectors/insperity">Insperity</a></li>
    <li><img /><a href="/hris/connectors/rippling">Rippling</a></li>
    <li><img /><a href="/hris/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/hris/connectors/sftp">SFTP</a></li>
    <li><img /><a href="/hris/connectors/sftpfetch">SFTP Fetch</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Get timesheets
Source: https://docs.kombo.dev/hris/v1/get-timesheets

GET /hris/timesheets
Get timesheets

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/hris/connectors/personio">Personio</a></li>
    <li><img /><a href="/hris/connectors/workday">Workday</a></li>
    <li><img /><a href="/hris/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/hris/connectors/ukgprowfm">UKG Pro WFM</a></li>
    <li><img /><a href="/hris/connectors/ukgready">UKG Ready</a></li>
    <li><img /><a href="/hris/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/hris/connectors/oraclehcm">Oracle HCM</a></li>
    <li><img /><a href="/hris/connectors/paylocity">Paylocity</a></li>
    <li><img /><a href="/hris/connectors/paycom">Paycom</a></li>
    <li><img /><a href="/hris/connectors/sandbox">Kombo Sandbox</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Retrieve attendance data and timesheets from HRIS tools.

<Warning>**Open Beta Feature:** This endpoint is currently in beta. Please reach out to our support team if you need assistance with implementation.</Warning>

For a detailed explanation of the data model, validation rules, time zones, payable hours, approvals, and break patterns, see the [Time & Attendance guide](/hris/features/time-and-attendance).

<Note>
  By default, only the last 2 months of timesheets are kept up to date during sync (configurable via the "Historical timesheet months to sync" setting). Kombo only deletion-tracks timesheets inside that window — timesheets that age out are kept and are not marked as deleted just because they were not re-fetched. Within the window, timesheets that disappear from the remote HRIS are marked with `remote_deleted_at` as usual. See the [Time & Attendance guide](/hris/features/time-and-attendance) for details.
</Note>

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Get tools
Source: https://docs.kombo.dev/hris/v1/get-tools-category

GET /tools/{category}
Get a list of the tools (i.e., integrations) enabled in your environment.

This can (in combination with the `integration_tool` parameter of [the "Create Link" endpoint](/v1/post-create-link)) be used to, for example, display a custom list or grid of available integrations to your end users instead of exposing Kombo Connect's standard tool selector.


# Updates an integration fields passthrough setting
Source: https://docs.kombo.dev/hris/v1/patch-integrations-integration-id-integration-fields-integration-field-id

PATCH /integrations/{integration_id}/integration-fields/{integration_field_id}
When enabled, the integration field will be passed as part of the `integration_fields` array on the specific model endpoint. Providing false will disable the passthrough for the specified field.



# Create absence
Source: https://docs.kombo.dev/hris/v1/post-absences

POST /hris/absences
Create a new absence.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/hris/connectors/personio">Personio</a></li>
    <li><img /><a href="/hris/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/hris/connectors/factorial">Factorial</a></li>
    <li><img /><a href="/hris/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/hris/connectors/hibob">HiBob</a></li>
    <li><img /><a href="/hris/connectors/deel">Deel</a></li>
    <li><img /><a href="/hris/connectors/sesamehr">Sesame HR</a></li>
    <li><img /><a href="/hris/connectors/hrworks">HR WORKS</a></li>
    <li><img /><a href="/hris/connectors/alexishr">AlexisHR</a></li>
    <li><img /><a href="/hris/connectors/simployer">Simployer</a></li>
    <li><img /><a href="/hris/connectors/paycor">Paycor</a></li>
    <li><img /><a href="/hris/connectors/absenceio">Absence.io</a></li>
    <li><img /><a href="/hris/connectors/a3innuvanomina">a3innuva Nómina</a></li>
    <li><img /><a href="/hris/connectors/datev">DATEV LODAS</a></li>
    <li><img /><a href="/hris/connectors/datevlug">DATEV Lohn & Gehalt</a></li>
    <li><img /><a href="/hris/connectors/sandbox">Kombo Sandbox</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Check [this page](/hris/features/creating-absences) for a detailed guide.

<Note>
  This endpoint requires the permission **Manage absences** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "employee_id": "wXJMxwDvPAjrJ4CyqdV9",
  "absence_type_id": "3YKtQ7qedsrcCady1jSyAkY1",
  "start_date": "2019-09-17",
  "end_date": "2019-09-21",
  "start_time": "08:30:00",
  "end_time": "16:00:00",
  "start_half_day": false,
  "end_half_day": false,
  "employee_note": "Visiting the aliens"
}
```


# Activate integration (optional)
Source: https://docs.kombo.dev/hris/v1/post-connect-activate-integration

POST /connect/activate-integration
Use this endpoint with the token you get from the connection flow to retrieve information about the created integration. It works in a similar way as the OAuth2 code flow to securely retrieve information and connect the integration to your user. You do not need to call this endpoint for an integration to become active.

<Warning>We are deprecating this endpoint in favour of the [get integration by code endpoint](/v1/get-integration-by-token-token). To migrate you only have to change to the new API endpoint.</Warning>

### Example Request Body

```json theme={null}
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtZXNzYWdlIjoiVGhpcyBpcyBub3QgYW4gYWN0dWFsIHRva2VuLiJ9.JulqgOZBMKceI8vh9YLpVX51efND0ZyfUNHDXLrPz_4"
}
```


# Create connection link
Source: https://docs.kombo.dev/hris/v1/post-connect-create-link

POST /connect/create-link
Generate a unique link that allows your user to enter the embedded Kombo Connect flow.

> Check out [our full guide](/connect/embedded-flow) for more details about implementing the connection flow into your app.

> Kombo will not deduplicate integrations for you that are created with this endpoint. You are responsible for keeping track of integrations in your system and prevent customers from connecting the same tool again. Use the [reconnection link](/v1/post-integrations-integration-id-relink) endpoint if you want a customer to update their credentials.

### Example Request Body

```json theme={null}
{
  "end_user_email": "test@example.com",
  "end_user_organization_name": "Test Inc.",
  "integration_category": "HRIS",
  "integration_tool": "personio",
  "end_user_origin_id": "123",
  "language": "en",
  "link_type": "EMBEDDED"
}
```


# Download Company Document
Source: https://docs.kombo.dev/hris/v1/post-datev-download-document

POST /custom/datev/download-document
Download a document from DATEV

<Note>
  This endpoint requires the permission **Manage documents** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "accounting_month": "2001-12-01",
  "document_type": "LOJE",
  "employee_id": null
}
```


# Download Employee Document
Source: https://docs.kombo.dev/hris/v1/post-datev-employees-employee-id-download-document

POST /custom/datev/employees/{employee_id}/download-document
Download a document from DATEV

<Note>
  This endpoint requires the permission **Manage documents** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "accounting_month": "2001-12-01",
  "document_type": "LOJE"
}
```


# Create eAU Request
Source: https://docs.kombo.dev/hris/v1/post-datev-employees-employee-id-eau-requests

POST /custom/datev/employees/{employee_id}/eau-requests
Create a request for an electronic certificate of incapacity for work (eAU).

<Note>
  This endpoint requires the permission **Manage eAU** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "start_work_incapacity": "2022-01-01"
}
```


# Write raw DATEV ASCII file
Source: https://docs.kombo.dev/hris/v1/post-datev-passthrough

POST /custom/datev/passthrough
This action allows to send an arbitrary ASCII file directly to DATEV LODAS or Lohn und Gehalt. Kombo adds validation for the file format but not on the content. This action allows you to implement any use case that you might have with DATEV payroll ASCII imports.



# [DEPRECATED] Create employee
Source: https://docs.kombo.dev/hris/v1/post-employees

POST /hris/employees
Create a new employee.

<Warning>
  We are deprecating this endpoint in favor of the new [create employee form](/hris/features/create-employee) endpoint.
</Warning>

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/hris/connectors/personio">Personio</a></li>
    <li><img /><a href="/hris/connectors/workday">Workday</a></li>
    <li><img /><a href="/hris/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/hris/connectors/factorial">Factorial</a></li>
    <li><img /><a href="/hris/connectors/adpworkforcenow">ADP Workforce Now</a></li>
    <li><img /><a href="/hris/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/hris/connectors/hibob">HiBob</a></li>
    <li><img /><a href="/hris/connectors/cezannehr">Cezanne HR</a></li>
    <li><img /><a href="/hris/connectors/entraid">Microsoft Entra ID</a></li>
    <li><img /><a href="/hris/connectors/azuread">Microsoft Azure AD</a></li>
    <li><img /><a href="/hris/connectors/googleworkspace">Google Workspace</a></li>
    <li><img /><a href="/hris/connectors/nmbrs">Nmbrs</a></li>
    <li><img /><a href="/hris/connectors/remotecom">Remote</a></li>
    <li><img /><a href="/hris/connectors/okta">Okta</a></li>
    <li><img /><a href="/hris/connectors/sagehr">Sage HR</a></li>
    <li><img /><a href="/hris/connectors/humaans">Humaans</a></li>
    <li><img /><a href="/hris/connectors/oraclehcm">Oracle HCM</a></li>
    <li><img /><a href="/hris/connectors/zohopeople">Zoho People</a></li>
    <li><img /><a href="/hris/connectors/gusto">Gusto</a></li>
    <li><img /><a href="/hris/connectors/breathehr">Breathe HR</a></li>
    <li><img /><a href="/hris/connectors/alexishr">AlexisHR</a></li>
    <li><img /><a href="/hris/connectors/simployer">Simployer</a></li>
    <li><img /><a href="/hris/connectors/paylocity">Paylocity</a></li>
    <li><img /><a href="/hris/connectors/paycor">Paycor</a></li>
    <li><img /><a href="/hris/connectors/insperity">Insperity</a></li>
    <li><img /><a href="/hris/connectors/rippling">Rippling</a></li>
    <li><img /><a href="/hris/connectors/sapling">Kallidus (Sapling)</a></li>
    <li><img /><a href="/hris/connectors/peoplehr">PeopleHR</a></li>
    <li><img /><a href="/hris/connectors/planday">Planday</a></li>
    <li><img /><a href="/hris/connectors/cornerstoneondemand">Cornerstone OnDemand</a></li>
    <li><img /><a href="/hris/connectors/square">Square</a></li>
    <li><img /><a href="/hris/connectors/leapsome">Leapsome</a></li>
    <li><img /><a href="/hris/connectors/sympa">Sympa</a></li>
    <li><img /><a href="/hris/connectors/sandbox">Kombo Sandbox</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

<Note>
  This endpoint requires the permission **Create and manage employees** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "first_name": "John",
  "last_name": "Doe",
  "work_email": "john.doe@acme.com",
  "gender": "MALE",
  "date_of_birth": "1986-01-01",
  "start_date": "2020-04-07",
  "job_title": "Integrations Team Lead",
  "home_address": {
    "city": "Berlin",
    "country": "DE",
    "state": "Berlin",
    "street_1": "Sonnenallee 63",
    "zip_code": "12045"
  }
}
```


# Add document to employee
Source: https://docs.kombo.dev/hris/v1/post-employees-employee-id-documents

POST /hris/employees/{employee_id}/documents
Uploads an document file for the specified employee.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/hris/connectors/personio">Personio</a></li>
    <li><img /><a href="/hris/connectors/workday">Workday</a></li>
    <li><img /><a href="/hris/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/hris/connectors/afas">AFAS Software</a></li>
    <li><img /><a href="/hris/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/hris/connectors/hibob">HiBob</a></li>
    <li><img /><a href="/hris/connectors/nmbrs">Nmbrs</a></li>
    <li><img /><a href="/hris/connectors/sagehr">Sage HR</a></li>
    <li><img /><a href="/hris/connectors/hrworks">HR WORKS</a></li>
    <li><img /><a href="/hris/connectors/youserve">Visma YouServe</a></li>
    <li><img /><a href="/hris/connectors/hansalog">Hansalog</a></li>
    <li><img /><a href="/hris/connectors/hoorayhr">HoorayHR</a></li>
    <li><img /><a href="/hris/connectors/hr4you">HR4YOU</a></li>
    <li><img /><a href="/hris/connectors/sdworx">SD Worx</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

<Note>
  This endpoint requires the permission **Manage documents** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "category_id": "3Cjwu7nA7pH5cX5X1NAPmb7M",
  "document": {
    "name": "Frank Doe Employment Contract.txt",
    "data": "SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=",
    "content_type": "text/plain"
  }
}
```


# Create employee with form
Source: https://docs.kombo.dev/hris/v1/post-employees-form

POST /hris/employees/form
Create an employee, based on the form schema.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/hris/connectors/personio">Personio</a></li>
    <li><img /><a href="/hris/connectors/workday">Workday</a></li>
    <li><img /><a href="/hris/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/hris/connectors/ukgpro">UKG Pro</a></li>
    <li><img /><a href="/hris/connectors/ukgprowfm">UKG Pro WFM</a></li>
    <li><img /><a href="/hris/connectors/ukgready">UKG Ready</a></li>
    <li><img /><a href="/hris/connectors/adpworkforcenow">ADP Workforce Now</a></li>
    <li><img /><a href="/hris/connectors/bamboohr">BambooHR</a></li>
    <li><img /><a href="/hris/connectors/kenjo">Kenjo</a></li>
    <li><img /><a href="/hris/connectors/hibob">HiBob</a></li>
    <li><img /><a href="/hris/connectors/entraid">Microsoft Entra ID</a></li>
    <li><img /><a href="/hris/connectors/azuread">Microsoft Azure AD</a></li>
    <li><img /><a href="/hris/connectors/deel">Deel</a></li>
    <li><img /><a href="/hris/connectors/remotecom">Remote</a></li>
    <li><img /><a href="/hris/connectors/humaans">Humaans</a></li>
    <li><img /><a href="/hris/connectors/oraclehcm">Oracle HCM</a></li>
    <li><img /><a href="/hris/connectors/hrworks">HR WORKS</a></li>
    <li><img /><a href="/hris/connectors/zohopeople">Zoho People</a></li>
    <li><img /><a href="/hris/connectors/gusto">Gusto</a></li>
    <li><img /><a href="/hris/connectors/alexishr">AlexisHR</a></li>
    <li><img /><a href="/hris/connectors/simployer">Simployer</a></li>
    <li><img /><a href="/hris/connectors/dayforce">Dayforce</a></li>
    <li><img /><a href="/hris/connectors/lattice">Lattice</a></li>
    <li><img /><a href="/hris/connectors/trinetpeo">TriNet PEO</a></li>
    <li><img /><a href="/hris/connectors/paylocity">Paylocity</a></li>
    <li><img /><a href="/hris/connectors/paycor">Paycor</a></li>
    <li><img /><a href="/hris/connectors/paycom">Paycom</a></li>
    <li><img /><a href="/hris/connectors/insperity">Insperity</a></li>
    <li><img /><a href="/hris/connectors/paychex">Paychex</a></li>
    <li><img /><a href="/hris/connectors/planday">Planday</a></li>
    <li><img /><a href="/hris/connectors/leapsome">Leapsome</a></li>
    <li><img /><a href="/hris/connectors/sdworx">SD Worx</a></li>
    <li><img /><a href="/hris/connectors/absenceio">Absence.io</a></li>
    <li><img /><a href="/hris/connectors/a3innuvanomina">a3innuva Nómina</a></li>
    <li><img /><a href="/hris/connectors/sympa">Sympa</a></li>
    <li><img /><a href="/hris/connectors/youforce">Visma Raet - Youforce</a></li>
    <li><img /><a href="/hris/connectors/sandbox">Kombo Sandbox</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

<Note>
  This endpoint requires the permission **Create and manage employees** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "staffing_entity_id": "26vafvWSRmbhNcxJYqjCzuJg",
  "properties": {
    "firstName": "John",
    "startDate": "2025-01-01",
    "workLocation": {
      "site": "8e422bf8cav",
      "keyNumbers": [
        142,
        525,
        63
      ]
    }
  }
}
```


# Trigger sync
Source: https://docs.kombo.dev/hris/v1/post-force-sync

POST /force-sync
Trigger a sync for a specific integration.

<Warning>Please note that it is **not** necessary nor recommended to call this endpoint periodically on your side. Kombo already performs periodic syncs for you and you should only trigger syncs yourself in special cases (like when a user clicks on a "Sync" button in your app).</Warning>


# Create reconnection link
Source: https://docs.kombo.dev/hris/v1/post-integrations-integration-id-relink

POST /integrations/{integration_id}/relink
Create a link that will allow the user to reconnect an integration. This is useful if you want to allow your users to update the credentials if the old ones for example expired.

Embed this the same way you would [embed the connect link](/connect/embedded-flow). By default, the link will be valid for 1 hour.

### Example Request Body

```json theme={null}
{
  "language": "en",
  "scope_config_id": "9Pv6aCFwNDEzPNmwjSsY9SQx",
  "link_type": "EMBEDDED"
}
```


# Create Setup Flow link
Source: https://docs.kombo.dev/hris/v1/post-integrations-integration-id-setup-link

POST /integrations/{integration_id}/setup-link
Create a link that lets your customer run the [Setup Flow](/hris/features/setup-flow/introduction) for an integration. Use this to send customers back into setup steps like field mapping or employee filtering without having to go through the initial connection flow again. Pass the returned URL to `showKomboConnect` from the Kombo Connect SDK, the same way you do with a connection link.

The integration must have at least one Setup Flow step enabled (e.g. field mapping or employee filtering); otherwise this endpoint returns a `PLATFORM.INPUT_INVALID` error. Steps can be enabled from the Integration Settings tab in the dashboard or via the [Create Connection Link endpoint](./post-connect-create-link).


# Send passthrough request
Source: https://docs.kombo.dev/hris/v1/post-passthrough-tool-api

POST /passthrough/{tool}/{api}
Send a request to the specified integration's native API.

At Kombo we put a lot of work into making sure that our unified API covers all our customers' use cases and that they never have to think about integration-specific logic again. There are cases, however, where our customers want to build features that are very integration-specific. That's where this endpoint comes in.

Pass in details about the request you want to make to the integration's API and we'll forward it for you. We'll also take care of setting the right base URL and authenticating your requests.

To get started, please pick the relevant API (some tools provide multiple to due different base URLs or authentication schemes) from the table below and pass in the `{tool}/{api}` identifier as part of the path.

| Integration                  | `{tool}/{api}`                     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| ---------------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| 360Learning                  | `360learning/v2`                   | 360Learning [API v2](https://360learning.readme.io/docs). We automatically handle authentication and use `https://app.360learning.com/api/v2/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| a3innuva Nómina              | `a3innuvanomina/laboral`           | a3innuva Nómina API [docs](https://a3developers.wolterskluwer.es/). Requests are automatically authenticated using OAuth access tokens (refreshed when needed). Base URL: `https://a3api.wolterskluwer.es/Laboral/api`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Abacus Umantis               | `abacusumantis/v1`                 | [Umantis API v1](https://recruitingapp-91005709.umantis.com/api/v1/swagger-ui). We automatically authenticate all requests and use `https://\{subdomain\}.umantis.com/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Abacus                       | `abacus/api`                       | Abacus [REST API](https://apihub.abacus.ch/). We automatically authenticate all requests and use `https://\{\{abacusUrl\}\}/api/entity/v1/mandants/\{\{mandantId\}\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Absence.io                   | `absenceio/v2`                     | Absence.io [API](https://docs.absence.io/). We automatically authenticate all requests and use `https://app.absence.io/api/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| ADP Decidium                 | `adpdecidium/default`              | [ADP Decidium API](https://developers.adp.com/apis/api-explorer/hcm-offrg-dge). We automatically authenticate all requests and use `https://api.eu.adp.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| ADP Workforce Now            | `adpworkforcenow/default`          | [ADP Workforce Now API v2](https://developers.adp.com/build/api-explorer/hcm-offrg-wfn). We automatically authenticate all requests and use the correct subdomain.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| AFAS Software                | `afas/api`                         | AFAS' [API](https://connect.afas.nl/rest/get). We automatically authenticate all requests and use `https://\{domain\}/ProfitRestServices` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| AlexisHR                     | `alexishr/v1`                      | [AlexisHR's v1 API](https://docs.alexishr.com/) We automatically authenticate all requests and use `https://\{subdomain\}.alexishr.com` as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| ApplicantStack               | `applicantstack/api`               | ApplicantStack's [API](https://helpas.payrollservers.info/s/article/API-Integration-Guide). We automatically authenticate all requests and use `https://\{subdomain\}.applicantstack.com/api/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Apploi                       | `apploi/rest-api`                  | The [Apploi API](https://integrate.apploi.com/). We automatically authenticate all requests and use `https://partners.apploi.com/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Ashby                        | `ashby/v1`                         | Ashby's [V1 API](https://developers.ashbyhq.com/reference/introduction). We automatically authenticate all requests with the provided credentials and use `https://api.ashbyhq.com` as the base URL. Please note that Ashby uses an RPC-style API. Please check [the Ashby API documentation](https://developers.ashbyhq.com/reference/introduction) for details on how to use it.                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| Asymbl                       | `asymbl/v63`                       | We use `https://\{subdomain\}.my.salesforce.com` as the base URL. Find the official docs [here](https://asymblinc.github.io/ats/ats.html).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Avature                      | `avature/custom-api`               | Avatures's Custom API. Call `Get /openapi` to retrieve the specific custom API schema. We automatically authenticate all requests and use the instance specific custom API URL as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Avionté                      | `avionte/front-office-v1`          | Avionte's API. We automatically authenticate all requests and use `https://api.avionte.com/front-office/v1` as the base URL. Documentation for the BOLD Front Office API: [https://developer.avionte.com/reference/get-all-talent-tags](https://developer.avionte.com/reference/get-all-talent-tags)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| BambooHR                     | `bamboohr/v1`                      | BambooHR's [API](https://documentation.bamboohr.com/reference/get-employee). We automatically authenticate all requests using the customer credentials `https://api.bamboohr.com/api/gateway.php/\{subdomain\}/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| BITE                         | `bite/v1`                          | [Bite's v1 API](https://api.b-ite.io/docs/#/). We automatically authenticate all requests and use your configured API base URL with `/v1` appended (default `https://api.b-ite.io/v1`).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| BoondManager                 | `boondmanager/api`                 | BoondManager [REST API](https://ui.boondmanager.com/administrator/developer/apisandbox). We automatically authenticate all requests and use `https://ui.boondmanager.com/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Breezy HR                    | `breezyhr/v3`                      | [BreezyHR's v3 API](https://developer.breezy.hr/reference/overview). We automatically authenticate all requests and use "[https://api.breezy.hr/v3/](https://api.breezy.hr/v3/)" as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| Bullhorn for Salesforce      | `bullhorn4salesforce/v66`          | We use `https://\{subdomain\}.my.salesforce.com/services/data/v66.0` as the base URL. Find the official docs [here](https://kb.bullhorn.com/bh4sf/Content/BH4SF/Topics/bh4sfRestAPI.htm).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Bullhorn                     | `bullhorn/default`                 | [Bullhorn's API](https://bullhorn.github.io/rest-api-docs/index.html). We automatically use the right `https://\{subdomain\}.bullhornstaffing.com/rest-services/\{corpToken\}` base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| CareerPlug                   | `careerplug/api`                   | We use `https://api.careerplug.com` as the base URL. Find the official docs [here](https://api.careerplug.com/docs#api).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Carerix                      | `carerix/api`                      | Carerix [REST API](https://docs.carerix.io/rest/introduction). We automatically authenticate all requests and use `https://api.carerix.com` as the base URL. Please note that Carerix uses XML for request and response bodies.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Carerix                      | `carerixgraphql/graphql`           | Carerix [GraphQL API](https://docs.carerix.io/graphql/welcome). We automatically authenticate all requests (OAuth2 client credentials) and use `https://api.carerix.io/graphql/v1` as the base URL. Send GraphQL requests as `POST /graphql` with a JSON body of `\{ "query": "...", "variables": \{ ... \} \}`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| CEGID TalentSoft Customer    | `talentsoftcustomer/v1`            | Cegid Talentsoft Recruiting FrontOffice API: [API Documentation](https://developers.cegid.com/api-details#api=cegid-talentsoft-recruiting-frontoffice) We automatically authenticate all requests and use `https://\{customer_subdomain\}.talent-soft.com/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| CEGID TalentSoft FrontOffice | `talentsoft/v2`                    | Cegid Talentsoft Recruiting FrontOffice [API](https://developers.cegid.com/api-details). We automatically authenticate all requests using the provided credentials and use `https://\{domain\}/api/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Ceipal                       | `ceipal/v1`                        | We use `https://api.ceipal.com/v1` as the base URL. Find the official docs [here](https://developer.ceipal.com/ceipal-ats-version-one/ceipal-ats-v1-api-reference).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Cezanne HR                   | `cezannehr/dataservice`            | [CezanneHR's v7 dataservice API](https://api.cezannehr.com/).We automatically authenticate all requests and use the base URL `https://\{subdomain\}.cezanneondemand.com/cezanneondemand/v7/dataservice.svc`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Compleet (Persy)             | `compleetpersy/api`                | Compleet Persy [REST API](https://persy-api.refined.site/space/PAPI/450166808/Requirements+Jobfeed+%2F+Anforderungen+f%C3%BCr+Jobfeeds). We automatically authenticate all requests and use `https://www.germanpersonnel.de/persy/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Compleet                     | `compleetpitcher/pitcher`          | Compleet's Pitcher API. We automatically authenticate all requests and use the configured base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Connexys By Bullhorn         | `connexys/api`                     | [Connexy's API](https://api.conexsys.com/client/v2/docs/#section/Overview). We automatically authenticate all requests and use `https://\{connexys_domain\}/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Cornerstone OnDemand         | `cornerstoneondemand/core-hr`      | Cornerstone's [Core HR API](https://csod.dev/reference/core-hr/). We automatically authenticate all requests using the client ID and secret and use `https://\{your_domain\}.csod.com/services/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Cornerstone OnDemand         | `cornerstoneondemand/learning`     | Cornerstone's [Learning API](https://csod.dev/reference/learning/). We automatically authenticate all requests using the client ID and secret and use `https://\{your_domain\}.csod.com/services/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Cornerstone OnDemand         | `cornerstoneondemand/recruiting`   | Cornerstone's [Recruiting API](https://csod.dev/reference/recruiting/). We automatically authenticate all requests using the client ID and secret and use `https://\{your_domain\}.csod.com/services/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Cornerstone TalentLink       | `cornerstonetalentlink/apply`      | Cornerstone TalentLink's Apply API. We automatically authenticate all requests using the provided credentials and API key, and use `https://apiproxy.shared.lumessetalentlink.com/apply` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Cornerstone TalentLink       | `cornerstonetalentlink/rest`       | Cornerstone TalentLink's [REST API](https://developer.lumesse-talenthub.com/rest-api-developers-guide/1.21.33/index.html?page=rest-api\&subpage=introduction). We automatically authenticate all requests using the provided credentials and API key, and use `https://apiproxy.shared.lumessetalentlink.com/tlk/rest` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Coursera                     | `coursera/v1`                      | We use `https://api.coursera.com/ent` as the base URL. Find the official docs [here](https://dev.coursera.com).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Coveto (legacy SOAP API)     | `coveto/public`                    | We automatically use `https://\{subdomain\}.coveto.de` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Coveto (REST API)            | `covetorest/v1`                    | We automatically use `https://\{subdomain\}.coveto.de/public/api/v1` as the base URL. [https://demo.coveto.de/swagger-ui/index.html#/](https://demo.coveto.de/swagger-ui/index.html#/)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Crelate                      | `crelate/api`                      | Crelate [REST API](https://app.crelate.com/api3/docs/index.html). We automatically authenticate all requests and use `https://app.crelate.com/api3` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| d.vinci admin                | `dvinciadmin/odata-api`            | [DVinci ODATA API](https://dvinci.freshdesk.com/en/support/solutions/articles/75000059523-odata-reporting-api).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| d.vinci admin                | `dvinciadmin/rest-api`             | [DVinci REST API](https://static.dvinci-easy.com/files/d.vinci%20rest-api.html).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| d.vinci                      | `dvinci/apply-api`                 | The [DVinci Apply API](https://static.dvinci-easy.com/files/d.vinci%20application-apply-api.html). All requests are authenticated by Kombo and use `https://\{dvinci_domain\}/p/\{portal_path\}/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| d.vinci                      | `dvinci/rest-api`                  | The [DVinci REST API](https://static.dvinci-easy.com/files/d.vinci%20rest-api.html). All requests are authenticated by Kombo and use `https://\{dvinci_domain\}/restApi/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Databites                    | `databites/v1`                     | We use `https://\{subdomain\}.databites.de` as the base URL. Find the official docs [here](https://\{subdomain}.databites.de/api-dokumentationen/public-integrations/index).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| DATEV LODAS                  | `datev/eau`                        | DATEV's [eau](https://developer.datev.de/en/product-detail/eau-api/1.0.0/overview) API. We automatically authenticate all requests and use \`[https://eau.api.datev.de/\\\{platform](https://eau.api.datev.de/\\\{platform)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | platform-sandbox}/v1/clients/\{client-id}/\` as the base URL. |
| DATEV                        | `datevhr/eau`                      | DATEV's [eau](https://developer.datev.de/en/product-detail/eau-api/1.0.0/overview) API. We automatically authenticate all requests and use \`[https://eau.api.datev.de/\\\{platform](https://eau.api.datev.de/\\\{platform)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | platform-sandbox}/v1/clients/\{client-id}/\` as the base URL. |
| DATEV                        | `datevhr/hr-exports`               | DATEV's [hr-exports](https://developer.datev.de/en/product-detail/hr-exports/1.0.0/overview). We automatically authenticate all requests and use \`[https://hr-exports.api.datev.de/\\\{platform](https://hr-exports.api.datev.de/\\\{platform)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | platform-sandbox}/v1/clients/\{client-id}\` as the base URL.  |
| DATEV                        | `datevhr/hr:payrollreports`        | DATEV's [hr:payrollreports](https://developer.datev.de/en/product-detail/hr-payrollreports/2.0.0/overview) API. We automatically authenticate all requests and use \`[https://hr-payrollreports.api.datev.de/\\\{platform](https://hr-payrollreports.api.datev.de/\\\{platform)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | platform-sandbox}/v1/clients/\{client-id}/\` as the base URL. |
| DATEV                        | `datevlauds/lauds`                 | DATEV's [hr-exchange](https://developer.datev.de/de/product-detail/hr-exchange/1.0.0/overview). We automatically authenticate all requests and use \`[https://hr-exchange.api.datev.de/\\\{platform](https://hr-exchange.api.datev.de/\\\{platform)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | platform-sandbox}/v1/clients/\{client-id}\` as the base URL.  |
| Dayforce                     | `dayforce/V1`                      | [Dayforce's API](https://developers.dayforce.com/Build/Home.aspx). We automatically authenticate all requests and use `\{\{baseUrl\}\}/Api/\{\{clientNamespace\}\}/V1` as the base URL                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Deel                         | `deel/api`                         | Deel's [API](https://developer.deel.com/reference/). We automatically authenticate all requests using the provided credentials and use `https://\{api_domain\}/rest` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                               |
| Digital Recruiters           | `digitalrecruiters/api`            | Cegid Digital Recruiters [Talent Acquisition API](https://cegid-hr-developers.talentsoft.net/docs/tutorial-basics/Talent%20Acquisition/Getting%20Started). We automatically authenticate all requests by replacing `:token` in the request URL with your configured access token and use your configured Digital Recruiters domain as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Docebo                       | `docebo/api`                       | Docebo [API](https://developer.docebo.com). We automatically handle authentication and use `https://\{subdomain\}.docebosaas.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| Eightfold                    | `eightfold/api`                    | Eightfold's [API](https://apidocs.eightfold.ai/). We automatically authenticate all requests and use  `https://apiv2.\{region\}/api/v2/core/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Employment Hero              | `employmenthero/default`           | EmploymentHero [API](https://developer.employmenthero.com/api-references/#icon-book-open-introduction). We automatically authenticate all requests using the credentials supplied by the customer and use `https://api.employmenthero.com/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Eploy                        | `eploy/api`                        | Eploy's [API](https://www.eploy.com/resources/developers/api-documentation/). We automatically authenticate all requests. The base URL is `https://\{hostname\}/api`, where `\{hostname\}` is either `\{subdomain\}.eploy.net` or your full custom hostname when applicable.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| eRecruiter                   | `erecruiter/api`                   | [eRecruiter's API](https://api.erecruiter.net/swagger/ui/index). We automatically authenticate all requests and use `https://\{domain\}/Api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Eurécia                      | `eurecia/api`                      | Eurécia [REST API](https://api.eurecia.com/eurecia/fw/swagger/index.html#/) We automatically authenticate all requests and use `https://\{domain\}/eurecia/rest` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| Factorial                    | `factorial/api`                    | Factorial's [API](https://apidoc.factorialhr.com/). We automatically authenticate all requests and use `https://api.factorialhr.com/api` or `https://api.demo.factorial.dev/api` as the base URL, depending on the connected instance.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Flatchr                      | `flatchr/api`                      | Flatchr's [API](https://developers.flatchr.io/docs/getting_started). We automatically authenticate all requests and use `https://api.flatchr.io` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| Flatchr                      | `flatchr/career`                   | Flatchr's [Career API](https://developers.flatchr.io/docs/QuickStart/Candidats/Creer_un_candidat). We automatically authenticate all requests and use `https://career.flatchr.io` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| Fountain                     | `fountain/v2`                      | Fountain's [Hire API](https://developer.fountain.com/reference/get_v2-applicants). We automatically authenticate all requests. The base URL depends on how the integration is connected: Fountain One (OAuth) requests go to `https://services.fountain.com/api/servicehire/v2`, while legacy API-key requests go to `https://\{subdomain\}.fountain.com/api/v2`.                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| Fourth                       | `fourth/uk-employee`               | Fourth [UK Employee API](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference) We automatically authenticate all requests and use `https://api.fourth.com/hr/organisations/\{organisation_id\}/` as the base URL. We also enforce the required query params for all requests.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Gem                          | `gem/api`                          | Gem's [ATS API](https://api.gem.com/ats/v0/reference) We automatically authenticate all requests and use `https://api.gem.com/ats/v0` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Google Workspace             | `googleworkspace/admin`            | [Googles's API](https://developers.google.com/admin-sdk/directory/reference/rest). We automatically authenticate all requests and use '[https://admin.googleapis.com](https://admin.googleapis.com)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                               |
| Google Workspace             | `googleworkspace/people`           | [Googles's API](https://developers.google.com/people/api/rest). We automatically authenticate all requests and use '[https://people.googleapis.com](https://people.googleapis.com)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Greenhouse (V1)              | `greenhouse/harvest-v2`            | Greenhouse [Harvest API v2](https://developers.greenhouse.io/harvest.html). We automatically authenticate all requests using the API key and use `https://harvest.greenhouse.io/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Greenhouse (V1)              | `greenhouse/harvest`               | Greenhouse [Harvest API v1](https://developers.greenhouse.io/harvest.html). We automatically authenticate all requests using the API key and use `https://harvest.greenhouse.io/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Greenhouse (V3)              | `greenhousev3/harvestv3`           | We use `https://harvest.greenhouse.io/v3` as the base URL. Find the official docs [here](https://harvestdocs.greenhouse.io/reference/).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Greenhouse Job Board         | `greenhousejobboard/boards-api`    | [Greenhouse Job Board API](https://developers.greenhouse.io/job-board). We automatically authenticate all requests and use '[https://boards-api.greenhouse.io/v1/boards/\\\{job\_board\_token\\}](https://boards-api.greenhouse.io/v1/boards/\\\{job_board_token\\})' as the base URL. Optionally, you can provide a custom job\_board\_token to use a different job board.                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Greenhouse                   | `greenhouse/harvest-v2`            | Greenhouse [Harvest API v2](https://developers.greenhouse.io/harvest.html). We automatically authenticate all requests using the API key and use `https://harvest.greenhouse.io/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Greenhouse                   | `greenhouse/harvest`               | Greenhouse [Harvest API v1](https://developers.greenhouse.io/harvest.html). We automatically authenticate all requests using the API key and use `https://harvest.greenhouse.io/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Greenhouse                   | `greenhouse/harvestv3`             | We use `https://harvest.greenhouse.io/v3` as the base URL. Find the official docs [here](https://harvestdocs.greenhouse.io/reference/).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| GuideCom                     | `guidecom/api`                     | GuideCom's API. We automatically authenticate all requests and use the configured API base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Gusto                        | `gusto/v1`                         | [Gusto API](https://docs.gusto.com/app-integrations/docs/introduction). We automatically authenticate all requests with OAuth and use `\{api_base_url\}/v1` as the base URL (`https://api.gusto.com/v1` in production, `https://api.gusto-demo.com/v1` in development).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Hailey HR                    | `haileyhr/api`                     | Hailey HR's [API](https://api.haileyhr.app/docs/index.html). We automatically authenticate all requests using the provided credentials and use `https://api.haileyhr.app` as the base URL. Connections created against the `DEMO` remote environment are routed to `https://api.demo.haileyhr.app` instead.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Hansalog                     | `hansalog/vision`                  | Hansalog's [Vision API](https://hansalog-vision.document360.io/docs/). We automatically authenticate all requests and use `https://\{subdomain\}.hansalog-cloud.de/vision` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Haufe Umantis                | `umantis/v1`                       | [Umantis API v1](https://recruitingapp-91005709.umantis.com/api/v1/swagger-ui). We automatically authenticate all requests and use `https://\{subdomain\}.umantis.com/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| HeavenHR                     | `heavenhr/v2`                      | [HeavenHR API](https://api.heavenhr.com/). We automatically authenticate all requests using the provided credentials and use `https://api.heavenhr.com/api/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Heyrecruit                   | `heyrecruit/v2`                    | [Heyrecruit's v2 API](https://documenter.getpostman.com/view/23241256/2s9YysBLcf#47e271ac-47c8-4c75-9cc6-b8c506e9dad6). We automatically authenticate all requests using the client ID and secret and use `https://app.heyrecruit.de/api/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| HiBob                        | `hibob/docs`                       | This passthrough is only used for fetching employee documents in HiBob. It is present as a workaround while we are working on a new endpoint for fetching documents in HRIS. It should not be used for any other purpose. We automatically authenticate all requests using the service user credentials and use `https://app.hibob.com/api/docs/employees/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| HiBob                        | `hibob/hire`                       | [HiBob's Hire API](https://apidocs.hibob.com/docs/how-to-integrate-with-ats-hire-api). We automatically authenticate all requests using the hire service user credentials. The base URL is configured during the integration setup.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| HiBob                        | `hibob/v1`                         | [HiBob's v1 API](https://apidocs.hibob.com/reference/get_people). We automatically authenticate all requests using the service user credentials (or, for old integrations, the API key) and use `https://api.hibob.com/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| HoorayHR                     | `hoorayhr/api`                     | [HoorayHR API](https://api.hoorayhr.io/documentation/). We automatically authenticate all requests and use `https://api.hoorayhr.io` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                               |
| HR Office                    | `hroffice/soap`                    | [HROffice SOAP API](https://api.hroffice.nl/HROfficeCoreService.asmx). We automatically authenticate all requests and wrap them in a SOAP envelope. Build the request `Body` with the raw XML parameters for your operation (e.g., `\<languageId\>1\</languageId\>`). Use `/` as your `path`. Set your `method` to `POST`. You need to specify the `api_options` object and set `operation_name` to the SOAP operation you want to call (e.g., `GetAllJobByLanguage`).                                                                                                                                                                                                                                                                                                                                              |                                                               |
| HR WORKS                     | `hrworks/v2`                       | HRWorks's v2 [API](https://developers.hrworks.de/2.0/endpoints). We automatically authenticate all requests using the customer credentials.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| HR4YOU                       | `hr4you/v2`                        | [HR4YOU's v2 API](https://apiprodemo.hr4you.org/api2/docs). We automatically authenticate all requests and use the customers provided base URL (e.g. `https://your-company.hr4you.org/` or a custom domain).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Humaans                      | `humaans/api`                      | Humaans' [API](https://docs.humaans.io/api/). We automatically authenticate all requests using the API key and use `https://app.humaans.io/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| iCIMS                        | `icims/default`                    | [iCIMS Default API](https://developer-community.icims.com/). We automatically authenticate all requests and use `https://api.icims.com/customers/\{customer_id\}` as the base url.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| InRecruiting by Zucchetti    | `inrecruiting/default`             | [inRecruiting's v3 API](https://inrecruiting.intervieweb.it/api-docs/). We automatically authenticate all requests and use the customers domain as base URL                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Insperity                    | `insperity/api`                    | Insperity [APIs](https://developer.insperity.com/) We automatically authenticate all requests and use `https://api.insperity.com` as the base URL. For staging environments, we use `https://apistage.insperity.com`. Note that all requests require the company ID to be specified in the path or body.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| IRIS Cascade                 | `iriscascade/v2`                   | IRIS Cascade HR [API](https://swagger.hrapi.co.uk/). We automatically authenticate all requests using the provided credentials and use `https://api.iris.co.uk/hr/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| JazzHR                       | `jazzhr/v1`                        | [JazzHR's v1 API](https://www.resumatorapi.com/v1/#!`).We automatically authenticate all requests and use "[https://api.resumatorapi.com/v1/](https://api.resumatorapi.com/v1/)" as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| JobAdder                     | `jobadder/api`                     | We use `https://api.jobadder.com/v2` as the base URL. Find the official docs [here](https://api.jobadder.com/v2/docs).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| JobDiva                      | `jobdiva/api`                      | We automatically authenticate all requests and use `https://api.jobdiva.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Jobvite                      | `jobvite/api`                      | We automatically authenticate all requests and use '[https://api.jobvite.com/api/v2](https://api.jobvite.com/api/v2)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Jobvite                      | `jobvite/v2`                       | We use `https://api.jobvite.com/api/v2` as the base URL. Find the official docs [here](https://help.jobvite.com/hc/en-us/articles/8870636608925-Jobvite-API).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Jobylon                      | `jobylon/feed`                     | The [Jobylon Feed API](https://developer.jobylon.com/feed-api/). We automatically authenticate all requests and use `https://\{subdomain\}.jobylon.com/feeds/\{job_hash\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Jobylon                      | `jobylon/push`                     | The [Jobylon Push API](https://developer.jobylon.com/push-api-and-webhooks/). We automatically authenticate all requests and use `https://\{subdomain\}.jobylon.com/p1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| JOIN                         | `join/v2`                          | Join's [V2 API](https://docs.join.com/reference/getting-started). We automatically authenticate all requests and use `https://api.join.com/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Kenjo                        | `kenjo/api`                        | Kenjo's [API](https://kenjo.readme.io/reference/generate-the-api-key). We automatically authenticate all requests using the API key. The base URL is `https://api.kenjo.io/` (or `https://sandbox-api.kenjo.io/` for sandbox environments).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Kula                         | `kula/v1`                          | Kula's [REST API](https://developers.kula.ai/docs/getting-started/overview). We automatically authenticate all requests with the provided credentials and use `https://api.kula.ai/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Lattice Talent               | `latticetalent/talent`             | Lattice's [Talent API](https://developers.lattice.com/reference/introduction). We automatically authenticate all requests using API key credentials with `https://api.latticehq.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                               |
| Lattice                      | `lattice/passthrough`              | Lattice's [API](https://developers.lattice.com/v2/docs/base-url-1). We automatically authenticate all requests using OAuth credentials with `https://api.latticehq.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Lattice                      | `lattice/talent`                   | Lattice's [Talent API](https://developers.lattice.com/docs/introduction-1). We automatically authenticate all requests using OAuth credentials with `https://api.latticehq.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| Laura                        | `laura/api`                        | We automatically authenticate all requests and use `https://\{subdomain\}.rekrytointi.com/api/v1.2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Leapsome                     | `leapsome/scim`                    | Leapsome [SCIM API](https://api.leapsome.com/scim/v1/api-docs/). We automatically authenticate all requests using the credentials supplied by the customer and use `https://api.leapsome.com/scim/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Leapsome                     | `leapsome/v1`                      | Leapsome [API](https://api.leapsome.com/v1/api-docs/). We automatically authenticate all requests using the credentials supplied by the customer and use `https://api.leapsome.com/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Lever                        | `lever/v1`                         | [Lever's v1 API](https://hire.lever.co/developer/documentation). We automatically authenticate all requests using the partner credentials which have been configured in the Lever tool settings (this uses Kombo's partner credentials by default).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| LinkedIn Learning            | `linkedinlearning/v2`              | LinkedIn Learning [API v2](https://learn.microsoft.com/en-us/linkedin/learning/).  We automatically handle authentication and use `https://api.linkedin.com/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| Logic Melon                  | `logicmelon/json`                  | We use `https://api.logicmelon.co.uk` as the base URL. Find the official docs [here](https://api.logicmelon.com/JSON/Multiposter.asmx).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Loket                        | `loket/api`                        | [Loket's REST API](https://developers.loket.nl/). We automatically authenticate all requests and use `https://\{api_domain\}` as the base URL, where `api_domain` is the API domain configured during integration setup (e.g. `api.loket.nl`).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Loxo                         | `loxo/v1`                          | [Loxo's API](https://loxo.readme.io/reference/loxo-api). We automatically authenticate all requests and use '[https://app.loxo.co/api/\\\{agency\_slug\\}](https://app.loxo.co/api/\\\{agency_slug\\})' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Lucca                        | `lucca/api`                        | [Luccas's API](https://developers.lucca.fr/api-reference/legacy/introduction). We automatically authenticate all requests and use 'https\://\{account}.\{ilucca                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | ilucca-demo}.\{region}/' as the base URL.                     |
| Manatal                      | `manatal/career-page`              | Manatal's Career Page API. We use `https://api.manatal.com/open/v3/career-page/\{client_slug\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| Manatal                      | `manatal/open-api-v3`              | [Manatal's Open API v3](https://developers.manatal.com/reference/getting-started). We automatically authenticate all requests and use `https://api.manatal.com/open/v3` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Mercury                      | `mercury/v1`                       | Mercury's [V1 API](https://apim-uks-thirdpartyintegration-prod.azure-api.net/swagger/index.html?urls.primaryName=V1). We automatically authenticate all requests with the `subscription-key` and `tenant-id` headers and use the configured server URL with `/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Mercury                      | `mercury/v2`                       | Mercury's [V2 API](https://apim-uks-thirdpartyintegration-prod.azure-api.net/swagger/index.html?urls.primaryName=V2). We automatically authenticate all requests with the `subscription-key` and `tenant-id` headers and use the configured server URL with `/api/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Mercury                      | `mercury/v3`                       | Mercury's [V3 API](https://apim-uks-thirdpartyintegration-prod.azure-api.net/swagger/index.html?urls.primaryName=V3). We automatically authenticate all requests with the `subscription-key` and `tenant-id` headers and use the configured server URL with `/api/v3` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| MHR People First             | `peoplefirst/v1`                   | MHR People First [v1 API](https://docs.people-first.com/api/api-docs/api-docs.html). We automatically authenticate all requests using the access token and tenant/environment codes. For default environments, we use `https://\{tenant_code\}.people-first.com/api/v1` as the base URL. For non-default environments, we use `https://\{tenant_code\}-\{environment_code\}.people-first.com/api/v1`.                                                                                                                                                                                                                                                                                                                                                                                                               |                                                               |
| Microsoft Azure AD           | `azuread/v1`                       | [AzureAD's API](https://learn.microsoft.com/en-us/graph/api/resources/identity-network-access-overview?view=graph-rest-1.0). We automatically authenticate all requests.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Microsoft Entra ID           | `entraid/v1`                       | [AzureAD's API](https://learn.microsoft.com/en-us/graph/api/resources/identity-network-access-overview?view=graph-rest-1.0). We automatically authenticate all requests.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Moodle                       | `moodle/rest`                      | Moodle REST Web Services API. All calls go to `/webservice/rest/server.php` with `wsfunction` and `wstoken` parameters. We automatically handle authentication and use `\{site_url\}/webservice/rest/server.php` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| Mysolution                   | `mysolution/default`               | [Mysolution's API](https://swagger.mysolution.nl/). We automatically authenticate all requests and use the customer's domain as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Nmbrs                        | `nmbrs/soap`                       | [Nmbrs SOAP API](https://api.nmbrs.nl/soap/v3/). We automatically authenticate all requests and use `https://api.nmbrs.nl/soap/v3/` as the base URL. Set `data` to your raw XML string (the content that will be placed inside the `\<soap:Body\>` tag). Use `/` as your `path`, as we will always send requests to `https://api.nmbrs.nl/soap/v3/\{service_name\}.asmx`. Set your `method` to `POST`. You need to specify the `api_options` object and set `service_name` to the name of the service you want to call. Available services include `EmployeeService` and `CompanyService`.                                                                                                                                                                                                                          |                                                               |
| Odoo                         | `odoo/json2`                       | Odoo's [JSON-2 API](https://www.odoo.com/documentation/19.0/developer/reference/external_api.html). We automatically authenticate all requests and use `https://\{domain\}.odoo.com/json/2` as the base URL. Odoo JSON-2 requests are always `POST` requests and use paths like `/\{model\}/\{method\}` (e.g. `/res.partner/search_read`).                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Okta                         | `okta/v1`                          | [Okta's API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/ApiServiceIntegrations/). We automatically authenticate all request ans use 'https\://\<your-okta-domain>/api/v1' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Onlyfy                       | `onlyfy/v1`                        | Onlyfy's [Public v1 REST API](https://onlyfy.io/doc/v1#section/Introduction). We automatically authenticate all requests using the `apikey` header and use `https://api.prescreenapp.io/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Oracle HCM                   | `oraclehcm/api`                    | Oracle HCM Cloud [REST API](https://docs.oracle.com/en/cloud/saas/human-resources/24d/farws/index.html). We automatically authenticate all requests and use `https://\{domain\}/` as the base URL, where domain is your Oracle Cloud domain.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Oracle Recruiting Cloud      | `oraclerecruiting/rest`            | [Oracle's REST API](https://docs.oracle.com/en/cloud/saas/human-resources/24d/farws/rest-endpoints.html). We automatically authenticate all requests and use 'https\://\{company\_url}' as the base url.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Oracle Recruiting Cloud      | `oraclerecruiting/rest`            | [Oracles's REST API](https://docs.oracle.com/en/cloud/saas/human-resources/24d/farws/rest-endpoints.html). We automatically authenticate all requests and use 'https\://\{company\_url}' as the base url.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Oracle Taleo                 | `taleo/soap`                       | [Taleo's API](https://docs.oracle.com/en/cloud/saas/taleo-enterprise/23b/otwsu/c-taleoapi.html). We automatically authenticate all requests and use 'https\://\{your-subdomain}.taleo.net/enterprise/soap' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| OTYS                         | `otys/json-rpc`                    | [OTYS JSON-RPC API](https://ows.otys.nl/info/). We authenticate with your stored API key and inject the session token as the first element of the JSON-RPC `params` array on each request (except `loginByUid`, which uses `params` as sent). Requests use `https://ows.otys.nl` as the base URL (for example `POST /jservice.php` with the RPC method in the URL fragment, matching OTYS conventions).                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| PageUp People                | `pageup/v1`                        | We use `https://assessment-mock-api.dc0.pageuppeople.com` as the base URL. Find the official docs [here](https://developers.pageuppeople.com/Api/Partners/Assessment).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| PageUp People                | `pageup/v3`                        | We use `https://\<environment\>.\<dataCentreId\>.pageuppeople.com/v3/\<tenantId\>/recruitment` as the base URL. Find the official docs [here](https://developers.pageuppeople.com/Api/Recruitment).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Paradox                      | `paradox/v1`                       | We use `\{api_url\}/api/v1` as the base URL. Find the official docs [here](https://paradox.readme.io/).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Paradox                      | `paradox/v1public`                 | We use `\{api_url\}/api/v1/public` as the base URL. Find the official docs [here](https://paradox.readme.io/).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Paychex                      | `paychex/api`                      | Paychex [REST API](https://developer.paychex.com/documentation). We automatically authenticate all requests and use `https://api.paychex.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Paycom                       | `paycom/v1`                        | Paycom's REST API. We automatically authenticate all requests using the provided SID and API Token and use `https://api.paycomonline.net/v4/rest/index.php/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Paycor                       | `paycor/v1`                        | [Paycors's v1 API](https://developers.paycor.com/explore#section/Getting-Started). We automatically authenticate all requests and use '[https://apis.paycor.com](https://apis.paycor.com)'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| PayFit                       | `payfitcustomer/api`               | PayFit [Partner API](https://developers.payfit.io/reference). We automatically authenticate all requests using the provided API key and use `https://partner-api.payfit.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| PayFit                       | `payfitpartner/partner-api`        | PayFit [Partner API](https://developers.payfit.io/reference). We automatically authenticate all requests using the OAuth access token and use `https://partner-api.payfit.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Paylocity                    | `paylocity/default`                | [Paylocity's Weblink API](https://developer.paylocity.com/integrations/reference/authentication-weblink). We automatically authenticate all requests and use 'https\://\{api                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | dc1demogw}.paylocity.com/' as the base URL.                   |
| Paylocity                    | `paylocity/next-gen`               | [Paylocity's NextGen API](https://developer.paylocity.com/integrations/reference/authentication). We automatically authenticate all requests and use '[https://dc1prodgwext.paylocity.com/](https://dc1prodgwext.paylocity.com/)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| PeopleHR                     | `peoplehr/default`                 | [PeopleHR's API](https://apidocs.peoplehr.com/#). We automatically authenticate all request ans use '[https://api.peoplehr.net](https://api.peoplehr.net)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| PeopleXD                     | `peoplexd/b2b`                     | PeopleXD's [B2B API](https://documenter.getpostman.com/view/3101638/TzeTHUDu#intro). We automatically authenticate all requests and use `https://api.corehr.com/ws/\{tenant_id\}/corehr` or `https://uatapi.corehr.com/ws/\{tenant_id\}/corehr` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| Personio                     | `personio/jobboard`                | API endpoints exposed on Personio's public job board pages ([currently just the XML feed](https://developer.personio.de/reference/get_xml)). We automatically use the right `https://\{company\}.jobs.personio.de` base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Personio                     | `personio/personnel`               | Personio's [Personnel Data API](https://developer.personio.de/reference/get_company-employees). We automatically authenticate all requests using the client ID and secret and use `https://api.personio.de/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Personio                     | `personio/personnelv2`             | Personio's [V2 Personnel Data API](https://developer.personio.de/v2.0/reference/introduction). We automatically authenticate all requests using the client ID and secret and use `https://api.personio.de/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Personio                     | `personio/recruiting`              | Personio's [Recruiting API](https://developer.personio.de/reference/get_company-employees). We automatically authenticate all requests using the Recruiting access token and use `https://api.personio.de/v1/recruiting` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Personio                     | `personio/recruitingV2`            | Personio's [V2 Recruiting API](https://developer.personio.de/reference/get_v2-recruiting-applications). We automatically authenticate all requests using the Recruiting access token, send the `Beta` header and use `https://api.personio.de/v2/recruiting` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Phenom                       | `phenom/rest-api`                  | The [Phenom API](https://developer.phenom.com/). We automatically authenticate all requests and use `https://api-stg.phenompro.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Pinpoint                     | `pinpoint/v1`                      | Pinpoint's [JSON:API](https://developers.pinpointhq.com/docs). We automatically authenticate all requests using the `X-API-KEY` header and use `https://\{subdomain\}.pinpointhq.com/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Planday                      | `planday/api`                      | Planday's [HR API v1.0](https://openapi.planday.com/api/hr?version=v1.0). We automatically authenticate all requests and use `https://openapi.planday.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Recruit CRM                  | `recruitcrm/api`                   | We use `https://api.recruitcrm.io` as the base URL. Find the official docs [here](https://docs.recruitcrm.io/docs/rcrm-api-reference/ZG9jOjMyNzk0NA-getting-started).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                               |
| RecruiterFlow                | `recruiterflow/v1`                 | RecruiterFlow API [docs](https://docs.recruiterflow.com/). We automatically authenticate all requests using the RF-Api-Key header and use `https://api.recruiterflow.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Remote                       | `remotecom/default`                | Remote's [API](https://remote.com/resources/api/getting-started). We automatically authenticate all requests using provided credentials. The base URL is `https://gateway.remote.com/v1` for production API keys (prefixed `ra_live_`), or `https://gateway.remote-sandbox.com/v1` for sandbox API keys.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| rexx systems                 | `rexx/default`                     | Rexx's HRIS export API. There is only one endpoint: `Get /`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Rippling                     | `rippling/api`                     | Rippling's [API](https://developer.rippling.com/documentation). We automatically authenticate all requests and use `https://api.rippling.com/platform/api` or`https://rest.ripplingapis.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Sage HR                      | `sagehr/api`                       | Sage HR's [API](https://developer.sage.com/hr/reference/api-ref). We automatically authenticate all requests and use `https://\{subdomain\}.sage.hr/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Sage People                  | `sagepeople/salesforce-rest-api`   | Sage People is built on Salesforce's [API](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_what_is_rest_api.htm). We automatically authenticate all requests and use `https://\{customer_name\}.my.salesforce.com/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| SAP SuccessFactors           | `successfactors/lms-odata-v4`      | We use `https://\{api_domain\}/learning/odatav4` as the base URL. Find the official docs [here](https://help.sap.com/docs/successfactors-learning/sap-successfactors-learning-odata-apis).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| SAP SuccessFactors           | `successfactors/odata-v2`          | [SuccessFactors' OData V2 API](https://help.sap.com/doc/74597e67f54d4f448252bad4c2b601c9/2211/en-US/SF_HCM_OData_API_REF_en.pdf). We automatically authenticate all requests and use `https://\{api_domain\}\{path?\}/odata/v2` as the base URL (the optional `\{path\}` is used when connecting via proxied/gateway domains).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| SD Worx                      | `sdworx/default`                   | SD Worx's [OData API](https://apistaging.cobra.sdworx.com/Resources). We automatically authenticate all requests using the client ID and secret and use `\{api_url\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Silae                        | `silae/rest`                       | [Silae's REST API](https://silae-api.document360.io/docs). We automatically authenticate all requests and use '[https://payroll-api.silae.fr/payroll](https://payroll-api.silae.fr/payroll)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Simployer                    | `simployer/v1`                     | [AlexisHR's v1 API](https://docs.alexishr.com/) We automatically authenticate all requests and use `https://\{subdomain\}.alexishr.com` as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| SmartRecruiters              | `smartrecruiters/default`          | Smartrecruiters [API](https://developers.smartrecruiters.com/reference/apply-api). We automatically authenticate all requests using OAuth and use `https://api.smartrecruiters.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| SmartRecruiters              | `smartrecruiters/default`          | Smartrecruiters [API](https://developers.smartrecruiters.com/reference/apply-api). We automatically authenticate all requests using the credentials supplied by the customer and use `https://api.smartrecruiters.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Softgarden                   | `softgarden/apply-api`             | [Softgarden's Apply API](https://dev.softgarden.de/apply-api/). We automatically authenticate all requests and use '[https://jobdb.softgarden.de/jobdb/public](https://jobdb.softgarden.de/jobdb/public)' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Softgarden                   | `softgarden/frontend-v3`           | \[Softgarden's Frontend API v3]\([https://dev.softgarden.de/frontend-v3/](https://dev.softgarden.de/frontend-v3/). We automatically authenticate all requests and use '[https://api.softgarden.io/api/rest](https://api.softgarden.io/api/rest)' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Spark Hire Recruit           | `comeet/api`                       | [Spark Hire Recruit's API.](https://developers.comeet.com/reference/recruiting-api-overview)We automatically authenticate all requests and use `https://api.comeet.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Spott                        | `spott/protected`                  | The [Spott API](https://docs.gospott.com). We automatically authenticate all requests and use `https://api.gospott.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Sympa                        | `sympa/api`                        | Sympa's [API](https://documenter.getpostman.com/view/33639379/2sA3kXG1vX#intro). We automatically authenticate all requests and use `https://api.sympahr.net/api/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Taleez                       | `taleez/0`                         | [Taleez's API](https://api.taleez.com/swagger-ui/index.html). We automatically authenticate all requests and use `https://api.taleez.com/0` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Talention                    | `talention/v1`                     | Talention's API. We automatically authenticate all requests and use `https://\{api_domain\}/tms/\{account_id\}/external/api/1.0` as the base URL. Documentation is provided privately by Talention. Contact Kombo support for assistance with specific endpoints.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| TalentLMS                    | `talentlms/v2`                     | We use `https://\{subdomain\}.talentlms.com/api/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Teamtailor Job Boards        | `teamtailorjobboards/direct-apply` | Teamtailor's [Job Board Direct Apply API](https://partner.teamtailor.com/job_boards/direct_apply/#direct-apply). We automatically authenticate all requests and use `https://5qbn6o9x4h.execute-api.eu-west-1.amazonaws.com/production` as the base URL. All requests are automatically signed with HMAC-SHA256 signature.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Teamtailor                   | `teamtailor/v1`                    | We use `https://api.teamtailor.com/v1` as the base URL. Find the official docs [here](https://docs.teamtailor.com/).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Tellent Recruitee            | `recruitee/default`                | The [Recruitee API](https://api.recruitee.com/docs/index.html). We automatically authenticate all requests and use `https://api.recruitee.com/c/\{company_id\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| Tellent Recruitee            | `recruitee/v1`                     | We use `https://api.recruitee.com/c/\{company_id\}` as the base URL. Find the official docs [here](https://docs.recruitee.com/reference).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| TrackerRMS                   | `trackerrms/v1`                    | We use `https://evousapi.tracker-rms.com` as the base URL. Find the official docs [here](https://evousapi.tracker-rms.com/swagger/index.html).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| TRAFFIT                      | `traffit/v2`                       | Traffit's [v2 API](https://api.traffit.com). We authenticate all requests with the Traffit API key and use the base URL `https://yourdomain.traffit.com/api/integration/v2`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| TriNet PEO                   | `trinetpeo/v1`                     | We use `https://api.trinet.com` as the base URL. Find the official docs [here](https://developers.trinet.com).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Ubeeo                        | `ubeeo/api`                        | Ubeeo ATS API. We automatically authenticate all requests using OAuth client credentials and use `https://api.ats-platform.com` as the base URL (sandbox: `https://api.acc.ats-platform.com`).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Udemy Business               | `udemy/learning`                   | Udemy Business REST API. We automatically handle authentication and use `https://\{account_name\}.udemy.com/api-2.0/organizations/\{account_id\}/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| UKG Pro WFM                  | `ukgprowfm/api`                    | UKG Pro WFM's [API](https://developer.ukg.com/wfm/reference/welcome-to-the-ukg-pro-workforce-management-api). We automatically authenticate all requests and use `https://\{hostname\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| UKG Pro                      | `ukgpro/default`                   | [UKG Pro's HRIS API](https://developer.ukg.com/hcm/reference/get_personnel-v1-person-details). We automatically authenticate all requests and use  `https://\{hostname\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| UKG Pro                      | `ukgpro/recruting`                 | [UKG Pro's Recruiting API](https://developer.ukg.com/hcm/reference/retrieveapplications). We automatically authenticate all requests and use  `https://\{hostname\}/talent/recruiting/v2/\{tenantalias\}/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| UKG Ready                    | `ukgready/api`                     | UKG Ready [API](https://secure.saashr.com/ta/docs/rest/public/). We automatically authenticate all requests using the provided credentials and use `https://\{api_domain\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Visma Peple                  | `peple/hrm`                        | [Visma Payroll Reporting API](https://api.analytics1.hrm.visma.net/docs/openapi.html). We automatically authenticate all requests using the client credentials and use '[https://api.analytics1.hrm.visma.net](https://api.analytics1.hrm.visma.net)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Visma Raet - Youforce        | `youforce/v1.0`                    | [Youforce's basic v1.0 API](https://vr-api-integration.github.io/youforce-api-documentation/postman_collections.html). We automatically authenticate all requests and use '[https://api.youforce.com](https://api.youforce.com)' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Visma YouServe               | `youserve/learning`                | Visma YouServe [Learning API](https://youserve-domain-api.github.io/SwaggerUI/learning.html). We automatically authenticate all requests using OAuth 2.0 with the provided credentials and use `https://api.youserve.nl/learning/v1.0` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Workable                     | `workable/v1`                      | **Deprecated: Use `v3` instead.** Workable's [API](https://workable.readme.io/reference/generate-an-access-token). We automatically authenticate all requests using the client ID and secret and use `https://\{subdomain\}.\{environment\}.com/spi/v3` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Workable                     | `workable/v3`                      | Workable's [API](https://workable.readme.io/reference/generate-an-access-token). We automatically authenticate all requests using the client ID and secret and use `https://\{subdomain\}.\{environment\}.com/spi/v3` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Workday                      | `workday/custom-report`            | [Workday's Custom Reports](https://community.workday.com/sites/default/files/file-hosting/productionapi/index.html). We automatically authenticate all requests and use `https://\{domain\}/ccx/service/customreport2/\{tenant\}/` as the base URL. Set your `method` to `GET`. The `path` should be the report path after the tenant, e.g., `/\{report_owner\}/\{report_name\}`. You can include query parameters in the `params` object (e.g., `format=json`).                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| Workday                      | `workday/rest`                     | [Workday's REST API](https://community.workday.com/sites/default/files/file-hosting/restapi/index.html). We automatically authenticate all requests and use the correct Workday REST base URL for your tenant. The base URL follows the format: https\://\{domain}/api/\{service\_name}/\{version}/\{tenant}. You can specify any valid REST endpoint and method. See the Workday REST API documentation for available endpoints. You must specify the `api_options` object and set `service_name` to the name of the service you want to call. You can also specify the `version` (e.g., "v1", "v2"); if omitted, it defaults to "v1".                                                                                                                                                                             |                                                               |
| Workday                      | `workday/soap`                     | [Workday's SOAP API](https://community.workday.com/sites/default/files/file-hosting/productionapi/index.html). We automatically authenticate all requests. Set `data` to your raw xml string. Use `/` as your `path`, as we will always send requests to `https://\{domain\}/ccx/service/\{tenant\}/\{service_name\}`. Set your `method` to `POST`. You need to specify the `api_options` object and set `service_name` to the name of the service you want to call. Find all available services [here](https://community.workday.com/sites/default/files/file-hosting/productionapi/versions/v41.0/index.html). The string that you submit as `data` will be the content of the `soapenv:Body` tag in the request. You can set the `service_version` to any valid Workday service version (the default is `38.2`). |                                                               |
| workforce.com                | `workforcecom/api`                 | Workforce.com [API](https://my.workforce.com/api/v2/documentation). We automatically authenticate all requests using the provided credentials and use `https://my.tanda.co` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Zelt                         | `zelt/partner`                     | Zelt's [Partner API](https://go.zelt.app/apiv2/swagger). We automatically authenticate all requests using the connected OAuth credentials and use `https://go.zelt.app/apiv2/partner` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Zoho Recruit                 | `zohorecruit/v2`                   | Zoho Recruit's [V2 API](https://www.zoho.com/recruit/developer-guide/apiv2/modules-api.html). We automatically authenticate all requests and use `https://recruit.\{domain\}/recruit/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Zvoove Recruit               | `zvooverecruit/applicants`         | [Zvoove Recruit's Applicants API](https://api.zvoove.com/docs/). We automatically authenticate all requests using the applicants API key and use 'https\://\{domain}/api/public' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Zvoove Recruit               | `zvooverecruit/jobs`               | [Zvoove Recruit's Jobs API](https://api.zvoove.com/docs/). We automatically authenticate all requests using the jobs API key and use 'https\://\{domain}/api/public' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |

<Note>Please note that the passthrough API endpoints are only meant for edge cases. That's why we only expose them for new integrations after understanding a concrete customer use case. If you have such a use case in mind, please reach out to Kombo.</Note>


# Create provisioning setup link (deprecated)
Source: https://docs.kombo.dev/hris/v1/post-provisioning-groups-group-id-setup-links

POST /hris/provisioning-groups/{group_id}/setup-links
Create a new link that can be passed to the Kombo Connect SDK to open the provisioning setup UI.

<Warning>
  **This endpoint is deprecated!**

  Please use the [Create Setup Flow link endpoint](/v1/post-integrations-integration-id-setup-link) instead. It supports the full Setup Flow (including filtering, field mapping, and any other enabled steps) and works for any integration category, not just HRIS.
</Warning>


# Upsert employee skill proficiency rating
Source: https://docs.kombo.dev/hris/v1/post-skill-proficiency-ratings

POST /hris/skill-proficiency-ratings
Assign a skill to an employee with an optional proficiency rating, attributed to the provider configured in the settings. Re-sending the same skill and source overwrites the existing rating.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/hris/connectors/workday">Workday</a></li>
    <li><img /><a href="/hris/connectors/oraclehcm">Oracle HCM</a></li>
    <li><img /><a href="/hris/connectors/sandbox">Kombo Sandbox</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

<Note>
  This endpoint requires the permission **Manage employee skill proficiency ratings** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "employee_id": "26vafvWSRmbhNcxJYqjCzuJg",
  "skill_id": "28KMdr68N8kG9EzLwjsN9aoz",
  "rating": {
    "rating_source": "EXTERNAL",
    "proficiency": 4
  }
}
```


# Upsert managed skill
Source: https://docs.kombo.dev/hris/v1/post-skills

POST /hris/skills
Create or update a skill in the catalog managed by your system.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/hris/connectors/workday">Workday</a></li>
    <li><img /><a href="/hris/connectors/sandbox">Kombo Sandbox</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Stores the skill in Kombo immediately and only sends it to the HRIS during subsequent syncs. This lets you submit thousands of skills without worrying about the rate limits of the remote system.

<Note>
  This endpoint requires the permission **Manage skill catalog** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "origin_id": "skill-1",
  "name": "TypeScript Programming",
  "status": "ACTIVE"
}
```


# Upsert staffing entity skill expectation
Source: https://docs.kombo.dev/hris/v1/post-staffing-entities-staffing-entity-id-skills

POST /hris/staffing-entities/{staffing_entity_id}/skills
Add a skill expectation on a staffing entity, with an optional expected proficiency level. Re-sending the same skill updates the expectation in place.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/hris/connectors/workday">Workday</a></li>
    <li><img /><a href="/hris/connectors/sandbox">Kombo Sandbox</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

<Note>
  This endpoint requires the permission **Manage staffing entity skills** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "skill_id": "28KMdr68N8kG9EzLwjsN9aoz",
  "expected_proficiency": 4
}
```


# Set integration enabled
Source: https://docs.kombo.dev/hris/v1/put-integrations-integration-id-enabled

PUT /integrations/{integration_id}/enabled
Enable or disable the specified integration. When disabling, all currently running syncs will be cancelled.

All authentication credentials and configuration are preserved. Syncs can be resumed by re-enabling the integration.

You may use this to, for example, pause syncing for customers that are temporarily not using the integration.


# Introduction
Source: https://docs.kombo.dev/introduction

Learn how you can put integrations on autopilot through Kombo’s unified APIs.

Welcome to the Kombo docs! You’ve come to the right place to learn more about how Kombo can help you build integrations faster and more reliably.

### **What is Kombo?**

Kombo offers unified APIs for HR Tech. We allow our customers to build a single integration to Kombo and instantly launch all the HRIS and ATS integrations in **[Kombo’s ever-growing portfolio](https://www.kombo.dev/categories/all)** to their customers.

We do this by standardizing the data models exposed by the integrations we support and allowing you to interact with the unified models using a set of clearly defined endpoints.

This way, reading employees from an enterprise HR solution like **[SAP SuccessFactors](https://www.kombo.dev/integrations/successfactors)** will look the same as reading employees from a more SMB-focused tool like **[Personio](https://www.kombo.dev/integrations/personio)**. It’s the same set of data models and fields you can rely on.

### Unified APIs

When building multiple integrations for different tools, the effort and time spent both to build and maintain these integrations can quickly rack up. With Kombo, you don’t have to worry about the complexity of the tool; you’ll receive data in the same format for every tool you choose to support.

We offer a separate unified interface per software category. Click on one of the buttons below to learn more about the data models and write-actions we provide per category.

<CardGroup>
  <Card title="Unified HRIS API" icon="users" href="/hris/introduction">
    Learn how you can read employee data, manage absences, and more through
    Kombo's API.
  </Card>

  <Card title="Unified LMS API" icon="graduation-cap" href="/lms/introduction">
    Learn how you can read users, courses, and track learning progress through
    Kombo's LMS API.
  </Card>

  <Card title="Unified ATS API" icon="briefcase" href="/ats/introduction">
    Learn how you can read jobs, create and track candidates, and more through
    Kombo's API.
  </Card>

  <Card title="Unified ATS-Assessment API" icon="briefcase" href="/assessment/introduction">
    Learn how you can write assessments to an ATS, receive notifications about
    completed ones and then send the results back, and more through Kombo's API.
  </Card>
</CardGroup>

## Further resources

Explore our other resources to learn more about Kombo.

<CardGroup>
  <Card title="Official SDKs" icon="code" href="/libraries-and-sdks">
    Use our official SDKs for ergonomic and type-safe API interactions.
  </Card>

  <Card title="OpenAPI Schema" icon="brackets-curly" href="https://api.kombo.dev/openapi.json">
    Download our OpenAPI schema for testing and code generation.
  </Card>

  <Card title="Integrations" icon="grid-2" href="https://www.kombo.dev/categories/all">
    See what integrations we already offer across our categories.
  </Card>

  <Card title="Security Portal" icon="shield" href="https://security.kombo.dev">
    Find answers to all your security and compliance questions.
  </Card>

  <Card title="Contact Us" icon="message-question" href="mailto:support@kombo.dev">
    Have a question that isn't answered here? We're always happy to help!
  </Card>
</CardGroup>


# KomboAI
Source: https://docs.kombo.dev/kombo-ai

Get account-aware technical support in your shared channel

KomboAI is Kombo's account-aware support agent in your shared Slack or Microsoft
Teams channel. It combines technical knowledge about Kombo and supported
providers with read-only context from your Kombo account to give answers that
reflect your setup.

## See KomboAI in action

<Tabs>
  <Tab title="Provider setup">
    <Frame>
      <img alt="KomboAI identifies the Workday security domain and access level required to push candidate tags" />
    </Frame>
  </Tab>

  <Tab title="Connector feasibility">
    <Frame>
      <img alt="KomboAI explains the feasibility, coverage, and setup requirements for a connector" />
    </Frame>
  </Tab>
</Tabs>

## What KomboAI can help with

### Assess feasibility

Determine whether a provider supports the data, actions, and workflows your
product needs. KomboAI can also explain setup requirements such as permissions,
scopes, credentials, certificates, sandbox access, and provider partnerships.

### Explain provider behavior

Understand provider-specific APIs, permissions, field mappings, IDs, filters,
normalization, sync behavior, and known limitations.

### Troubleshoot account-specific issues

Investigate linked accounts, effective scope configurations, and recent
interactions. KomboAI can also inspect logs to help narrow down missing fields,
failed requests, and connection issues.

## Use KomboAI

<Note>
  KomboAI must be enabled for your account by Kombo support. Ask our team in
  your shared support channel to activate it.
</Note>

Once enabled, mention `@KomboAI` in a message to ask a question or follow up on
an answer. Some support channels are configured for proactive responses, where
KomboAI considers new messages and responds when it can usefully contribute.

For the most useful answer, include the provider or linked account, what you
expected, what happened instead, and any relevant error or screenshot. For a
specific sync, API request, webhook, or action, provide a link to the
relevant page in the Kombo Dashboard so KomboAI can inspect it directly.

## Account access and limits

KomboAI uses the current support thread and supported image attachments. It
draws on a broad, curated body of knowledge spanning Kombo implementation,
product usage, and provider behavior.

Its live account access is read-only and restricted to the Kombo tenant
associated with your support account. It can inspect your environments, linked
accounts, scope configurations, and recent interactions, including most logs.

KomboAI cannot change configuration, perform actions, or modify provider data.
It also cannot inspect individual synced records, sensitive logs, or every
setting. When a change is needed, it can explain how to make it.

## Faster answers, backed by humans

KomboAI is designed to make Kombo support faster, not replace the people behind
it. For many technical questions, it can research the issue and respond within
20 to 60 seconds, often giving you enough information to continue immediately.

Our support team remains responsible for helping you succeed with Kombo. We
continuously review KomboAI's answers to improve how it understands questions,
researches the relevant context, and explains its findings. When a question
requires a better answer, our team will take over.

KomboAI can make mistakes. If an answer seems inaccurate, incomplete, or based
on a misunderstanding, please tell us in the thread. Your feedback helps us
correct the answer and improve KomboAI.


# Kombo Connect
Source: https://docs.kombo.dev/kombo-connect

Our interactive embeddable connection flow.

### How your customer integrates with your product

We know that the experience of setting up new integrations is just as core to your application as the integrations themselves, so we’ve put special care into making this as easy and user-friendly as possible for your customers.

[Kombo Connect](/hris/guides/connect/introduction)—that’s what we call our interactive connection flow—can be **[fully embedded within your own application](/hris/guides/connect/embedded-flow)**.

<Frame>
  <img alt="1376" />
</Frame>

### The connection flow

To get a better idea of how Kombo Connect fits into your application, let’s take a look at the typical flow a customer will go through:

1. They **initiate the connection flow** within your app (e.g., through a “Connect HRIS” button)
2. They are **presented with the Kombo Connect UI**, where they can:
   * Select the tool they want to connect (e.g., Factorial)
   * Get an overview of the requested data points (see **[Scopes](/hris/features/scopes)**)
   * Grant access to the requested data points
   * See which credentials are required to set up the tool and how to get them
   * Enter the necessary credentials (e.g., an API key)
3. They **return to your app**, and their integration has been set up

<CardGroup>
  <Card title="Learn more about Kombo Connect" icon="circle-info" href="/hris/guides/connect/introduction" />
</CardGroup>


# Libraries & SDKs
Source: https://docs.kombo.dev/libraries-and-sdks

Use our official SDKs for ergonomic and type-safe API interactions.

## Server-side SDKs

Kombo maintains and publishes multiple official server-side SDKs. These allow you to interact with the Kombo API in an ergonomic and type-safe manner, and they are **the recommended way to implement Kombo** if you're on a supported tech stack.

Currently, we provide the following SDKs:

* **[`@kombo-api/sdk` package][typescript-npm]** for **TypeScript/JavaScript** ([GitHub][typescript-github], [npm][typescript-npm])
* **[`kombo` package][python-pypi]** for **Python** ([GitHub][python-github], [PyPI][python-pypi])
* **[`kombo` gem][ruby-rubygems]** for **Ruby** ([GitHub][ruby-github], [RubyGems][ruby-rubygems])

Using these, your server-side code may look like this:

<CodeGroup>
  ```typescript TypeScript theme={null}
  import { Kombo } from '@kombo-api/sdk'

  const kombo = new Kombo({
    api_key: process.env.KOMBO_API_KEY,
    integration_id: 'workday:HWUTwvyx2wLoSUHphiWVrp28',
  })

  const result = await kombo.hris.getEmployees()

  console.log(result)
  ```

  ```python Python theme={null}
  from kombo import Kombo

  with Kombo(
      api_key="<YOUR_BEARER_TOKEN_HERE>",
      integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28",
  ) as kombo:
      result = kombo.hris.get_employees()

      print(result)
  ```

  ```ruby Ruby theme={null}
  require 'kombo'

  Models = ::Kombo::Models
  s = ::Kombo::Kombo.new(
    integration_id: 'workday:HWUTwvyx2wLoSUHphiWVrp28',
    security: Models::Shared::Security.new(
      api_key: '<YOUR_BEARER_TOKEN_HERE>',
    ),
  )

  res = s.hris.get_employees()
  ```
</CodeGroup>

More server-side SDKs are planned. Please don't hesitate to reach out to us if you're interested in an SDK for your stack!

### Migrating to Kombo SDKs

Are you currently using custom code or self-built SDKs to interact with the Kombo API? It could make sense to migrate towards our official SDKs.

They're **kept up to date** with the latest changes to the Kombo API (including deprecated surface, which is intentionally excluded), provide you with **auto-completion and detailed types** for both inputs and outputs, and help you **avoid common pitfalls and mistakes**.

If you plan to do so, you might find the following prompt useful:

<Accordion title="LLM Prompt: Migrating to Kombo SDKs" icon="robot">
  Copy-paste this into your AI coding tool of choice (we recommend *plan mode*):

  ```text Prompt wrap theme={null}
  Our codebase uses the Kombo Unified API for some/all integrations with third-party systems. So far, our implementation is built using custom code. We'd like to migrate to using Kombo's official SDKs.

  Please help me create and then execute on a plan to perform this migration.

  First, please identify all the places in our codebase where we're currently making API calls to the Kombo API (e.g., `https://api.kombo.dev/...` or `https://api.us.kombo.dev/...`).

  Then, fetch the docs for the respective SDK to identify the methods to use:

  - [TypeScript SDK](https://raw.githubusercontent.com/kombohq/typescript-sdk/refs/heads/main/README.md)
  - [Python SDK](https://raw.githubusercontent.com/kombohq/python-sdk/refs/heads/main/README.md)

  Next, create a plan for the migration. Detail which files need to be updated, which methods to use, and any challenges you foresee.

  Please note that some niche API surface (e.g., system-specific endpoints or the `remote_data` field) might not be available in the SDKs at this point. If you notice that we're using such API surface, please flag it to me.
  ```

  As always, make sure to double-check and test the results to ensure they're correct.
</Accordion>

### Alternatives

If your tech stack is not supported yet, you can still make use of **the "Try It" button** ([open example](/hris/v1/get-employees?playground=open)) across our endpoint documentation pages to test our endpoints in your browser and get generated code snippets for several languages

There is also [our official OpenAPI specification](https://api.kombo.dev/openapi.json) which you can use together with open source tools (e.g., [OpenAPI Generator](https://openapi-generator.tech/)) to generate a client libraries or type definitions.

## Kombo Connect SDK

Apart from our server-side SDKs, we offer one more official library: [the `@kombo-api/connect` JavaScript SDK](https://www.npmjs.com/package/@kombo-api/connect).

This does not directly interact with the Kombo API. Instead, you can use it in your frontend code to embed the Kombo Connect flow right inside your own application. This works regardless of the JavaScript framework you're using.

Check out [our "Embedded flow" guide](/hris/guides/connect/embedded-flow) for more details.

[typescript-github]: https://github.com/kombohq/typescript-sdk#readme

[typescript-npm]: https://www.npmjs.com/package/@kombo-api/sdk

[python-github]: https://github.com/kombohq/python-sdk#readme

[python-pypi]: https://pypi.org/project/kombo/

[ruby-github]: https://github.com/kombohq/ruby-sdk

[ruby-rubygems]: https://rubygems.org/gems/kombo


# Available LMS Connectors
Source: https://docs.kombo.dev/lms/connectors

Browse all available LMS connectors integrated with Kombo

Through Kombo's Unified LMS API, you can integrate with 11+ LMS systems.

<Note>
  Please note that this page only lists connectors for Kombo's **LMS API**. You can also browse our [HRIS connectors](/hris/connectors) and [ATS connectors](/ats/connectors) and [Assessment connectors](/assessment/connectors).
</Note>

<CardGroup>
  <Card title="360Learning" icon="https://storage.googleapis.com/kombo-assets/integrations/360learning/icon.svg" href="/lms/connectors/360learning">
    LMS connector
  </Card>

  <Card title="Cornerstone OnDemand" icon="https://storage.googleapis.com/kombo-assets/integrations/cornerstoneondemand/icon.svg" href="/lms/connectors/cornerstoneondemand">
    LMS connector
  </Card>

  <Card title="Coursera" icon="https://storage.googleapis.com/kombo-assets/integrations/coursera/icon.svg" href="/lms/connectors/coursera">
    LMS connector
  </Card>

  <Card title="Docebo" icon="https://storage.googleapis.com/kombo-assets/integrations/docebo/icon.svg" href="/lms/connectors/docebo">
    LMS connector
  </Card>

  <Card title="Kombo Sandbox" icon="https://storage.googleapis.com/kombo-assets/integrations/sandbox/icon.svg" href="/lms/connectors/sandbox">
    LMS connector
  </Card>

  <Card title="LinkedIn Learning" icon="https://storage.googleapis.com/kombo-assets/integrations/linkedinlearning/icon.svg" href="/lms/connectors/linkedinlearning">
    LMS connector
  </Card>

  <Card title="Moodle" icon="https://storage.googleapis.com/kombo-assets/integrations/moodle/icon.svg" href="/lms/connectors/moodle">
    LMS connector
  </Card>

  <Card title="SAP SuccessFactors" icon="https://storage.googleapis.com/kombo-assets/integrations/successfactors/icon.svg" href="/lms/connectors/successfactors">
    LMS connector
  </Card>

  <Card title="TalentLMS" icon="https://storage.googleapis.com/kombo-assets/integrations/talentlms/icon.svg" href="/lms/connectors/talentlms">
    LMS connector
  </Card>

  <Card title="Udemy Business" icon="https://storage.googleapis.com/kombo-assets/integrations/udemy/icon.svg" href="/lms/connectors/udemy">
    LMS connector
  </Card>

  <Card title="Workday" icon="https://storage.googleapis.com/kombo-assets/integrations/workday/icon.svg" href="/lms/connectors/workday">
    LMS connector
  </Card>
</CardGroup>

## Missing something?

We're always expanding our offering of integrations, so if there's a solution that's missing, [let's talk](https://www.kombo.dev/demo)! If you're an existing Kombo customer, please [reach out to support](mailto:support@kombo.dev).


# 360Learning LMS Integration
Source: https://docs.kombo.dev/lms/connectors/360learning

360Learning connector for Kombo's LMS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The 360Learning LMS integration allows you to sync LMS data between 360Learning and your application through Kombo's unified API. The tool slug for this connector is `360learning`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/42791352858001-360Learning-LMS-How-do-I-link-my-account">
    Step-by-step instructions to connect your 360Learning account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | work\_email         |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Course Providers">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Courses">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | provider\_id        |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Course Revisions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | course\_id          |       |
      | title               |       |
      | description         |       |
      | remote\_url         |       |
      | status              |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Course Progressions">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | user\_id             |       |
      | course\_revision\_id |       |
      | status               |       |
      | enrolled\_at         |       |
      | completed\_at        |       |
      | remote\_data         |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Upsert courses">
      | Input Field                 | Notes |
      | --------------------------- | ----- |
      | items.origin\_id            |       |
      | items.course.type           |       |
      | items.course.title          |       |
      | items.course.description    |       |
      | items.course.course\_url    |       |
      | items.course.thumbnail\_url |       |
      | items.course.duration       |       |
      | items.course.languages      |       |
    </Accordion>

    <Accordion title="Deactivate course">
      <Note>
        This action archives the course in 360Learning. It can be restored later.
      </Note>

      | Input Field | Notes |
      | ----------- | ----- |
      | course\_id  |       |
    </Accordion>

    <Accordion title="Enroll user in course">
      <Note>
        The enrollment is processed asynchronously by 360Learning. The enrollment will be created in 360Learning after processing completes.
      </Note>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | user\_id             |       |
      | course\_revision\_id |       |
    </Accordion>

    <Accordion title="Complete course">
      <Note>
        The completion is processed asynchronously by 360Learning. It may take 1-30 seconds for the completion to appear. Wait before running a sync.
      </Note>

      | Input Field             | Notes |
      | ----------------------- | ----- |
      | course\_progression\_id |       |
      | completed\_at           |       |
      | score                   |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature         | Notes |
    | --------------- | ----- |
    | API Passthrough |       |
    | Scope Testing   |       |
    | Per Model Tests |       |
  </Tab>
</Tabs>


# Cornerstone OnDemand LMS Integration
Source: https://docs.kombo.dev/lms/connectors/cornerstoneondemand

Cornerstone OnDemand connector for Kombo's LMS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Cornerstone OnDemand LMS integration allows you to sync LMS data between Cornerstone OnDemand and your application through Kombo's unified API. The tool slug for this connector is `cornerstoneondemand`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/42009176931345-Cornerstone-OnDemand-LMS-How-do-I-link-my-account">
    Step-by-step instructions to connect your Cornerstone OnDemand account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | work\_email         |       |
      | status              |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Course Providers">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
    </Accordion>

    <Accordion title="Skills">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Courses">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | provider\_id        |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Course Revisions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | course\_id          |       |
      | title               |       |
      | description         |       |
      | remote\_url         |       |
      | status              |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Course Progressions">
      <Note>
        Progressions status can be a translated value Cornerstone OnDemand and mapped to NULL
      </Note>

      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | user\_id             |       |
      | course\_revision\_id |       |
      | status               |       |
      | enrolled\_at         |       |
      | completed\_at        |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Revision skills">
      | Field                | Notes |
      | -------------------- | ----- |
      | course\_revision\_id |       |
      | skill\_id            |       |
      | id                   |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Upsert courses">
      <Note>
        By default, courses are created as Material type learning objects which support a URL but do not support score passback on completion. If you need score passback on completion, please contact support to switch the course creation type to Online Course. Note that Online Course type does not support a URL (`course_url` will be ignored).
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | items.origin\_id         |       |
      | items.course.type        |       |
      | items.course.title       |       |
      | items.course.description |       |
      | items.course.course\_url |       |
      | items.course.duration    |       |
      | items.course.languages   |       |
    </Accordion>

    <Accordion title="Enroll user in course">
      | Input Field          | Notes |
      | -------------------- | ----- |
      | user\_id             |       |
      | course\_revision\_id |       |
    </Accordion>

    <Accordion title="Complete course">
      <Note>
        Score is only supported for certain learning object types (e.g., Test and Online Course). Material type learning objects (the default for courses created via Kombo) do not support score. If you need score passback for Kombo-created courses, please contact support to switch the course creation type.
      </Note>

      | Input Field             | Notes |
      | ----------------------- | ----- |
      | course\_progression\_id |       |
      | completed\_at           |       |
      | score                   |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature           | Notes |
    | ----------------- | ----- |
    | API Passthrough   |       |
    | Additional Scopes |       |
    | Scope Testing     |       |
    | Per Model Tests   |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Cornerstone OnDemand

For **Cornerstone OnDemand**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Cornerstone OnDemand ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/cornerstoneondemand/icon.svg" href="/ats/connectors/cornerstoneondemand">
    Cornerstone OnDemand for the ATS category
  </Card>

  <Card title="Cornerstone OnDemand HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/cornerstoneondemand/icon.svg" href="/hris/connectors/cornerstoneondemand">
    Cornerstone OnDemand for the HRIS category
  </Card>
</CardGroup>


# Coursera LMS Integration
Source: https://docs.kombo.dev/lms/connectors/coursera

Coursera connector for Kombo's LMS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Coursera LMS integration allows you to sync LMS data between Coursera and your application through Kombo's unified API. The tool slug for this connector is `coursera`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/48034371193489-Coursera-LMS-How-do-I-link-my-account">
    Step-by-step instructions to connect your Coursera account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | work\_email         |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Skills">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Courses">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Course Revisions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | course\_id          |       |
      | title               |       |
      | description         |       |
      | remote\_url         |       |
      | status              |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Course Progressions">
      <Note>
        It can take up to 48 hours for Coursera to reflect new enrollments in the data we sync course progressions from, so a recently enrolled learner may be missing from course progressions until then. Please reach out to our support if you are interested in fresher enrollment data.
      </Note>

      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | user\_id             |       |
      | course\_revision\_id |       |
      | status               |       |
      | enrolled\_at         |       |
      | completed\_at        |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Revision skills">
      | Field                | Notes |
      | -------------------- | ----- |
      | course\_revision\_id |       |
      | skill\_id            |       |
      | id                   |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Enroll user in course">
      <Note>
        Enrollment in Coursera is program-scoped. We use the first program that both contains the course and lists the learner as a member. Please reach out to our support if you need more control over which programs are used for enrollments. It can take up to 48 hours for Coursera to reflect new enrollments in the data we sync course progressions from, so a progression created by this action may be missing from course progressions until then. Please reach out to our support if you are interested in fresher enrollment data.
      </Note>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | user\_id             |       |
      | course\_revision\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature         | Notes |
    | --------------- | ----- |
    | API Passthrough |       |
  </Tab>
</Tabs>


# Docebo LMS Integration
Source: https://docs.kombo.dev/lms/connectors/docebo

Docebo connector for Kombo's LMS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Docebo LMS integration allows you to sync LMS data between Docebo and your application through Kombo's unified API. The tool slug for this connector is `docebo`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/47599576343441">
    Step-by-step instructions to connect your Docebo account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | work\_email         |       |
      | status              |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Courses">
      <Note>
        No creation-date is available for courses.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Course Revisions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | course\_id          |       |
      | title               |       |
      | description         |       |
      | remote\_url         |       |
      | status              |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Course Progressions">
      <Note>
        Docebo only returns the status of a user's enrollment in a course. Multiple enrollments are not supported.
      </Note>

      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | user\_id             |       |
      | course\_revision\_id |       |
      | status               |       |
      | enrolled\_at         |       |
      | completed\_at        |       |
      | remote\_data         |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Enroll user in course">
      | Input Field          | Notes |
      | -------------------- | ----- |
      | user\_id             |       |
      | course\_revision\_id |       |
    </Accordion>

    <Accordion title="Complete course">
      <Note>
        The score is stored as-is (0.00 to 100) and shown in the Docebo UI in a 0.00 format.
      </Note>

      | Input Field             | Notes |
      | ----------------------- | ----- |
      | course\_progression\_id |       |
      | score                   |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature         | Notes |
    | --------------- | ----- |
    | API Passthrough |       |
    | Scope Testing   |       |
    | Per Model Tests |       |
  </Tab>
</Tabs>


# LinkedIn Learning LMS Integration
Source: https://docs.kombo.dev/lms/connectors/linkedinlearning

LinkedIn Learning connector for Kombo's LMS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The LinkedIn Learning LMS integration allows you to sync LMS data between LinkedIn Learning and your application through Kombo's unified API. The tool slug for this connector is `linkedinlearning`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/43515564390673-LinkedIn-Learning-LMS-How-do-I-link-my-account">
    Step-by-step instructions to connect your LinkedIn Learning account to Kombo.
  </Card>
</CardGroup>

## General Notes

* Changes to the data, as well as enrollments and user completions, only show up after 2 days.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | work\_email         |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Skills">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Courses">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Course Revisions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | course\_id          |       |
      | title               |       |
      | description         |       |
      | remote\_url         |       |
      | status              |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Course Progressions">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | user\_id             |       |
      | course\_revision\_id |       |
      | status               |       |
      | enrolled\_at         |       |
      | completed\_at        |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Revision skills">
      | Field                | Notes |
      | -------------------- | ----- |
      | course\_revision\_id |       |
      | skill\_id            |       |
      | id                   |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature         | Notes |
    | --------------- | ----- |
    | API Passthrough |       |
    | Scope Testing   |       |
    | Per Model Tests |       |
  </Tab>
</Tabs>


# Moodle LMS Integration
Source: https://docs.kombo.dev/lms/connectors/moodle

Moodle connector for Kombo's LMS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Moodle LMS integration allows you to sync LMS data between Moodle and your application through Kombo's unified API. The tool slug for this connector is `moodle`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/44938777668881-Moodle-How-do-I-link-my-account">
    Step-by-step instructions to connect your Moodle account to Kombo.
  </Card>
</CardGroup>

## General Notes

* This integration has only been tested with Moodle 5.x. Other versions may work but are not officially supported.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | work\_email         |       |
      | status              |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Skills">
      <Note>
        Skills are sourced from Moodle competencies. Each competency within a competency framework is mapped to a skill.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Courses">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Course Revisions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | course\_id          |       |
      | title               |       |
      | description         |       |
      | status              |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Course Progressions">
      | Field                | Notes                                                                                                                                                                |
      | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
      | id                   |                                                                                                                                                                      |
      | remote\_id           |                                                                                                                                                                      |
      | changed\_at          |                                                                                                                                                                      |
      | remote\_deleted\_at  |                                                                                                                                                                      |
      | user\_id             |                                                                                                                                                                      |
      | course\_revision\_id |                                                                                                                                                                      |
      | status               | Moodle distinguishes between 'complete pass' and 'complete fail' (activity completed but grade below passing threshold) – both are currently unified to `COMPLETED`. |
      | completed\_at        |                                                                                                                                                                      |
      | remote\_data         |                                                                                                                                                                      |
    </Accordion>

    <Accordion title="Revision skills">
      | Field                | Notes |
      | -------------------- | ----- |
      | course\_revision\_id |       |
      | skill\_id            |       |
      | id                   |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Upsert courses">
      | Input Field              | Notes |
      | ------------------------ | ----- |
      | items.origin\_id         |       |
      | items.course.type        |       |
      | items.course.title       |       |
      | items.course.description |       |
      | items.course.languages   |       |
    </Accordion>

    <Accordion title="Deactivate course">
      <Note>
        This action sets the course visibility to hidden in Moodle. The course will not be visible to students but can be restored later.
      </Note>

      | Input Field | Notes |
      | ----------- | ----- |
      | course\_id  |       |
    </Accordion>

    <Accordion title="Enroll user in course">
      <Note>
        By default, the user will be enrolled in the course with a role ID 5, which is "Student" by default.
      </Note>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | user\_id             |       |
      | course\_revision\_id |       |
    </Accordion>

    <Accordion title="Complete course">
      <Note>
        Completion is set by overriding all activity completion statuses in the course. If the course has completion criteria requiring all activities to be complete, this will mark the course as complete. The score is applied to all activities that have grade items configured in the course gradebook. Moodle aggregates activity grades into the course total automatically. Scoring requires the course to have at least one graded activity – courses without grade items cannot receive a score.
      </Note>

      | Input Field             | Notes |
      | ----------------------- | ----- |
      | course\_progression\_id |       |
      | completed\_at           |       |
      | score                   |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature         | Notes |
    | --------------- | ----- |
    | API Passthrough |       |
    | Scope Testing   |       |
    | Per Model Tests |       |
  </Tab>
</Tabs>


# Kombo Sandbox LMS Integration
Source: https://docs.kombo.dev/lms/connectors/sandbox

Kombo Sandbox connector for Kombo's LMS API

The Kombo Sandbox LMS integration allows you to sync LMS data between Kombo Sandbox and your application through Kombo's unified API. The tool slug for this connector is `sandbox`.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | work\_email         |       |
      | status              |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Course Providers">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Skills">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Courses">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | provider\_id        |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Course Revisions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | course\_id          |       |
      | title               |       |
      | description         |       |
      | remote\_url         |       |
      | status              |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Course Progressions">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | user\_id             |       |
      | course\_revision\_id |       |
      | status               |       |
      | enrolled\_at         |       |
      | completed\_at        |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Revision skills">
      | Field                | Notes |
      | -------------------- | ----- |
      | course\_revision\_id |       |
      | skill\_id            |       |
      | id                   |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Upsert courses">
      | Input Field                 | Notes |
      | --------------------------- | ----- |
      | items.origin\_id            |       |
      | items.course.type           |       |
      | items.course.title          |       |
      | items.course.description    |       |
      | items.course.course\_url    |       |
      | items.course.thumbnail\_url |       |
      | items.course.duration       |       |
      | items.course.languages      |       |
    </Accordion>

    <Accordion title="Deactivate course">
      | Input Field | Notes |
      | ----------- | ----- |
      | course\_id  |       |
    </Accordion>

    <Accordion title="Enroll user in course">
      | Input Field          | Notes |
      | -------------------- | ----- |
      | user\_id             |       |
      | course\_revision\_id |       |
    </Accordion>

    <Accordion title="Complete course">
      | Input Field             | Notes |
      | ----------------------- | ----- |
      | course\_progression\_id |       |
      | completed\_at           |       |
      | score                   |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature         | Notes |
    | --------------- | ----- |
    | Scope Testing   |       |
    | Per Model Tests |       |
    | Per Field Tests |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Kombo Sandbox

For **Kombo Sandbox**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Kombo Sandbox ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/sandbox/icon.svg" href="/ats/connectors/sandbox">
    Kombo Sandbox for the ATS category
  </Card>

  <Card title="Kombo Sandbox Assessment" icon="https://storage.googleapis.com/kombo-assets/integrations/sandbox/icon.svg" href="/assessment/connectors/sandbox">
    Kombo Sandbox for the Assessment category
  </Card>

  <Card title="Kombo Sandbox HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/sandbox/icon.svg" href="/hris/connectors/sandbox">
    Kombo Sandbox for the HRIS category
  </Card>
</CardGroup>


# SAP SuccessFactors LMS Integration
Source: https://docs.kombo.dev/lms/connectors/successfactors

SAP SuccessFactors connector for Kombo's LMS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The SAP SuccessFactors LMS integration allows you to sync LMS data between SAP SuccessFactors and your application through Kombo's unified API. The tool slug for this connector is `successfactors`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/42013709676305-SAP-SuccessFactors-LMS-How-do-I-link-my-account">
    Step-by-step instructions to connect your SAP SuccessFactors account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      <Note>
        Users (students) are read from the SuccessFactors Learning API.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | work\_email         |       |
      | status              |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Course Providers">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Courses">
      <Note>
        Courses are read from the SuccessFactors Learning API.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | provider\_id        |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Course Revisions">
      <Note>
        Course revisions are read from the SuccessFactors Learning API.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | course\_id          |       |
      | title               |       |
      | description         |       |
      | status              |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Course Progressions">
      <Note>
        Progress records are read from the SuccessFactors Learning API.
      </Note>

      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | user\_id             |       |
      | course\_revision\_id |       |
      | status               |       |
      | enrolled\_at         |       |
      | completed\_at        |       |
      | remote\_data         |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Upsert courses">
      <Note>
        Courses are sent to the remote API in batches of 1000, roughly every 8 minutes (500 seconds). This is a limitation of the underlying API. If any course in the batch fails validation, the entire batch is rejected. The underlying API does not support partial success – either all courses are created or none are.
      </Note>

      | Input Field                 | Notes |
      | --------------------------- | ----- |
      | items.origin\_id            |       |
      | items.course.type           |       |
      | items.course.title          |       |
      | items.course.description    |       |
      | items.course.course\_url    |       |
      | items.course.thumbnail\_url |       |
      | items.course.duration       |       |
      | items.course.languages      |       |
    </Accordion>

    <Accordion title="Deactivate course">
      <Note>
        Only courses created via Kombo can be deactivated. Currently, only 1 course can be deactivated every 500 seconds. This is a limitation of the underlying API.
      </Note>

      | Input Field | Notes |
      | ----------- | ----- |
      | course\_id  |       |
    </Accordion>

    <Accordion title="Enroll user in course">
      <Note>
        The status is set to `IN_PROGRESS` because SuccessFactors treats new enrollments as in-progress courses.
      </Note>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | user\_id             |       |
      | course\_revision\_id |       |
    </Accordion>

    <Accordion title="Complete course">
      <Note>
        The score is passed to SAP as the grade string (e.g., "93"). SAP grades are company-defined and can be numeric (1-10) or codes (A-F, Pass/Fail) – if the end-customer expects a different format, please contact our support team.
      </Note>

      | Input Field             | Notes |
      | ----------------------- | ----- |
      | course\_progression\_id |       |
      | completed\_at           |       |
      | score                   |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature           | Notes |
    | ----------------- | ----- |
    | API Passthrough   |       |
    | Additional Scopes |       |
    | Scope Testing     |       |
    | Per Model Tests   |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** SAP SuccessFactors

For **SAP SuccessFactors**, we also offer the following other connector variants:

<CardGroup>
  <Card title="SAP SuccessFactors ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/successfactors/icon.svg" href="/ats/connectors/successfactors">
    SAP SuccessFactors for the ATS category
  </Card>

  <Card title="SAP SuccessFactors Assessment" icon="https://storage.googleapis.com/kombo-assets/integrations/successfactors/icon.svg" href="/assessment/connectors/successfactors">
    SAP SuccessFactors for the Assessment category
  </Card>

  <Card title="SAP SuccessFactors HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/successfactors/icon.svg" href="/hris/connectors/successfactors">
    SAP SuccessFactors for the HRIS category
  </Card>
</CardGroup>


# TalentLMS LMS Integration
Source: https://docs.kombo.dev/lms/connectors/talentlms

TalentLMS connector for Kombo's LMS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The TalentLMS LMS integration allows you to sync LMS data between TalentLMS and your application through Kombo's unified API. The tool slug for this connector is `talentlms`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/44366343776401-TalentLMS-How-do-I-link-my-account">
    Step-by-step instructions to connect your TalentLMS account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | work\_email         |       |
      | status              |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Courses">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Course Revisions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | course\_id          |       |
      | title               |       |
      | description         |       |
      | status              |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Course Progressions">
      <Note>
        Progress is fetched per user-course pair via the course-progress endpoint.
      </Note>

      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | user\_id             |       |
      | course\_revision\_id |       |
      | status               |       |
      | completed\_at        |       |
      | remote\_data         |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Upsert courses">
      <Note>
        TalentLMS only supports setting course duration in whole days. The provided duration (in minutes) is converted to days by rounding up.
      </Note>

      | Input Field              | Notes |
      | ------------------------ | ----- |
      | items.origin\_id         |       |
      | items.course.type        |       |
      | items.course.title       |       |
      | items.course.description |       |
      | items.course.duration    |       |
    </Accordion>

    <Accordion title="Deactivate course">
      <Note>
        TalentLMS does not support deactivating or archiving courses. This action permanently deletes the course from TalentLMS. This is irreversible and cannot be undone.
      </Note>

      | Input Field | Notes |
      | ----------- | ----- |
      | course\_id  |       |
    </Accordion>

    <Accordion title="Enroll user in course">
      <Note>
        TalentLMS determines the enrollment role based on the user's account type. Admin and instructor users are automatically enrolled as trainers (with no progression tracking) by TalentLMS. If this happens, a rollback is attempted and an error is returned.
      </Note>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | user\_id             |       |
      | course\_revision\_id |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature         | Notes |
    | --------------- | ----- |
    | API Passthrough |       |
    | Scope Testing   |       |
    | Per Model Tests |       |
  </Tab>
</Tabs>


# Udemy Business LMS Integration
Source: https://docs.kombo.dev/lms/connectors/udemy

Udemy Business connector for Kombo's LMS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Udemy Business LMS integration allows you to sync LMS data between Udemy Business and your application through Kombo's unified API. The tool slug for this connector is `udemy`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/43825601069457-Udemy-LMS-How-do-I-link-my-account">
    Step-by-step instructions to connect your Udemy Business account to Kombo.
  </Card>
</CardGroup>

## General Notes

* Changes to the data, as well as enrollments and user completions, only show up after up to 6 hours.

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | work\_email         |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Skills">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Courses">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Course Revisions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | course\_id          |       |
      | title               |       |
      | description         |       |
      | remote\_url         |       |
      | status              |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Course Progressions">
      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | user\_id             |       |
      | course\_revision\_id |       |
      | status               |       |
      | enrolled\_at         |       |
      | completed\_at        |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Revision skills">
      | Field                | Notes |
      | -------------------- | ----- |
      | course\_revision\_id |       |
      | skill\_id            |       |
      | id                   |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature         | Notes |
    | --------------- | ----- |
    | API Passthrough |       |
  </Tab>
</Tabs>


# Workday LMS Integration
Source: https://docs.kombo.dev/lms/connectors/workday

Workday connector for Kombo's LMS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

The Workday LMS integration allows you to sync LMS data between Workday and your application through Kombo's unified API. The tool slug for this connector is `workday`.

## Guides and Resources

<CardGroup>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/14350938170897">
    Step-by-step instructions to connect your Workday account to Kombo.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Users">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | work\_email         |       |
      | status              |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Skills">
      <Note>
        Skills are extracted from course data in Workday. Each course can have multiple associated skills.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Courses">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Course Revisions">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | course\_id          |       |
      | title               |       |
      | description         |       |
      | remote\_url         |       |
      | status              |       |
      | remote\_created\_at |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Course Progressions">
      <Note>
        Course progressions are synced from Workday learning enrollments. Each enrollment represents a user's progress in a specific course revision.
      </Note>

      | Field                | Notes |
      | -------------------- | ----- |
      | id                   |       |
      | remote\_id           |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
      | user\_id             |       |
      | course\_revision\_id |       |
      | status               |       |
      | enrolled\_at         |       |
      | completed\_at        |       |
      | remote\_data         |       |
    </Accordion>

    <Accordion title="Revision skills">
      | Field                | Notes |
      | -------------------- | ----- |
      | course\_revision\_id |       |
      | skill\_id            |       |
      | id                   |       |
      | changed\_at          |       |
      | remote\_deleted\_at  |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Upsert courses">
      <Note>
        Workday enforces unique course titles (case-insensitive) across all course types.
      </Note>

      | Input Field                 | Notes |
      | --------------------------- | ----- |
      | items.origin\_id            |       |
      | items.course.type           |       |
      | items.course.title          |       |
      | items.course.description    |       |
      | items.course.course\_url    |       |
      | items.course.thumbnail\_url |       |
      | items.course.duration       |       |
      | items.course.languages      |       |
    </Accordion>

    <Accordion title="Deactivate course">
      | Input Field | Notes |
      | ----------- | ----- |
      | course\_id  |       |
    </Accordion>

    <Accordion title="Enroll user in course">
      | Input Field          | Notes |
      | -------------------- | ----- |
      | user\_id             |       |
      | course\_revision\_id |       |
    </Accordion>

    <Accordion title="Complete course">
      <Note>
        The score is passed to Workday as-is (0–100). Workday accepts any positive decimal up to 999999.999 – if the end-customer expects a different range, please contact our support team. Workday requires the score to be strictly greater than 0. A score of 0 will be sent as 0.001 (the lowest value in Workday's `decimal(9, 3)` range).
      </Note>

      | Input Field             | Notes |
      | ----------------------- | ----- |
      | course\_progression\_id |       |
      | completed\_at           |       |
      | score                   |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature           | Notes |
    | ----------------- | ----- |
    | API Passthrough   |       |
    | Additional Scopes |       |
    | Scope Testing     |       |
    | Per Model Tests   |       |
    | Per Field Tests   |       |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Workday

For **Workday**, we also offer the following other connector variants:

<CardGroup>
  <Card title="Workday ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/workday/icon.svg" href="/ats/connectors/workday">
    Workday for the ATS category
  </Card>

  <Card title="Workday Assessment" icon="https://storage.googleapis.com/kombo-assets/integrations/workday/icon.svg" href="/assessment/connectors/workday">
    Workday for the Assessment category
  </Card>

  <Card title="Workday HRIS" icon="https://storage.googleapis.com/kombo-assets/integrations/workday/icon.svg" href="/hris/connectors/workday">
    Workday for the HRIS category
  </Card>
</CardGroup>


# Audit Logs
Source: https://docs.kombo.dev/lms/features/audit-logs

Audit sensitive changes to your Kombo environment.

## Use Case

Audit logs are essential for maintaining compliance and security within your
organization. They provide a detailed record of actions taken within your
Kombo environment, helping you track changes, identify unusual activity,
and ensure accountability.

## Accessing Audit Logs

You can access audit logs through the
[Audit Logs section in the Dashboard](https://app.kombo.dev/audit-logs).
Logs are environment-specific, so make sure to select the appropriate environment.
The dashboard allows you to query logs using the provided filter functionality.

<Frame>
  <img alt="Audit Logs Screenshot" />
</Frame>

## Limitations

Audit logs are available only on and above the scale plan and are retained for
one year, with retention periods of up to three years available on higher plans.
Custom retention policies and automated access to logs are
available on larger plans. If you require these customizations,
please contact Customer Success for assistance.


# Custom Fields
Source: https://docs.kombo.dev/lms/features/custom-fields

Learn how to extend Kombo's unified data models with additional fields.

## What are Kombo custom fields?

Kombo's unified models cover the fields that are standard across HR, ATS, and other business systems. When your product needs additional read-side data, custom fields let you extend those models with your own stable field keys.

For example, you might add `t_shirt_size` to employees, `benefit_eligibility` to employments, or `source_campaign` to applications. Once a custom field is configured and mapped, Kombo returns it in the `custom_fields` object of the relevant API response.

This makes custom fields a good fit whenever you need a data point that is not part of Kombo's standard unified model, but you still want to read it in an integration-agnostic way.

<Info>
  Custom fields are for **reading** additional data from connected systems.
  Looking to **write** extra data when creating candidates or applications? See
  [Remote Fields](/extending-the-model#remote-fields). For a full comparison of
  all extension mechanisms, see [Extending the Model](/extending-the-model).
</Info>

## How mappings work

A Kombo custom field is the target field that appears in your API response. A field from the connected system is the source field that provides the value for a specific integration.

The source field can be anything Kombo can discover from the connected system: a standard field in that system, a niche provider-specific field, or a custom field that your customer created in their HR or ATS tool.

For example:

* A Personio employee attribute called **"Favorite Color"** can be mapped to your Kombo custom field `favorite_color`.
* A provider-specific employee field for cost center, employment type, or benefit eligibility can be mapped to a Kombo custom field if your product needs that value and Kombo's standard model does not expose it exactly the way you need.
* Different customers can use different field names, such as **"Favorite Color"** and **"Favourite Colour"**, while your API integration always reads the same Kombo key.

## Setting up custom fields in Kombo

### Create the Kombo custom field

Open [the Dashboard](https://app.kombo.dev/) and click on **Configuration** in the sidebar, then on the **Custom Fields** tab.

<Frame>
  <img
    alt="Custom fields empty
state"
  />
</Frame>

Find the relevant data model on the page. In this example, we want to add a field to employees, so click **Add custom field** in the **Employees** section.

<Frame>
  <img
    alt="Create custom field
dialog"
  />
</Frame>

Enter the field key that should appear in the API response. Let's call it `favorite_color`. The field key you choose here becomes the key in the `custom_fields` object of every mapped record.

### Prepare the field in the connected system

Sometimes the field you want to map already exists in the connected system. In other cases, your customer may first need to create or expose it there.

Let's take Personio as an example where the source field is a custom attribute in the HR system.

Under **Settings > Employee Information**, you can add new attributes or entire sections to employee profiles. We will add a new attribute called **"Favorite Color"** to the **"Public Profile"** section.

<Frame>
  <img alt="image" />
</Frame>

If we now go to the profile of an employee, we can see the new field. Let's set a value for it.

<Frame>
  <img alt="image" />
</Frame>

In the case of Personio, we need to let the API key know that we want to expose the new attribute. Go to **Settings > API Credentials**, click on the API key you used to connect to Kombo, then open the **"Readable employee attributes"** section and select the field.

<Frame>
  <img alt="image" />
</Frame>

Don't forget to click **save**.

### Map fields manually

To map a field manually, open the overview for the integration. Kombo discovers available fields during syncs, so run a sync first if the field is new or has not appeared yet.

After the sync is finished, open the custom field dropdown for the relevant model and select the field from the connected system that should fill your Kombo custom field.

<Frame>
  <img
    alt="Custom field mapping
dropdown"
  />
</Frame>

Don't forget to click **Save changes** to save your changes. After creating the mapping, the next sync will read the source value and return it under your Kombo custom field key.

<a />

### Map fields based on live data

For supported integrations, the custom field dropdown also includes a recommended option to **Identify field using live data** (see screenshot above). Click **Open Custom Field Explorer** to search the connected system directly and find the field based on real records.

<Frame>
  <img alt="Custom Field Explorer" />
</Frame>

This is useful when the field name is unclear, or when you know an example value but not the exact field key. For example, you can search for an employee with the value **"Large"** to find the field that stores T-shirt size, then map that field to your Kombo custom field.

If the Explorer is not available for an integration yet, use the regular dropdown mapping flow described above.

### Add automatic mapping rules

On the custom field detail page, you can see how many integrations use the field and which **automatic mapping rules** are defined for it.

Automatic mapping rules tell Kombo which fields of new integrations should automatically be mapped to this Kombo custom field. Each rule matches against a field key or label and can optionally be scoped to a connector. You can add as many rules as you need.

Click **Add rule** to create a new automatic mapping rule.

<Frame>
  <img
    alt="Automatic mapping rules empty
state"
  />
</Frame>

In the dialog, choose whether the rule should apply to one connector or every integration in the category. Then choose whether Kombo should match against the remote field's key or label, and enter the value to match.

<Frame>
  <img
    alt="Create automatic mapping rule
dialog"
  />
</Frame>

Whenever a sync discovers a field in an integration whose key or label matches one of your rules, its value is automatically mapped to your Kombo custom field. Going back to the Personio example: if you had set up a rule for **"Favorite Color"** scoped to Personio, the next Personio sync would have automatically mapped the value to `favorite_color`.

## Self-Serve Custom Field Configuration

To simplify the mapping process, you can allow your customers to map fields themselves using our self-serve **Setup Flow**. This is especially useful when your customer knows best which field in their system contains the value your Kombo custom field should receive.

Custom fields can be mapped as part of the connection, reducing the need for manual setup.

[Learn more about enabling self-serve field mapping here.](./setup-flow/introduction)

## Accessing custom fields in the API

Each model that supports custom fields has a `custom_fields` attribute. This attribute is a JSON object containing all mapped Kombo custom fields for that record.

When you query the API, you receive mapped custom field values in the `custom_fields` attribute. In this example, we query the [GET /employees](/hris/v1/get-employees) endpoint.

The value of a custom field mirrors what is returned by the underlying API. It is not always a string; it can also be a number, boolean, object, or array.

```json {7-17} theme={null}
{
  "status": "success",
  "data": {
    "results": [
      {
        ...
        "custom_fields": {
          "favorite_color": "blue",
          "manager": {
            "name": "Frank"
          },
          "reports": [
            {
              "name": "Tom"
            }
          ]
        }
      }
    ]
  }
}
```


# Data Explorer
Source: https://docs.kombo.dev/lms/features/data-explorer

Interact with customer data from a convenient UI in the Kombo dashboard.

## Overview

The Data Explorer is a visual layer on top of Kombo's unified API. It allows
you to view and search for data entries and execute all write actions from a
convenient UI in the Kombo dashboard.

This allows you to easily debug issues with your integrations, develop new
features, and test changes with your customer's data or your sandboxes.

<Frame>
  <img />
</Frame>

## Features

Below a few examples showing what you can do with the Data Explorer.

<AccordionGroup>
  <Accordion title="View data">
    You can view any data field of any data model available
    on the Kombo API in the Data Explorer. This includes users, courses,
    course progressions, skills, and all their relations to each other.

    <Frame>
      <img />
    </Frame>

    <Frame>
      <img />
    </Frame>
  </Accordion>

  <Accordion title="Modify data (e.g. creating courses and progressions)">
    You can run any write action supported by the Kombo API in the Data
    Explorer. This includes creating courses and course progressions, completing
    course progressions, and deactivating courses.

    Write actions can be accessed by clicking the three dots next to a data
    entry.

    <Frame>
      <img />
    </Frame>

    You can also upsert courses directly from the Data Explorer using the bulk
    upsert courses action.

    <Frame>
      <img />
    </Frame>
  </Accordion>
</AccordionGroup>

## How It Works

The Data Explorer is a feature built on top of the Kombo API. It allows you to
interact with the Kombo API in a convenient UI in the Kombo dashboard. All
integration-specific read and write actions that are possible via the Kombo API
are available in the Data Explorer.

## Where to find the Data Explorer

The Data Explorer is located within individual integration pages in the Kombo
dashboard:

1. **Go to Integrations**: Navigate to the [Integrations page](https://app.kombo.dev/integrations) in your dashboard
2. **Select an Integration**: Click on any connected integration from your list
3. **Access Data Explorer**: Click the "Data Explorer" tab in the integration interface

<Frame>
  <img />
</Frame>

## Access Permissions

The Data Explorer is available to:

* **Production Environment**: Users with admin role
* **Development Environment**: Users with admin or developer role


# Deletion Policy
Source: https://docs.kombo.dev/lms/features/deletion-policy

Understand how Kombo deletes data.

## General

Kombo prioritizes privacy and security by cleaning up any data that is no longer
used. We do that by following the deletion policies below. Kombo will not store
any sensitive data for longer than needed.

## Integration Data

### Case: an entry is not found anymore

When Kombo can't find an entry during a sync, we will mark it with
`remote_deleted_at` and 14 days later set all the fields to `null`.

### Case: an integration has been deleted

Kombo will delete all the data of an integration **14 days** after the integration
was deleted via API or UI.

### Case: scope config changed

**Field is turned off:** While running the next sync, Kombo will overwrite
the turned-off field for all entries with the value `null`.

**Model is turned off:** When a model gets turned off, Kombo will mark all entries with `remote_deleted_at`
and delete the entries after **14 days**.

***

## Logs

Kombo will delete statistics about syncs and write actions after **60 days**.

On all plans but the enterprise plan, Kombo will delete request data in the logs,
including the request and the response after **30 days**.


# Integration Fields
Source: https://docs.kombo.dev/lms/features/integration-fields

Learn how to use integration fields to read additional data properties from your customer's systems.

<Warning>
  The Integration Fields API was built for a very specific niche use case. This
  is likely not what you want to use. See [Custom Fields](./custom-fields)
  instead.
</Warning>

## What is an integration field

An integration field is a field returned from the raw response of the remote system.

## Setting up integration fields in Kombo

Before we set up the integration field in Kombo, let's talk about how you will receive the data.

Each model that supports integration fields has an `integration_fields` attribute. This attribute is an Array of JSON objects that contains all selected integration fields. We will discuss how to select integration fields in a [later step](#selecting-an-integration-field).

### View available integration fields

To list which integration fields are available for a specific integration, you should use our [GET integration-fields](../v1/get-integrations-integration-id-integration-fields) endpoint.

Example response:

```JSON theme={null}
{
    "status": "success",
    "data": {
        "results": [
            {
                "id": "123AbcDEFG4hijK5Lmn67OPq",
                "key": "dynamic_5487319",
                "model": "hris_employees",
                "type": "CUSTOM",
                "label": "Name of health insurance",
                "is_passthrough_enabled": false
            },
            ...
        ]
    },
    "next_cursor": null
}
```

If your array is empty or does not contain the values that you are looking for, double check if "integration fields" is enabled for the specific model in your [scope config](https://app.kombo.dev/scope-config).

<Note>
  Please note that this endpoint is paginated, featuring a default page size of
  250 and a maximum page size of 2000 (specified via the `page_size` parameter).
</Note>

### Selecting an integration field

To select an integration field to be passed through, use the [PATCH integration-fields](../v1/patch-integrations-integration-id-integration-fields-integration-field-id) endpoint.

An example payload would look like this:

```JSON theme={null}
{
    "enable_passthrough": true
}
```

Example response:

```JSON theme={null}
{
    "status": "success",
    "data": {
        "id": "123AbcDEFG4hijK5Lmn67OPq",
        "key": "dynamic_5487319",
        "model": "hris_employees",
        "type": "CUSTOM",
        "label": "Name of health insurance",
        "is_passthrough_enabled": true
    }
}
```

After successfully enabling passthrough on an integration field, the **next sync** will collect the values for the selected field and save them. These values then become part of our API response as follows:

## Getting integration fields as part of the API response

When you query the API, you will receive any selected integration fields in the `integration_fields` attribute. In this case, we query the [GET /employees](/hris/v1/get-employees) endpoint.
The value of an integration field mirrors what is returned by the underlying API (i.e. it's not always a `string` but can be a `number` or even an `object` too).

```JSON theme={null}
{
  "status": "success",
  "data": {
    "results": [
      {
        "first_name": "Frank",
        ...,
        "integration_fields": [
          {
            "id": "123AbcDEFG4hijK5Lmn67OPq",
            "key": "dynamic_5487319",
            "type": "CUSTOM",
            "value": "National Health",
            "label": "Name of health insurance"
          }
        ],
        ...
      }
    ]
  }
}
```


# Issue types
Source: https://docs.kombo.dev/lms/features/issue-types

All customer-visible issue types Kombo can raise, and when they are created and resolved.

Kombo [raises an issue](./issues) when a condition is true and resolves it when that condition clears. This page lists every customer-visible type. Internal-only types are not included.

`issue.type` on the [`issue-status-changed`](../guides/webhooks#issue-status-changed) webhook is the identifier shown under each heading. We add types over time, so your handler should treat `issue.type` as an open set and not fail on unknown values.

## Authentication failed

Type: `integration.authentication_failed`

Raised when Kombo cannot authenticate with the connected tool. That happens when a sync's connection test fails with an authentication error, or when a scheduled OAuth credential refresh fails because the credentials are invalid. Rate limits during a sync do not raise this issue.

Resolved when a later sync successfully tests the connection, or when OAuth credentials refresh successfully.

## Action failing

Type: `integration.action_failing`

Raised when at least 50% of the finished calls for a specific action on an integration have failed in the last 24 hours, and there have been at least 5 finished calls in that window. Kombo checks this after each action call.

Resolved when a later check finds fewer than 5 finished calls in the window, or a failure rate below 50%. If the action is not called again, the issue also resolves 24 hours after it was last raised.

## Incoming webhooks failing

Type: `integration.incoming_webhook_failing`

Raised when at least 50% of the incoming webhooks for an integration have failed in the last 6 hours, and there have been at least 5 incoming webhooks in that window. Kombo checks this after it receives a webhook from the tool.

Resolved when at least 5 incoming webhooks in the last 6 hours have a failure rate below 50%. It stays open if webhooks stop, or if fewer than 5 have arrived in the window.


# Issues
Source: https://docs.kombo.dev/lms/features/issues

See which integrations need attention, and how long the problem has been going on.

When an integration starts failing, you want to know about it before your customer does. Issues put those problems on the dashboard as soon as Kombo observes them, so you can act before the end customer complains.

<Frame>
  <img alt="Issues column on the integrations list" />
</Frame>

The integrations list shows an issue count on any integration that currently has an open issue. Hover the count to see the title and how long Kombo has been observing it.

Open the integration to read what is wrong and what to do next.

<Frame>
  <img alt="Issue details on an integration" />
</Frame>

## What an issue is

Kombo's issues track a problem of an integration over time. Kombo raises them when a condition is true (for example, authentication is failing) and keeps it open while that condition is still observed. When the condition clears, the issue resolves on its own.

Each issue tells you:

* what is broken
* how to investigate or fix it
* when Kombo first observed it, and when it last saw it again

See [all issue types](./issue-types) for when each one is raised and resolved. More types will follow.

## What to do when you see one

1. Open the integration from the list.
2. Read the issue. Follow the linked [logs](./logs) if you need the underlying requests.
3. If credentials are invalid, [reconnect the integration](../guides/connect/reconnection).

The [integration state](../guides/integration-states) on the same page is the current snapshot (`Active`, `Sync failing`, `Authentication failing`). The issue is the durable record that the problem is still happening, and for how long.

You can snooze an issue to hide it in the Kombo dashboard for a while. Snoozing only affects the UI. The issue stays open, Kombo keeps observing it, and it does not send an [`issue-status-changed`](../guides/webhooks#issue-status-changed) webhook.

Subscribe to that webhook to get raised and resolved events as they happen. Slack notifications will follow.

<CardGroup>
  <Card title="Issue types" icon="list" href="./issue-types">
    When each issue type is raised and resolved.
  </Card>

  <Card title="Logs" icon="scroll" href="./logs">
    Inspect the requests behind a failing sync or action.
  </Card>

  <Card title="Reconnecting" icon="arrow-rotate-right" href="../guides/connect/reconnection">
    Restore credentials when authentication has failed.
  </Card>

  <Card title="Integration states" icon="traffic-light" href="../guides/integration-states">
    Read the current operational status of an integration.
  </Card>

  <Card title="Webhooks" icon="webhook" href="../guides/webhooks#issue-status-changed">
    Get raised and resolved issue events as they happen.
  </Card>
</CardGroup>


# Komboman
Source: https://docs.kombo.dev/lms/features/komboman

Test and troubleshoot both Kombo API and passthrough API calls with our built-in API client.

## Overview

Komboman is a powerful API testing tool built directly into the Kombo dashboard that allows you to test, explore, and troubleshoot both Kombo's unified API endpoints and integration-specific passthrough API calls. It provides a convenient way to interact with APIs without requiring you to provide any authentication credentials.

<img alt="Komboman" />

## Key Benefits

* **Test Kombo API Endpoints**: Validate Kombo's unified API responses and test data models directly
* **Test Passthrough Functionality**: Quickly verify the functionality of integration-specific API endpoints
* **Troubleshoot Data Quality Issues**: Identify and resolve data format or content issues directly
* **Self-Service Debugging**: Diagnose and resolve API issues independently
* **Request History**: Save and revisit previous API requests for reference and troubleshooting
* **Simplified Authentication**: No need to manage API keys or tokens separately - we handle the authentication

## Supported API Types

### Kombo API

Test Kombo's unified API endpoints directly from the dashboard, including all HRIS, ATS, and general endpoints like `/hris/employees`, `/ats/jobs`, `/ats/applications`, `/integrations/{integration_id}`, etc. Automatic authentication and audit logging are included.

### Passthrough APIs

Test integration-specific APIs for connected tools to access native functionality not covered by unified endpoints and debug integration-specific issues.

## How It Works

Komboman provides an intuitive interface for working with both API types:

1. **Select API Type**: Choose between "kombo" (unified API) or integration-specific passthrough APIs
2. **Configure Request**: Set the HTTP method, path, query parameters, and body for your request
3. **Send and View Responses**: Instantly see the API response, including status codes and data
4. **Save Request History**: Automatically save your requests for future reference

## Where to Find Komboman

Komboman is located within individual integration pages in the Kombo dashboard:

1. **Go to Integrations**: Navigate to the [Integrations page](https://app.kombo.dev/integrations) in your dashboard
2. **Select an Integration**: Click on any connected integration from your list
3. **Access Komboman**: Click the "Komboman" tab in the integration interface

<img alt="Komboman" />

## Getting Started

To use Komboman:

1. Select the desired API from the dropdown:
   * **"kombo"** - Test Kombo's unified API endpoints for the selected integration.
   * **Integration-specific APIs** - Test passthrough functionality
2. Configure your request with the appropriate method, path, and payload
3. Send your request and analyze the response

### Testing Kombo API Endpoints

When testing Kombo API endpoints, select "kombo" from the API dropdown and enter the endpoint path (e.g., `/employees`, `/jobs`, `/applications`). Refere to our API reference for all available endpoints. All requests are automatically authenticated and audit logged.

### Testing Passthrough APIs

When testing integration-specific passthrough APIs, select the appropriate passthrough API from the dropdown and configure the request according to the integration's native API documentation which is linked on the selected API.

Komboman works directly with our [Passthrough API](./passthrough-api), which enables you to interact with the native APIs of specific integrations while we handle the authentication.

## Access Permissions

Komboman is available to:

* **Production Environment**: Users with admin role
* **Development Environment**: Users with admin or developer role


# Logs
Source: https://docs.kombo.dev/lms/features/logs

Learn how Kombo's logs allow you to monitor and troubleshoot your integrations.

## Overview

Our logs enable you to dig deeper into what is happening behind your integrations. Depending on the type of interaction, different logs are available.

You can find the logs in the [sidebar of the Kombo dashboard](https://app.kombo.dev/logs).

<Frame>
  <img alt="logs-overview" />
</Frame>

### Available Log types

| Log Type             | Description                                                                                                                                                                   | Features                                                                 |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| **Sync**             | Created for each recurring sync of an integration                                                                                                                             | [Sync Metrics](#sync-metrics), [Request Logs](#request-logs)             |
| **Connection Flow**  | Created for each connection flow interaction                                                                                                                                  | [Event Logs](#connection-flow-event-logs), [Request Logs](#request-logs) |
| **Action**           | Created whenever Kombo receives an API request which triggers Kombo to make external API requests to a tool. E.g. [create application](/ats/v1/post-jobs-job-id-applications) | [Request Logs](#request-logs)                                            |
| **Passthrough**      | Created for each [passthrough](./passthrough-api) request made                                                                                                                | [Request Logs](#request-logs)                                            |
| **Incoming Webhook** | Created whenever a tool sends an API request to Kombo                                                                                                                         | [Request Logs](#request-logs)                                            |

### Filters

Use filters to narrow your search and find exactly what you're searching for.

We additionally make sure to link back to any logs from relevant dashboard pages. For example, you can instantly query an integration's logs by clicking "logs" on the integration's details page.

<Frame>
  <img alt="log-filters" />
</Frame>

## Request Logs

Request logs help you see any API requests that Kombo is making to the integrated tool, and debug any issues. If an integration is having issues, request logs let you deep dive into understanding which endpoints are causing problems, such as finding requests returning `403` status codes for missing permissions.

<Frame>
  <img alt="request-logs" />
</Frame>

### Viewing Details

Click on a row to view details of the API request. Kombo will redact any sensitive data.

You can view the response of the request by clicking on **Open response**.

<Frame>
  <img alt="request-log-details" />
</Frame>

### Retention

By default, Kombo stores logs for 30 days. Longer retentions are available upon request on the enterprise plan.

## Connection Flow Event Logs

We store any decisive events that happen throughout the connection flow to enable you to understand exactly what your customer is experiencing. This visibility lets you detect what is preventing your customers from connecting their tool, and ultimately reach out to them with the right help to complete the integration.

<Frame>
  <img alt="connection-flow-logs" />
</Frame>

View your current connection flow logs in the [Kombo dashboard](https://app.kombo.dev/logs?kind=CONNECTION_FLOW).

### Identifying User Sessions

The logs are grouped by user sessions, with a 'broken' line indicating a break between two sessions. Viewing sessions allows you to gain insights on when a user exited and/or re-entered the connection flow.

<Frame>
  <img alt="flow-log-sessions" />
</Frame>

## Sync Metrics

The sync metrics tab allows you to gain insights into which data was read and whether any issues occurred. Use this to quickly verify that the expected data is being synced without having to make any API calls.

<Frame>
  <img alt="sync-metrics" />
</Frame>


# Passthrough API
Source: https://docs.kombo.dev/lms/features/passthrough-api

Implement any edge case feature with our passthrough API.

## Overview

The Passthrough API lets you call the native API of any connected integration directly, while Kombo handles authentication for you. This bridges the gap between the unified API and integration-specific requirements — you get the consistency of Kombo's auth layer with the flexibility of the underlying tool's full API surface.

## When to Use It

Use the Passthrough API when you need integration-specific data or actions that the unified API does not cover. Common examples:

* Reading provider-specific resources (e.g., HiBob work history, Workday compensation plans)
* Calling write endpoints that Kombo doesn't offer as a unified action
* Accessing tool-specific configuration (e.g., ATS picklists, custom templates)

<Tip>
  For reading additional fields on standard models, prefer [custom
  fields](./custom-fields) — they're simpler and work across integrations.
  [Integration fields](./integration-fields) cover a narrow niche and are rarely
  the right choice. The Passthrough API is best for accessing entirely different
  endpoints or performing writes that aren't part of the unified API.
</Tip>

## How It Works

1. **Authentication**: Authenticate with your Kombo API key as usual. Kombo forwards the request with the correct tool-specific credentials.
2. **Choose the API**: Find the API identifier for your integration in the [passthrough endpoint reference](../v1/post-passthrough-tool-api).
3. **Build your request**: Specify the HTTP method, endpoint path, headers, query parameters, and request body — exactly as the tool's native API expects.

## The `api_options` Parameter

Most integrations don't require `api_options` — simply set the `path` and Kombo routes to the right API.

However, some integrations have multiple underlying APIs or services that share the same authentication but use different base URLs or protocols. For these, `api_options` tells Kombo which specific service to target.

Integrations that use `api_options` document the required fields directly on their passthrough endpoint specification. Common examples:

* **Workday REST**: requires `service_name` (e.g., `"staffing"`, `"compensation"`) and optionally `version` to select the correct REST service
* **Workday SOAP**: requires `service_name` (e.g., `"Staffing"`, `"Recruiting"`) and optionally `service_version` to target the right SOAP service
* **SOAP-based tools** (Nmbrs, HR Office, Taleo): require `service_name` or `operation_name` to route to the correct SOAP service

If an integration doesn't document `api_options`, you don't need to provide it.

## Testing with Komboman

Use [Komboman](./komboman), the built-in API client in the Kombo dashboard, to test passthrough calls interactively. It handles authentication automatically and saves request history, making it easy to experiment with native API endpoints.

Find the full passthrough endpoint specification [here](../v1/post-passthrough-tool-api).


# Remapping array fields
Source: https://docs.kombo.dev/lms/features/remapping/array-remapping

Learn how to use the remapping feature to adjust Kombo array fields based on fields in your customer's systems.

## Remapping an array field

Array fields in the Kombo data model can have multiple entries per entity. For example our HRIS employee can have multiple `bank_accounts` and an ATS candidate can have multiple `email_addresses`.
These fields will offer two mapping modes: `Replace` and `Append`

<Frame>
  <img alt="image" />
</Frame>

This will decide wether you would like to persist the Kombo default mappings in
the array or replace the array entirely.

After deciding on the mapping mode you can start adding entries to the array. Please note that all required fields for an entry need to be mapped.

<Frame>
  <img alt="image" />
</Frame>

For `bank_accounts` you need to select an account type before the fields show up. You can mix multiple types in the array.

<Frame>
  <img alt="image" />
</Frame>

## Fallbacks

Fallbacks are not available for these fields. Instead you can add multiple values to the array. If any required field (marked with red asterix) of single entry is missing, the entry will not be added to the array.

<Frame>
  <img alt="image" />
</Frame>


# Remapping date fields
Source: https://docs.kombo.dev/lms/features/remapping/date-remapping

Learn how to use the remapping feature to adjust Kombo date fields based on fields in your customer's systems.

## Remapping a date field

1. Select the source field of the date. It can bei either a string or number.
   <Frame>
     <img alt="image" />
   </Frame>
2. Pick a date format from our presets or choose `Custom format`.
   <Frame>
     <img alt="image" />
   </Frame>
3. (optional) If you have custom field examples enabled we will display a validation section below. Adjust the format until the dates are parsed as desired.
   <Frame>
     <img alt="image" />
   </Frame>
4. Press the `Save configuration` button on the bottom right.
   <Frame>
     <img alt="image" />
   </Frame>


# Remapping enum fields
Source: https://docs.kombo.dev/lms/features/remapping/enum-remapping

Learn how to use the remapping feature to adjust Kombo enum fields based on fields in your customer's systems.

## Remapping an enum field

1. Select the source field to map the enum from.
   <Frame>
     <img alt="image" />
   </Frame>
2. Define a default value. This will be the result in case the value is not mapped or null. If you want to use `fallbacks` make sure to select `None (null)` here.
   <Frame>
     <img alt="image" />
   </Frame>
3. Define an enum map. For this you first input the source string on the left. Then click the `Add mapping` button.
   <Frame>
     <img alt="image" />
   </Frame>
   After adding the source string, select one of the Kombo enum values.
   <Frame>
     <img alt="image" />
   </Frame>


# Introduction
Source: https://docs.kombo.dev/lms/features/remapping/introduction

Learn how to use the remapping feature to adjust Kombo default fields based on fields in your customer's systems.

## Prerequisits

The remapping UI is located on each individual integration right next to the "Custom Field Mappings" tab.

<Frame>
  <img alt="image" />
</Frame>

1. Your scope config for the integration will need either `custom_fields` or `integration_fields` **enabled for each model** you wish to remapp.
   <Frame>
     <img alt="image" />
   </Frame>
2. The initial sync has **finished successfully** and the integration is **not in QA mode**.
   <Frame>
     <img alt="image" />
   </Frame>
3. (optional) To improve your mapping experience we recommend enabling custom field examples for new integrations. The setting can be found under `Configuration` in the left sidebar.
   <Frame>
     <img alt="image" />
   </Frame>

We offer different user interfaces to accomedate the complexity that comes with each specific field:

1. [Simple string/number/boolean fields](./simple-remapping)
2. [Enum fields](./enum-remapping)
3. [Date fields](./date-remapping)
4. [Address fields](./struct-remapping)
5. [Reference fields](./reference-remapping)
6. [Array fields](./array-remapping)

Additionally, you can use the [Kombo Default Fallback](./kombo-default-fallback) to include Kombo's standard mapping logic as a priority in your fallback chain — available for simple, enum, and date fields.


# Kombo default fallback
Source: https://docs.kombo.dev/lms/features/remapping/kombo-default-fallback

Learn how to use Kombo's standard mapping logic as a fallback priority in your remapping configuration, giving you full control over the mapping order.

## What is the Kombo Default Fallback?

When you [override a field mapping](./introduction), you replace Kombo's built-in mapping logic with your own custom configuration. This is powerful, but sometimes you don't want to *replace* Kombo's logic entirely — you want to **combine** your custom mapping with Kombo's standard logic in a specific priority order.

The **Kombo Default Fallback** lets you insert Kombo's standard mapping logic as one of the priorities in your fallback chain. This means you can:

* Use a custom integration field as the primary source, and **fall back to Kombo's default** if that field is empty
* Use Kombo's default mapping as the **primary value**, but override it with a custom field when Kombo's value is empty
* Place Kombo's default logic **between** two custom field sources in a multi-level fallback chain

<Note>
  The Kombo Default Fallback is available for **simple** (string, number,
  boolean), **enum**, and **date** field remappings. It is not available for
  address, reference, or array field types.
</Note>

## When should you use it?

Consider using the Kombo Default Fallback when:

* **Kombo's default mapping works well in most cases**, but a small number of your customer's records store the value in a different field. You can set Kombo's default as Priority 1 and your custom field as a fallback.
* **A custom field is your preferred source**, but it isn't always populated. By adding Kombo's default as a fallback, you ensure no data is lost when the custom field is empty.
* **You want to experiment with a custom mapping** without losing the safety net of Kombo's proven default logic. If your custom source produces `null`, Kombo's standard mapping takes over automatically.

## How it works

The remapping engine evaluates your fallback chain **from top to bottom** (Priority 1 first, then Priority 2, and so on). For each record (employee, candidate, job, etc.), it checks each priority in order and **stops as soon as a valid, non-empty value is found**.

When the engine reaches a "Default Kombo value" entry in the chain, it uses the value that Kombo's standard mapping logic would have produced for that field — exactly as if no remapping had been configured.

### Example: Custom field with Kombo default as safety net

Suppose you want to map the `first_name` field from a custom integration field called `preferred_name`, but not every record has a preferred name set.

| Priority | Source                               | Behavior                                                                           |
| -------- | ------------------------------------ | ---------------------------------------------------------------------------------- |
| 1        | `preferred_name` (integration field) | Used when the field has a value                                                    |
| 2        | Default Kombo value                  | Falls back to Kombo's standard `first_name` mapping when `preferred_name` is empty |

**Result**: Records with a `preferred_name` get that value. Records without it seamlessly fall back to whatever Kombo would have mapped by default.

### Example: Kombo default with a custom override

You trust Kombo's mapping for most records, but for a few edge cases you know a specific integration field has better data.

| Priority | Source                             | Behavior                                               |
| -------- | ---------------------------------- | ------------------------------------------------------ |
| 1        | Default Kombo value                | Used when Kombo's standard mapping produces a value    |
| 2        | `backup_field` (integration field) | Only used when Kombo's default mapping produces `null` |

**Result**: Kombo's default logic runs first. Only when it returns nothing does the system check `backup_field`.

## Adding a Kombo Default Fallback

1. Open the remapping modal for the field you want to configure (see [simple](./simple-remapping), [enum](./enum-remapping), or [date](./date-remapping) remapping for details on how to open the modal).
2. At the bottom of the modal, click the **Fallback to Kombo's mapping** button.
   <Frame>
     <img alt="image" />
   </Frame>
3. A new priority entry will appear showing **"Default Kombo value"** with the description *"Uses Kombo's standard mapping logic for this field."*
   <Frame>
     <img alt="image" />
   </Frame>
4. You can **reorder** priorities by removing and re-adding entries. The Kombo Default Fallback can be placed at any position in the fallback chain — it does not have to be last.
5. Click **Save** to apply the configuration. Remember that **a sync is required** for saved changes to take effect.

## Combining with other fallbacks

You can freely mix Kombo Default entries with custom integration field entries. For example, a three-level fallback chain for an enum field might look like:

| Priority | Source                                                      |
| -------- | ----------------------------------------------------------- |
| 1        | `custom_status_field` (integration field) with enum mapping |
| 2        | Default Kombo value                                         |
| 3        | `legacy_status_field` (integration field) with enum mapping |

The engine will try `custom_status_field` first. If it's empty, it falls back to Kombo's default enum mapping. If even that produces `null`, it tries `legacy_status_field` as a last resort.

<Tip>
  If the **only** entry in your fallback chain is a Kombo Default, the
  configuration is equivalent to having no remapping at all. In this case, the
  system will automatically clear the remapping configuration when you save.
</Tip>

## Supported field types

| Field type                                             | Kombo Default Fallback supported |
| ------------------------------------------------------ | -------------------------------- |
| [Simple](./simple-remapping) (string, number, boolean) | Yes                              |
| [Enum](./enum-remapping)                               | Yes                              |
| [Date](./date-remapping)                               | Yes                              |
| [Address](./struct-remapping)                          | No                               |
| [Reference](./reference-remapping)                     | No                               |
| [Array](./array-remapping)                             | No                               |


# Remapping reference fields
Source: https://docs.kombo.dev/lms/features/remapping/reference-remapping

Learn how to use the remapping feature to adjust Kombo reference fields based on fields in your customer's systems.

## Remapping an reference field

Reference fields are fields that reference related entities. For example our employee model has three reference fields: manager\_id, legal\_entity\_id and work\_location.
These fields can offer up to two mapping types.

<Frame>
  <img alt="image" />
</Frame>

## Refernce existing record

1. When choosing `Refernce existing record` the model will be linked to an already existing record.
2. You will need to select a field that contains the same remote id as the model you wish to reference.
   <Frame>
     <img alt="image" />
   </Frame>
   If the referenced record does not exist, it will be created but all other
   fields except the id will be `null`.

## Create new record with mapped data

1. When choosing `Create new record with mapped data` the model will be linked to a new record. You will be able to create a new work location, legal entity, etc.
2. Fill the the remote id with the unique identifier you want to use for the new record.
3. Then fill the rest of the properties.
   <Frame>
     <img alt="image" />
   </Frame>

You will be able to receive the new record on both the `/employees` endpoint, as well as the relations own endpoint (`/work-locations`, `/legal-entities`).
Note: This option is not available for all reference fields.


# Remapping simple fields
Source: https://docs.kombo.dev/lms/features/remapping/simple-remapping

Learn how to use the remapping feature to adjust simple Kombo default fields based on fields in your customer's systems.

## Remapping a simple string/number/boolean field

To start the remapping process open the remapping UI and click on the `Override default Kombo value` button of the field you want to remapp.

<Frame><img alt="image" /></Frame>A new popup will
appear allowing you to configure the remapping for the individual field.

<Frame>
  <img alt="image" />
</Frame>

Under `Priority 1` you can select the source field you would like to use for the
remapping. You can search in the selection box, see the example values and even
use our custom field explorer feature.

<Frame>
  <img alt="image" />
</Frame>

After selecting the field, you can press the `Save` button to save the
configuration.

<Frame>
  <img alt="image" />
</Frame>

If this is your first remapping, a popup will appear, which reminds you that **a
sync is required** for the saved changes to show their effect.

<Frame>
  <img alt="image" />
</Frame>

## Fallbacks

In case the selected field is removed (`undefined`), `null` or changes it's structure (`string` => `array`), the remapping will result in `null` as output.
For these cases it makes sense to define one or multiple fallback values, when configuring a remapping. You can do so by clicking the `Add fallback` button in the configuration UI.

<Frame>
  <img alt="image" />
</Frame>

We will execute the remapping top to bottom. This means the remapping stops for
each the entity (employee, candidate, job...) has soon as valid value is found.

<Frame>
  <img alt="image" />
</Frame>

You can also use the **Fallback to Kombo's mapping** button to include Kombo's standard mapping logic as one of the priorities in your fallback chain. This is useful when your custom field is not always populated and you want to fall back to what Kombo would have mapped by default. Learn more in the [Kombo Default Fallback](./kombo-default-fallback) guide.


# Remapping address fields
Source: https://docs.kombo.dev/lms/features/remapping/struct-remapping

Learn how to use the remapping feature to adjust Kombo address fields based on fields in your customer's systems.

## Remapping an address field

1. An address in Kombo consists out of multiple fields. Select an integration field for each field you wish to fill. Unfilled will result in `null` for the respective property.
   <Frame>
     <img alt="image" />
   </Frame>
2. You might need to scroll to see all available fields.

Note: English country names will get automatically resolved to the ISO 3166-1 alpha-2 country code.

## Fallbacks

Fallbacks are only executed if **all fields** in the priority above are missing (`undefined`), `null` or empty (`''`).


# Extend write endpoints
Source: https://docs.kombo.dev/lms/features/remote-fields

Learn how Kombo allows you to write additional, otherwise unsupported fields with unified write actions.

## Overview

Kombo supports a feature called **Remote Fields** for many write endpoints. This
feature solves a similar problem as the [passthrough API](./passthrough-api) while still allowing you
to use the unified Kombo API.

## How does it help you

While we always try to solve even niche use cases with our unified API, there are cases
where an integration requires particular data (for example, because your customer
uses required custom fields or customizes their system a lot). In these cases, the
remote fields feature allows you to pass this data to the connected system.

Remote fields also allow you to customize specific endpoints even more, as it
would be out of scope for the unified model.

If you need to read additional data from connected systems instead, use
[custom fields](./custom-fields).

## How to use it

Write actions that support this feature support have a property called `remote_fields`
on the root level request body. This object follows a record structure where the
key is the name of the tool (e.g., `greenhouse`), and the value is an object
highly specific to the tool. On a high level, most available fields are documented in the endpoint specification.

A good example of a write endpoint supporting this feature is [the ATS API endpoint to create a new application](/ats/v1/post-jobs-job-id-applications) (search for 'remote fields').

### Example

A SuccessFactors instance requires the nationality of applicants as an attribute.
`nationality` isn't an attribute that is ordinarily supported by our
'Create application' endpoint. Because application creation generally works the
same otherwise, you can use `remote_fields` to extend the requests that we send
to SuccessFactors with the `nationality` field.

### Remote fields in practice

You will likely find out about any required remote fields during testing.
You may try to submit a dummy candidate, however, you receive an error message like the
following:

```
{'status': 'error', 'error': {'message': {'remote_http_status': 500, 'remote_error': {'error': {'code': 'COE_GENERAL_SERVER_FAILURE', 'message': {'lang': 'en-US', 'value': '[COE0019]Unexpected error occurred: custNationality required for external candidate, custFutSponsor required for external candidate as per field override,  for templateId 579 ,  with the index 0'}}}}}}
```

For example, for the above error message, you would then need to add the following fields to your create candidate call for the parameter `remote_fields`:

```
{
    "successfactors": {
        "Candidate": {
            "custNationality": "some-nationality",
            "custFutSponsor": "some-sponsor"
        }
    }
}
```

You can then use an iterative process based on the error messages
("trial-and-error") to tell whether you are now submitting the correct remote fields.

### Help

Don't hesitate to contact us if you have any questions about this feature
or you need help with a specific use case.


# Scopes
Source: https://docs.kombo.dev/lms/features/scopes

Scopes allow you to customize what data is being synced by Kombo.

By default, Kombo syncs all available data from connected systems. This can be
pretty convenient for exploring what's available during development, but as soon
as you take Kombo into production, you'll likely want to restrict what data is
extracted and stored for privacy and security reasons.

For this purpose, Kombo provides what we call "Scopes." These allow you to
configure precisely which models and data points are being extracted and stored.
Scopes can, for example, be used to anonymize data by removing all personal
identifiable information from the data we store.

## Configuring scopes

To get started configuring scopes, log into the
[Kombo Dashboard](https://app.kombo.dev) and open the "Scope Config" page. It
should look something like this:

<Frame>
  <img alt="1464" />
</Frame>

### Configure scope config

When editing your scope configs or creating a new one, a page similar to this
one will open:

<Frame>
  <img alt="1464" />
</Frame>

All of Kombo's Data Models are listed here, and you can disable, enable or
mark an entire Data Model as optional.
We do not sync data from disabled data models. Optional Data Models aren't
synced if your customer opts out of having the field exposed. Enabled
models are always synced.

We recommend turning all Data Models off that you are not interested in. For example,
if you want to sync employee, employment and organization data
but are not interested in absences, turning off the absence type, absences and
time off balance Data Models is recommended. This will simplify the setup for your customer, improve sync times, and
not expose any data that does not need to be exposed.

### Configuring fields

If you only want to turn off individual model fields, you can expand
each model in the edit page. You will now see all the fields it supports:

<Frame>
  <img alt="1426" />
</Frame>

For example, if you don't want to sync sensitive data like SSNs or Tax IDs,
you can turn them off here. Similarly, if you would like to read
personal identifiable information but it is not required for your use-case,
consider marking the field as optional. This will give your customers the choice
of whether they want to expose it or not.

## Building trust with your customers

Some of the systems we help you integrate contain very sensitive data (like
personal addresses or tax IDs of employees). That's why
communicating which data points you access and which you don't is critical to
building trust and eradicating concerns during the sales process.

To help you with this, we're exposing your scope config to the end user as part
of our connection flow:

<Frame>
  <img alt="1002" />
</Frame>

This way, your customers can see exactly which data points you're accessing.


# Setup Flow
Source: https://docs.kombo.dev/lms/features/setup-flow/introduction

Let your customers configure their integration end-to-end.

<img alt="Setup Flow" />

The [Connection Flow](/kombo-connect) lets your customers authenticate and
validate their credentials. The Setup Flow covers everything that comes after:
any additional configuration the integration needs before it can sync the right
data. It is presented to your customers as a self-serve UI inside the Kombo
Connect SDK, so they can complete it without you building anything yourself.

## What appears in the Setup Flow

Each integration decides which steps it actually needs. The most common ones
are:

* **[Field mapping](../custom-fields#self-serve-custom-field-configuration)**,
  where customers connect your custom fields to fields in their tool. Available
  for any category as long as you've defined custom fields.
* **[Employee filtering](/hris/features/filtering/introduction)**, where HRIS
  customers choose which employees Kombo should sync.
* **Tool-specific steps**, surfaced automatically by some connectors (for
  example Greenhouse, Teamtailor, or SCIM) to handle one-time configuration that
  the tool itself requires, like activating webhooks or providing additional
  credentials.

Steps only show up when they are relevant. If a customer connects a tool that
does not support filtering, the filtering step is hidden even when the feature
is enabled on the integration.

## Enabling Setup Flow steps

Field mapping and employee filtering are opt-in per integration. Tool-specific
steps require no configuration on your side, they appear automatically when
needed.

### When creating a new integration

In the Dashboard, open the [Integrations
page](https://app.kombo.dev/integrations) and toggle the steps you want at the
bottom of the create-link form.

<img
  alt="Integration Creation Form Setup Flow
Toggles"
/>

You can do the same via the API by setting `enable_field_mapping` and/or
`enable_filtering` (HRIS only) to `true` on the [Create Connection Link
endpoint](../../v1/post-connect-create-link).

### For an existing integration

Open the integration in the Dashboard and use the toggles in the **Integration
Settings** tab.

<img alt="Integration Settings Setup Flow Toggles" />

## Showing the Setup Flow to your customers

Setup Flow steps run automatically as part of the [Connection
Flow](/kombo-connect) the first time a customer connects a tool, so the
embedded flow you already have in place will pick them up without any changes.

To send customers back into the Setup Flow later, for example to update field
mappings or change which employees are synced, create a setup link with the
[Create Setup Flow link
endpoint](../../v1/post-integrations-integration-id-setup-link) and pass it to
`showKomboConnect` from the [Kombo Connect
SDK](../../guides/connect/embedded-flow#opening-the-flow), the same way you do
with a connection link.

You can also generate a setup link from the Integration Details page in the
Dashboard if you'd rather not wire up the API yourself.


# Overview
Source: https://docs.kombo.dev/lms/getting-started

Let's get you up and running with our API!

<Note>
  This guide assumes you already have a Kombo account. If that's not the case,
  visit [our website](https://www.kombo.dev/) to learn more and get access.
</Note>

# Getting started

There are a few simple steps that you should follow to get started with our API.

1. [Get access to a sandbox integration](./getting-started/sandbox-integrations)
2. [Create an integration](./getting-started/create-integrations)
3. [Call our API](./getting-started/authentication)
4. [Querying the API](./getting-started/querying-api)
5. [Fetching Data](./getting-started/fetching-data)


# Authentication
Source: https://docs.kombo.dev/lms/getting-started/authentication

Learn how to authenticate with the Kombo API and manage API keys securely.

## Authentication

You need to get an API key from the Kombo dashboard to call our API.
You can create one on the [Secrets page](https://app.kombo.dev/secrets).

You might have multiple environments in your Kombo account. Each API key is
specific to an environment.

This will allow you to call some general endpoints that are not
integration-specific. For example, try calling the following test API key endpoint:

```bash theme={null}
curl --request GET \
  --url https://api.kombo.dev/v1/check-api-key \
  --header 'Authorization: Bearer <YOUR_API_KEY>'
```

## Calling Integration Endpoints

To call integration-specific endpoints, you need the integration ID. An integration ID identifies a specific
instance of a tool connected to Kombo. If you haven't created an integration yet,
read the [creating integrations guide](./create-integrations).
Get the integration ID from the details of integration on the [integrations dashboard page](https://app.kombo.dev/integrations).

Pass the integration ID with the `X-Integration-Id` header in your API requests. For example:

```bash theme={null}
curl --request GET \
  --url https://api.kombo.dev/v1/hris/employees \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'X-Integration-Id: <integration_id>'
```

<Note>
  Find out more about the integration-specific endpoints for
  [HRIS](/hris/getting-started) or [ATS](/ats/getting-started)
</Note>

## API Key Security

Kombo provides several features to help you manage API keys securely.

### Key Scoping

Each API key is scoped to a single [environment](../guides/environments) (Production or Development). Keys created in Production cannot access Development data and vice versa. The key prefix reflects the environment: `ks_prod_...` for production, `ks_dev_...` for development.

### Expiration

When creating an API key, you can set an optional expiration date. Once expired, any request using the key will return an authentication error. To rotate keys without downtime, you must overlap the old and new keys: create a new key, migrate all of your services to use it, and only then let the old key expire (or revoke it).

### IP Allowlisting

You can restrict each API key to a set of IP addresses or CIDR ranges. When an allowlist is configured, requests from non-listed IPs are rejected. An empty allowlist (the default) permits any IP. You can update the allowlist at any time without recreating the key.

### Revocation

API keys can be individually disabled from the dashboard. Disabling a key takes effect immediately — all subsequent requests using that key will fail. Disabled keys cannot be re-enabled; create a new key instead.

### Audit Trail

All key operations — creation, disabling, and IP allowlist changes — are recorded in the [audit log](../features/audit-logs).


# Creating Integrations
Source: https://docs.kombo.dev/lms/getting-started/create-integrations

Learn how to connect tools to Kombo.

<Note>
  This guide assumes you already have a Kombo account. If that's not the case,
  visit [our website](https://www.kombo.dev/) to learn more and get access.
</Note>

## Ways of Creating Integrations

There are three ways of creating integrations in Kombo:

1. **For you in development**: Use the Kombo Dashboard and enter the integration credentials yourself.
   This is the easiest way to get started if you want to test out Kombo.
2. **For customers with a magic link**: Create a magic link and send that to your customer to create the integration.
   This is the simplest way to launch integrations for selected customers (for example, as a POC).
3. **For customers with Kombo embedded**: Embedding Kombo into your application and allowing the customer to create the integration there.
   This will give your customer the best experience and is generally recommended when rolling out Kombo to your customers.

If you are testing Kombo or developing the integration to us, make sure to
select the development environment in the top left corner.
This will not count against your billing and will have useful features like saving
the credentials that you entered and filled out some fields by default.

# Creating Integrations in the Dashboard

<Tip>Recommended for development purposes.</Tip>

Go to the [dashboard integrations page](https://app.kombo.dev/integrations) and
click on the "Create Integration" button. Select `Create the integration yourself`.

<Frame>
  <img alt="image" />
</Frame>

Select a category and continue (if you use the development environment,
the organization and email will be auto-filled). Select a tool that you have
access to and enter the credentials. The flow will explain, in most cases, what
you need to do to get the credentials out of the tool.

# Creating a magic link

<Info>Use this to get started immediately with a selected customer.</Info>

Open the [dashboard integrations page](https://app.kombo.dev/integrations) and
click on the "Create Integration" button. Select *Let your customer create the integration*.

Select the category and fill out the organization name and email address.
This data is only for you to identify who created the integration and will be used
as a label in the dashboard.

Features that you can use with the embedded flow are:

* Pre-defining a tool
* Defining a language

# Embedding Kombo into your Application

<Info>
  This is only necessary if you want to allow your customer to create
  integrations completely on their own.
</Info>

Embedding Kombo in your application requires implementing the Kombo API into your product.
Embedding Kombo allows you to provide a better experience to your customers and customize the
connection flow the most.

Features that you can use with the embedded flow are:

* Pre-defining a tool
* Defining a language
* Specifying the `remote_environment` (for using sandbox credentials with some tools)
* Using a scope config template
* Setting the `origin_id` (id of the customer in your system)

<Note>
  Read more about embedding Kombo into your application
  [here](../guides/connect/embedded-flow).
</Note>


# Fetching Data
Source: https://docs.kombo.dev/lms/getting-started/fetching-data

Learn how to get the newest data back from Kombo.

To minimize latency between data changes in the connected tool and your system,
and to prevent data drift, we recommend combining data-changed notifications
with periodic full fetches.

Best-practice implementation:

* Listen to our **data-changed webhook** to receive notifications of data
  changes.
* Fetch only updated data.
* Periodically **fetch all data** to fully align your dataset and correct any
  potential data drift.
* Combine both strategies for a setup that is robust and efficient.

## Overview

```mermaid theme={null}
sequenceDiagram
    participant K as Kombo
    participant YS as Your System
    participant T as Timer

    Note over K,YS: Data-changed notifications
    K->>YS: Webhook: Data Changed
    YS->>K: Fetch Updated Data
    K-->>YS: Updated Data Response

    Note over T,YS: Periodic full fetch
    T->>YS: Periodic Trigger
    YS->>K: Fetch All Data
    K-->>YS: Full Data Response
```

## Listening to data-changed webhook

We provide a webhook called `data-changed`. This is sent to your system whenever
data has changed inside Kombo, for example after we finish syncing (full or delta sync).

By listening to this webhook, you can receive updates from Kombo efficiently,
allowing for the best possible UX.

The webhook will look similar to this, with an array of models that have changed
in our database since we last sent you that webhook:

```json theme={null}
{
  "id": "udcUMbfv9YkHqPY3uGiCpWsz",
  "type": "data-changed",
  "data": {
    "integration_id": "sandbox:7C9M5sXAQx2cNMpVHLojrFpL",
    "integration_tool": "sandbox",
    "integration_category": "LMS",
    "changed_models": [
      {
        "name": "lms_course_revisions"
      },
      {
        "name": "lms_courses"
      }
    ]
  }
}
```

**Simplified approach**

To make things simple, you can, whenever you receive a new data-changed webhook,
pull the models you're interested in, independent of the models we're telling
you changed.

**Recommended approach**

You can also listen to the data models we're telling you changed and pull data
based on those models. For that please look into the [list of
models](#all-models) that can appear.

Based on this list of changed models, figure out which requests you would like
to send. Keep in mind that models do not map 1:1 to our endpoints. For example,
you might be using the `/courses` endpoint to fetch both courses and their
associated skills.

Furthermore, after every successful fetch from us, store the timestamp of when
the respective fetch started. Use this timestamp during your next fetch and pass
it with your requests to the Kombo API as the `updated_after` query parameter.
Kombo will then only return the entries that changed since that timestamp.

**Good to know:** The `updated_after` filter also considers changes in models
that are returned by the endpoint as nested values. For example, the
`/course-progressions` endpoint will include every progression that has had
changes to related courses or users, even if the progression itself did not
change. Read more below.

## All models

You should call the endpoints you care about based on the models we tell you
have changed. The following table shows endpoints connected to the relevant
models that will be part of the data-changed webhook.

We recommend the following approach:

1. **Decide which endpoints are relevant for your use case** (e.g., if your
   system is centered around course completions, you primarily use Get course progressions).
2. **Map changed models to those endpoints** using the table.<br />For instance,
   if both lms\_course\_progressions and lms\_courses are listed in the webhook, but
   you primarily care about progressions, you only need to call Get course progressions,
   since course data is included there too.

This helps avoid unnecessary API calls while still ensuring your data is up to
date.

| **Endpoint**                                                   | **Models**                                                                                                              |
| -------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| [**Get users**](/lms/v1/get-users)                             | lms\_users                                                                                                              |
| [**Get courses**](/lms/v1/get-courses)                         | lms\_courses<br />lms\_course\_revisions<br />lms\_course\_providers<br />lms\_skills<br />lms\_join\_revisions\_skills |
| [**Get course progressions**](/lms/v1/get-course-progressions) | lms\_course\_progressions<br />lms\_courses<br />lms\_course\_revisions<br />lms\_users                                 |

## Preventing Data Drift

In addition to fetching data from Kombo's endpoints in response to receiving the
data-changed webhook, we recommend running a periodic full data fetch for the
data models you care about. In most cases, a 7-day schedule is ideal.

This helps to remedy any drift that may occur in your data, e.g. from accidental
manual changes or lost webhooks.

To implement this, perform GET requests for the Kombo data models you care about
without passing the `updated_after` query parameter. Then upsert the data
returned by Kombo and merge it with your existing data copy.

## Full Example Code

```ts theme={null}
async function handleDataChangedWebhook(body) {
  // Verify webhook sender here

  // Assuming we are using prisma as our ORM
  const integration = await prisma.integration.findUniqueOrThrow({
    where: {
      kombo_integration_id: body.data.integration_id,
    },
    select: {
      id: true, // Need the customer ID for the update
      last_fetched_from_kombo_at: true,
      kombo_integration_id: true, // Also select the integration ID
    },
  })

  // Track when WE start fetching (not when Kombo synced from the LMS)
  const fetchStartDate = new Date() // This time should be in UTC
  const lastFetchStartDate =
    integration.last_fetched_from_kombo_at?.toISOString()

  // Fetch data only when data-changed webhook indicates a change
  const progressionsChanged = !!body.data.changed_models.find(
    entry => entry.name === 'lms_course_progressions',
  )
  if (progressionsChanged) {
    await fetchCourseProgressions(
      integration.kombo_integration_id,
      lastFetchStartDate,
    )
  }

  await prisma.integration.update({
    where: {
      id: integration.id,
    },
    data: {
      last_fetched_from_kombo_at: fetchStartDate,
    },
  })
}

async function handleCronJob(integration) {
  const fetchStartDate = new Date() // This time should be in UTC

  // Do not pass a starting date here; fetch everything
  // Fetch the models you care about (repeat for users, courses, progressions, ...)
  await fetchCourseProgressions(integration.kombo_integration_id)

  await prisma.integration.update({
    where: {
      id: integration.id,
    },
    data: {
      last_fetched_from_kombo_at: fetchStartDate,
    },
  })
}

async function fetchCourseProgressions(
  integrationId: string,
  updatedAfter?: string,
) {
  let cursor
  do {
    const resp = await axios.get(
      'https://api.kombo.dev/v1/lms/course-progressions',
      {
        headers: {
          Authorization: `Bearer ${KOMBO_API_KEY}`,
          'X-Integration-Id': integrationId, // Use the stored integration ID
        },
        params: {
          cursor: cursor,
          updated_after: updatedAfter,
        },
      },
    )

    cursor = resp.data.data.next

    // Implement your handling logic here
    // Usually, you will upsert the data into your database and build specific
    // domain logic here.
    await handleProgressionData(integrationId, resp.data.data.results)
  } while (cursor)
}
```

## Understanding `changed_at` vs `updated_after` Behavior

A common source of confusion is understanding when records are returned by the
`updated_after` filter and how this relates to each record's `changed_at`
timestamp. Here's the key distinction:

### Record-level `changed_at` Field

Each record has a `changed_at` timestamp that **only updates when properties
directly on that record change**. For example:

* If a course's `title` changes, the course's `changed_at` updates
* If a progression's `status` changes, the progression's `changed_at` updates
* **However**: If a course's title changes, related progressions' `changed_at`
  fields do **NOT** update

### Endpoint Filtering with `updated_after`

The `updated_after` parameter works differently - it returns records when
**either the record itself OR its nested data has been updated**:

#### Example: Course Progressions Endpoint

When you call `GET /course-progressions` with `updated_after`, you'll receive
progressions if:

1. **Direct progression changes**: The progression itself was modified (status,
   enrolled\_at, etc.)
2. **Nested course revision changes**: The course revision data was updated (title,
   description, etc.)
3. **Nested user changes**: The user data was updated (name, email, etc.)

This means a progression can be returned even if its own `changed_at` timestamp
hasn't changed.

#### Concrete Scenario

Let's say you call `GET /course-progressions` at 9:00 AM and get:

```json theme={null}
{
  "id": "prog123",
  "status": "IN_PROGRESS",
  "changed_at": "2023-10-01T08:00:00Z",
  "course_revision": {
    "id": "revision456",
    "title": "Introduction to Sales",
    "changed_at": "2023-10-01T08:00:00Z"
  }
}
```

At 10:00 AM, the course revision's title is changed to "Advanced Sales Techniques"
in the LMS. If you then call
`GET /course-progressions?updated_after=2023-10-01T09:00:00Z`, you'll receive:

```json theme={null}
{
  "id": "prog123",
  "status": "IN_PROGRESS",
  "changed_at": "2023-10-01T08:00:00Z", // <- Same timestamp!
  "course_revision": {
    "id": "revision456",
    "title": "Advanced Sales Techniques", // <- Updated data
    "changed_at": "2023-10-01T10:00:00Z" // <- New timestamp
  }
}
```

**Key Point**: The progression's `changed_at` remains unchanged, but the
progression is still returned because it contains updated nested course data.

### Best Practice

When using `updated_after` filtering:

1. **Don't assume** a record was directly modified just because it's returned
2. **Compare nested data** to determine what actually changed
3. **Use the nested objects' `changed_at` fields** to identify which parts were
   updated
4. **Design your sync logic** to handle both direct and indirect changes

## FAQ

### Why do you not provide the changed data inside of data-changed?

We want to make integrating with Kombo as simple as possible for you. Since we
recommend running occasional full fetches anyways, it means you can re-use most
of your logic for both fetch types. Furthermore, this allows you to iterate and
upsert data at your own pace. Unlike if we were to send you a *really* large
payload after an initial sync. By listening to just this single unified webhook,
you are always guaranteed to benefit from our latest innovations to help you get
the freshest data.

### How often do you send the data-changed event? Do you debounce the webhook?

Yes, by default we debounce data-changed with a 30-second window. That means no
matter how many events we're receiving, you'll receive at most one webhook every
30 seconds.

This works as follows: The first time this event fires, we will pass it through
to you right away. Then we will wait 30 seconds. All the events we receive in
those 30 seconds will then be sent to you as a single update with the next
webhook.

For more details, please refer to the
[webhooks](/lms/guides/webhooks#data-changed) page.


# Querying the API
Source: https://docs.kombo.dev/lms/getting-started/querying-api

Learn how to filter and paginate the Kombo `GET` endpoints. This will help you implement incremental fetching and more.

## SDKs

You can use our officially supported SDKs to interact with our API. For more information, see the [Libraries and SDKs](/libraries-and-sdks) section.

## General Response Format

All *GET* endpoints of Kombo follow the same principle. All of them return a list
of results and a next cursor. All results follow the same basic structure with the
following properties:

* `id`: An ID generated by Kombo, also referred to throughout the documentation as "Kombo ID".
* `remote_id`: The ID of the object in the remote system. This can be null for some objects.
* `changed_at`: Part of Kombo's change tracking — this is the timestamp of the last change that was detected by Kombo.
* `remote_deleted_at`: Part of Kombo's change tracking — this is the timestamp where the object was not found anymore in the remote system.

*Other properties are model-specific.*

### A note on Kombo IDs and their uniqueness

We generate the Kombo ID by referencing the remote ID and the integration ID.

This results in the following statements being true:

* A Kombo ID is unique across all integrations for *the same model*.
  * This is because we reference the integration ID itself when generating the Kombo ID.
* A Kombo ID is *not* unique across different models for the same integration.
  * This will occur for remote systems that follow a sequential ID pattern. For example, both the first employee and department have the ID `1`. As the integration ID is the same, so will the Kombo ID.

## Pagination

Each request returns either a value on the `next` field or `null`. The
value will be a cursor which you can use to get the next page of results. Use
the `cursor` query parameter to request the next page. (Please note that you
still need to add the relevant filters while paginating.)

In addition, you can use the `page_size` parameter to specify the number of results per page.

```bash theme={null}
curl --request GET \
  --url 'https://api.kombo.dev/v1/hris/employees?cursor=eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0&page_size=100' \
  --header 'Authorization: Bearer <YOUR_API_KEY>'
```

## Filtering

All models provide the same filters in addition to some model-specific filters.
The following filters apply to all models:

* `updated_after`: Only return objects where the `changed_at` value is after
  the given timestamp. This can be used to fetch data incrementally.
  This filter also includes all expanded relations — so if only they have
  changed (but none of the primary attributes of the object), this will still
  count as the object having changed and it will still be returned.
* `include_deleted`: By default, all values with a `remote_deleted_at` value are
  not returned. If you want to include them, set this to `true`. This is helpful
  if you want to remove them from your database.
* `ids`: List of comma-separated ids. Only return objects with these IDs.
* `remote_ids`: List of comma-separated remote ids. Only return objects with
  these remote IDs.

## Error Codes

When the Kombo API encounters an error, it returns a structured error response with a specific `code` for programmatic handling.
For a complete list of error codes and detailed explanations see the [Error Handling guide](/guides/errors).

```json theme={null}
{
  "status": "error",
  "error": {
    "code": "REMOTE.INPUT_INVALID",
    "title": "The remote system returned validation errors.",
    "message": "Candidate field 'email' must be a valid email address for Greenhouse"
  }
}
```

## Rate limiting

The rate limiter restricts the number of API requests you can send to Kombo. Currently, we permit 300 requests over 60 seconds **per environment** (i.e., PROD or DEV environment). After the time window has passed, the limit is reset. If you need a higher quota, reach out to the Kombo team.

Independent of this cap, [concurrency limiting](../guides/concurrency-limiting) limits how many unified actions can run at the same time per integration.

This information is exposed as headers on the response of every authenticated API request:

| Header              | Sample Value | Description                                           |
| ------------------- | ------------ | ----------------------------------------------------- |
| ratelimit-limit     | 300          | The maximum number of requests permitted              |
| ratelimit-remaining | 298          | The remaining number of requests permitted            |
| ratelimit-reset     | 57           | The remaining seconds until the rate limiter is reset |

When exceeded, you will receive a failed response with the [error `code`](/guides/errors) of `PLATFORM.RATE_LIMIT_EXCEEDED`:

```json theme={null}
{
  "status": "error",
  "error": {
    "code": "PLATFORM.RATE_LIMIT_EXCEEDED",
    "title": "Rate limit exceeded.",
    "message": "Maximum requests are 300 every 60 seconds. Try again in 57 seconds.",
    "log_url": null
  }
}
```

### Concurrency limiting

In addition to rate limiting, Kombo applies [concurrency limiting](../guides/concurrency-limiting) to unified actions. While rate limiting caps total requests over a time window, concurrency limiting caps simultaneous in-flight unified actions per integration to prevent backpressure buildup on downstream tools. Endpoints for reading synced model data are not affected by concurrency limiting.

### Handling 429 responses

Both rate limiting and concurrency limiting return HTTP `429`, but they have different error codes and require different responses:

* **`PLATFORM.RATE_LIMIT_EXCEEDED`** -- You've sent too many requests in the current time window. This applies to all endpoints. Wait for `ratelimit-reset` seconds or retry with exponential backoff.
* **`PLATFORM.CONCURRENCY_LIMIT_EXCEEDED`** -- Too many unified actions are in flight for this integration. The underlying tool can't keep up. Retry the failed request after a short backoff (e.g., 1s, 2s, 4s). You likely still have rate limit quota remaining, so waiting for `ratelimit-reset` is unnecessary. See the [concurrency limiting guide](../guides/concurrency-limiting) for details.


# Remote Data
Source: https://docs.kombo.dev/lms/getting-started/remote-data

Learn how to use remote data to access any available field.

Remote data is a feature exposing the raw, unchanged data
that we receive from the APIs, allowing you to read data that might
not be available in our unified API model.

It is disabled by default because it has compliance implications
(we need to store all data we receive, not just the data points selected in the
scope configs) and because you will need to write parsing logic for each
integration/tool.

It is mainly used to read data that might not be available in our unified Data Models.
Some customers are for example interested in some specific government-issued
company IDs, which are currently not part of our Data Model, but can be extracted
from these raw responses. An example response might be:

```json theme={null}
{
  "status": "success",
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "first_name": "John",
        "last_name": "Doe",
        ...
        "remote_data": {
          "EmployeeData": {
            "Names": {
              "FirstName": "John",
              "LastName": "Doe"
            },
            "Company": {
              "GovernmentID": "123456789"
            }
          }
        }
      }
    ]
  }
}
```

<Info>
  `remote_data` gives you the raw API response from the connected system. If you
  need **structured** extra fields for reading, see [Custom
  Fields](../features/custom-fields). If you need to **write** additional data
  when creating records, see [Remote
  Fields](/extending-the-model#remote-fields).
</Info>

## When to use remote data

Remote data should be used when our unified Data Model does not offer specific
fields that you are interested in. Note that we do not unify remote data, so the
data structure might differ between tools and might even differ between
individual integrations of the same tool.

## When not to use remote data

Remote data might potentially expose sensitive data, even if your customers
opt out of it. We might, for example, always receive personally identifiable
information (e.g. emails, names and addresses). If your customers opt out of
these data fields, we will discard this data and never store it.
If remote data is active, however, we will expose the raw responses and therefore
information that should optimally not be stored.

We also offer [custom fields](../features/custom-fields), which are a more versatile and compliant variant
of remote data.

## How to use remote data

Remote data can be enabled on a per-model basis in the scope config. To enable
it, please contact us.


# Sandbox Integrations
Source: https://docs.kombo.dev/lms/getting-started/sandbox-integrations

Learn how to access tools you can connect to Kombo for development purposes.

If you wish to get started as quickly as possible, use our built-in **Sandbox Integration (HRIS/ATS/LMS)**.
You can find it in the **"Integrations"** section in the Kombo dashboard. The sandbox integration
is only available in your [development environment](../guides/environments#development).

<Card title="Sandbox Integration" icon="flask" href="../connectors/sandbox">
  Connect the built-in sandbox to start exploring the API right away — no
  credentials required.
</Card>

### What the sandbox covers

The sandbox requires **no credentials** and can be set up in minutes. It
provides a representative dataset that covers common edge cases you'll encounter
in production — including active, terminated, and pending employees, multiple
currencies, and various bank account formats.

**Read data** — the sandbox includes data for all major models:

* **HRIS**: Employees, employments, groups, locations, legal entities, absences,
  absence types, time-off balances, timesheets, performance reviews, skills,
  and employee skill proficiency ratings
* **ATS**: Candidates, applications, jobs, job posts, stages, offers,
  interviews, rejection reasons, users
* **LMS**: Users, courses, skills, providers, progress records

**Write actions** — all major write operations work against the sandbox:

* **HRIS**: Create employees, create/delete absences, upsert employee skill
  proficiency ratings
* **ATS**: Create candidates (with applications), move applications to stages,
  add attachments, add/remove tags, add notes
* **LMS**: Enroll users, mark completions, create and manage courses

The sandbox dataset is **deterministic** — syncs always return the same base
data, making it well-suited for automated testing with stable assertions.
Records created through write actions persist in Kombo's database and appear in
subsequent API calls, but don't modify the base dataset.

### Third-party sandboxes

Some tools also offer free demo accounts that you can use to test out Kombo.

We recommend the following tools, as they provide great coverage and are broadly used:

* When testing HRIS integrations, we recommend using [Personio](https://www.personio.com/free-trial/).
* When testing ATS integrations, we recommend using [Recruitee](https://auth.recruitee.com/sign-up). If you want to gain access to a sandbox instead of using the free trial, please fill out [this form](https://www.tellent.com/technology-partner-application). In the section “Please describe the use case for this integration on a high-level”, mention “Referred by Kombo”.

Additionally, here are some more tools that offer free trials or test accounts: [BambooHR (HRIS)](https://www.bamboohr.com/signup/), [Sage HR (HRIS/ATS)](https://sage.hr/register), [Deel (HRIS)](https://app.deel.com/signup), [CharlieHR (HRIS)](https://www.charliehr.com/join), [Planday (HRIS)](https://www.planday.com/signup/), [Factorial (HRIS)](https://factorialhr.com/get-started), [Humaans (HRIS)](https://app.humaans.io/signup), [BreezyHR (ATS)](https://breezy.hr/signup), [Jazzhr (ATS)](https://info.jazzhr.com/free-trial.html), [Join (ATS)](https://join.com/auth/signup/recruiter), [Teamtailor (ATS)](https://tt.teamtailor.com/users/new?locale=en), [Workable (ATS)](https://www.workable.com/free-trial)

### Enterprise tools

Enterprise tools like Workday, SAP SuccessFactors, or SmartRecruiters usually
don't offer free sandbox access. However, for customers on the enterprise plan,
we offer joint testing sessions with these enterprise tools.


# Async Endpoints
Source: https://docs.kombo.dev/lms/guides/async-endpoints

How to work with asynchronous endpoints that process requests in the background and return results via polling.

Some Kombo endpoints process requests **asynchronously**. Instead of
returning the final result in the HTTP response, they return a `task_id`
that you use to poll for the result. This is used for operations that may
take longer to complete – such as bulk writes to a connected system.

The following endpoints in this category use the async pattern:

* [Upsert courses](/lms/v1/post-courses-bulk)
  * [Get status of "Upsert courses" task](/lms/v1/get-courses-bulk-task-id)

## How it works

Working with an async endpoint is a three-step process:

1. **Submit** – Send a `POST` request with your payload. You receive a
   `task_id` immediately.
2. **Poll** – Call the corresponding `GET` endpoint with the `task_id` at
   regular intervals.
3. **Collect the result** – Once the status is `COMPLETED` or `FAILED`, the
   response contains the final result or error details.

```mermaid theme={null}
sequenceDiagram
    participant You
    participant Kombo
    participant Tool as Connected Tool

    You->>Kombo: POST /endpoint (payload)
    Kombo-->>You: 200 { task_id }

    loop Poll until terminal status
        You->>Kombo: GET /endpoint/{task_id}
        Kombo-->>You: { status: "PENDING" }
    end

    Note over Kombo,Tool: Processing in background

    You->>Kombo: GET /endpoint/{task_id}
    Kombo-->>You: { status: "COMPLETED", data: [...] }
```

## Task statuses

Every task is in exactly one of three statuses:

| Status      | Meaning                                                                         | Terminal? |
| ----------- | ------------------------------------------------------------------------------- | --------- |
| `PENDING`   | The task is still being processed. Keep polling.                                | No        |
| `COMPLETED` | The task finished processing all items. The `data` field contains the results.  | Yes       |
| `FAILED`    | The task could not be processed at all. The `error` field contains the details. | Yes       |

<Note>
  `COMPLETED` means Kombo finished processing the task – it does **not**
  mean every item in the request succeeded. Individual items may have
  failed (e.g., one course could not be created in the connected tool).
  These per-item outcomes are reported in the `data` array, where each
  entry has its own `status` of `SUCCEEDED` or `FAILED`.

  In contrast, a task-level `FAILED` status means the task could not run
  at all – for example, because the credentials for the connected tool
  are no longer valid. In that case, no items were processed.

  In some cases, the connected tool supports batch processing, which
  Kombo uses internally. When that happens, multiple items may share the
  same outcome because they were processed as a single batch. Such
  scenarios are usually explained in the endpoint-specific docs or listed
  as action constraints in the
  [coverage grid](/the-dashboard#tool-coverage).
</Note>

## Submitting a request

Send a `POST` request just like any other action endpoint. The response
contains a `task_id` that identifies the background task.

The following example uses the [LMS bulk upsert courses
endpoint](/lms/v1/post-courses-bulk) for illustration, but the pattern is
the same for all async endpoints:

```bash theme={null}
curl --request POST \
  --url 'https://api.kombo.dev/v1/lms/courses/bulk' \
  --header 'Authorization: Bearer <api_key>' \
  --header 'X-Integration-Id: <integration_id>' \
  --header 'Content-Type: application/json' \
  --data '{
    "items": [
      {
        "origin_id": "cybersecurity-101",
        "course": {
          "type": "EXTERNAL",
          "title": "Introduction to Cybersecurity",
          "description": "Learn the fundamentals of cybersecurity.",
          "course_url": "https://your-platform.com/courses/cybersecurity-101"
        }
      },
      {
        "origin_id": "data-privacy-basics",
        "course": {
          "type": "EXTERNAL",
          "title": "Data Privacy Basics",
          "description": "Understand GDPR and data privacy best practices.",
          "course_url": "https://your-platform.com/courses/data-privacy-basics"
        }
      },
      {
        "origin_id": "leadership-fundamentals",
        "course": {
          "type": "EXTERNAL",
          "title": "Leadership Fundamentals",
          "description": "Core skills for new and aspiring managers.",
          "course_url": "https://your-platform.com/courses/leadership-fundamentals"
        }
      }
    ]
  }'
```

Response:

```json theme={null}
{
  "status": "success",
  "data": {
    "task_id": "7FPJba3qRNBYaJgTvDKZi7mi"
  }
}
```

## Polling for the result

Use the `task_id` from the previous step to poll the status endpoint.

```bash theme={null}
curl --request GET \
  --url 'https://api.kombo.dev/v1/lms/courses/bulk/7FPJba3qRNBYaJgTvDKZi7mi' \
  --header 'Authorization: Bearer <api_key>' \
  --header 'X-Integration-Id: <integration_id>'
```

### While the task is pending

```json theme={null}
{
  "status": "success",
  "data": {
    "task_id": "7FPJba3qRNBYaJgTvDKZi7mi",
    "status": "PENDING",
    "created_at": "2025-03-12T14:30:00.000Z",
    "completed_at": null
  }
}
```

### When the task completes

The `data` field contains the results. The exact shape depends on the
endpoint – check the API reference for details.

```json theme={null}
{
  "status": "success",
  "data": {
    "task_id": "7FPJba3qRNBYaJgTvDKZi7mi",
    "status": "COMPLETED",
    "created_at": "2025-03-12T14:30:00.000Z",
    "completed_at": "2025-03-12T14:30:47.000Z",
    "data": [
      {
        "origin_id": "cybersecurity-101",
        "status": "SUCCEEDED",
        "data": {
          "course_id": "26vafvWSRmbhNcxJYqjCzuJg"
        }
      },
      {
        "origin_id": "data-privacy-basics",
        "status": "SUCCEEDED",
        "data": {
          "course_id": "8kQes79O9lH0FaLxktO0yza"
        }
      },
      {
        "origin_id": "leadership-fundamentals",
        "status": "FAILED",
        "error": {
          "code": "INTEGRATION.UNKNOWN_ERROR",
          "message": "The connected tool returned an unexpected error."
        }
      }
    ]
  }
}
```

### When the task fails

If the task fails before it can process all items, the response includes an
`error` object. See the [error handling guide](/guides/errors) for details on how to
interpret it.

```json theme={null}
{
  "status": "success",
  "data": {
    "task_id": "7FPJba3qRNBYaJgTvDKZi7mi",
    "status": "FAILED",
    "created_at": "2025-03-12T14:30:00.000Z",
    "completed_at": "2025-03-12T14:30:12.000Z",
    "error": {
      "code": "INTEGRATION.AUTHENTICATION_FAILED",
      "message": "The integration credentials are no longer valid."
    }
  }
}
```

## Idempotency

Async endpoints are **idempotent by default**. Sending the same request
body for the same integration returns the existing task instead of creating
a duplicate. This makes it safe to retry requests without risking duplicate
processing – for example, if your initial request times out or you're
unsure whether it went through.

Idempotency is derived automatically from the request body and
integration details. Manual idempotency keys (e.g., via a header) are not
currently supported. If this is something you need, please [let us
know](/support).

## Recommended polling strategy

Async endpoints are designed for long-running operations that complete
"eventually" rather than within seconds. The right polling interval depends
on the action and the volume of data you're processing – individual
endpoints may include more specific guidance in the API reference.

As a general rule:

* **Polling every few minutes** is a good starting point for most use
  cases.
* For very large payloads or operations that you expect to take longer,
  **polling every 30–60 minutes** may be more appropriate.
* Stop polling once you receive a terminal status (`COMPLETED` or
  `FAILED`).
* If a task stays `PENDING` longer than expected, don't poll
  indefinitely. Set a reasonable timeout on your side and treat exceeding
  it as an error. The right threshold depends on the action – check the
  API reference for endpoint-specific guidance or reach out to our
  [support](/support).


# Concurrency Limiting
Source: https://docs.kombo.dev/lms/guides/concurrency-limiting

Concurrency limiting caps simultaneous in-flight unified actions per integration, giving you fast feedback instead of slow timeouts.

## What is concurrency limiting?

When you invoke unified actions in Kombo (e.g., creating a candidate, moving
an application, reading attachments), each call is forwarded to the underlying HR or ATS tool.
These tools have their own rate limits, which are often significantly lower than
what Kombo allows.

If many unified actions run in parallel, they all compete for limited
downstream throughput. Completion times grow, your HTTP clients may hit
timeouts while work is still in flight, and retries can overlap with operations
that are still running.

Concurrency limiting solves this by capping how many unified actions
can be processed simultaneously per integration. When the cap is
reached, additional requests are immediately rejected with a `429` status code.
This gives you a fast, clear signal to retry with backoff instead of stacking
unbounded in-flight work that might eventually time out on your side.

<Note>
  Concurrency limiting only applies to unified actions (calls that run work
  against the underlying tool). Model endpoints for reading synced data are not
  affected.
</Note>

<Frame>
  <img alt="Two-panel diagram comparing overload (client timeout before completion, ambiguous retries) with concurrency limiting (429 and controlled in-flight work)." />
</Frame>

## How it differs from rate limiting

For Kombo-wide request volume over time, see [Rate limiting](../getting-started/querying-api#rate-limiting).

|                    | Rate Limiting                  | Concurrency Limiting                  |
| ------------------ | ------------------------------ | ------------------------------------- |
| **What it caps**   | Total requests per time window | Simultaneous in-flight requests       |
| **Scope**          | All API requests               | Unified actions only                  |
| **When it resets** | After the time window elapses  | As in-flight requests complete        |
| **Error code**     | `PLATFORM.RATE_LIMIT_EXCEEDED` | `PLATFORM.CONCURRENCY_LIMIT_EXCEEDED` |

Both return HTTP `429`, but with different error codes and headers.

## Response headers

When concurrency limiting is active, every unified action response includes two headers:

| Header                  | Example | Description                                                                             |
| ----------------------- | ------- | --------------------------------------------------------------------------------------- |
| `Concurrency-Limit`     | `30`    | The maximum number of concurrent in-flight unified actions allowed for this integration |
| `Concurrency-Remaining` | `12`    | How many additional concurrent unified actions can be accepted right now                |

The limit may vary per integration. Sensitive integrations (e.g.,
reverse-engineered APIs) may have significantly lower limits. Use the response
headers to discover the actual limit rather than assuming a specific number. The
default limit is 30.

These headers appear on both successful responses and `429` rejections, so you can monitor utilization proactively.

## Handling concurrency limit errors

When you exceed the concurrency limit, you receive a `429` response with the error code `PLATFORM.CONCURRENCY_LIMIT_EXCEEDED`. The response includes both concurrency and rate limit headers:

```
HTTP/1.1 429
concurrency-limit: 30
concurrency-remaining: 0
ratelimit-limit: 1000
ratelimit-remaining: 834
ratelimit-reset: 44
```

```json theme={null}
{
  "status": "error",
  "error": {
    "code": "PLATFORM.CONCURRENCY_LIMIT_EXCEEDED",
    "title": "Concurrency limit exceeded.",
    "message": "Maximum concurrent action requests per integration is 30. Currently 30 in flight."
  }
}
```

Notice how the rate limit headers show remaining quota (`ratelimit-remaining: 834`) while the concurrency headers show no remaining slots (`concurrency-remaining: 0`). This tells you:

* The underlying tool is at capacity for this integration, not Kombo itself.
* You still have rate limit quota, so waiting for `ratelimit-reset` is unnecessary.
* Slots free up quickly as in-flight requests complete, so a short retry is effective.

### How to retry

For `PLATFORM.CONCURRENCY_LIMIT_EXCEEDED`, retrying the same request is
expected and does not run the unified action twice. Kombo rejects the call
before the unified action runs (no concurrency slot was acquired). That differs
from failures where the outcome is unclear, e.g., a timeout after a write may
still have succeeded, so retries need extra care.

1. Retry the failed request with exponential backoff: start with a short delay (e.g., 1s) and increase on repeated `429`s (2s, 4s, 8s, ...).
2. Optionally, throttle proactively: check `Concurrency-Remaining` on successful responses to slow down before hitting the limit.

## What this means for your integration

Concurrency limiting does not cap steady-state throughput below what the
downstream tool can sustain. The integrated system still bounds how fast work
completes. The limit turns that constraint into immediate `429` responses
instead of long waits and unbounded in-flight unified actions.


# Embedded flow
Source: https://docs.kombo.dev/lms/guides/connect/embedded-flow

Embed Kombo Connect into your app for the most seamless experience.

If you've gone through the general [Kombo Connect](./introduction) documentation,
you'll know there are
[different ways of using the flow](./introduction#getting-started). Our embedded flow
provides the most seamless experience to your customers but also involves some
engineering on your side. In this guide, we'll go over what that means exactly.

## Implementing the flow

The embedded flow requires you to:

* Add an **endpoint** to your back-end for initiating the flow
* Add a **button** to your frontend to show the flow to your user using the SDK
* React to a flow being completed through the "activation token" returned by the SDK or by listening to a webhook

Let's go over each of these steps in detail.

### Adding the endpoints

Both endpoints are mostly just wrappers around endpoints of the Kombo API and
mainly exist for security reasons (so that malicious actors can't set up
arbitrary integrations in your Kombo environment).

#### Initiating the flow

The first one initializes the flow by calling the Kombo API and returns a link
that we then use in the frontend:

```js Node.js (Express + Axios) theme={null}
app.post('/integrations/kombo/init', async (req, res) => {
  // TODO: Get user details from your database
  const user = await getUser()

  const response = await axios.post(
    'https://api.kombo.dev/v1/connect/create-link',
    {
      end_user_email: user.email,
      end_user_organization_name: user.company.name,
      end_user_origin_id: user.company.id,

      integration_category: 'HRIS',
    },
    {
      headers: {
        authorization: `Bearer ${KOMBO_API_KEY}`,
      },
    },
  )

  res.send({ link: response.data.data.link })
})
```

The `end_user_*` fields identify which of your customers an integration belongs to:

* **`end_user_email`** (required): Contact email for this end user. Used as a label in the dashboard and included in webhooks.
* **`end_user_organization_name`** (required): Company name. Used as a label in the dashboard and included in webhooks.
* **`end_user_origin_id`** (optional): Your internal ID for this customer. Echoed back in webhooks and API responses so you can map integrations to your own records.

These fields are metadata — they do not affect integration identity. Changing the email or organization name in a subsequent `create-link` call with the same `end_user_origin_id` does **not** update an existing integration; it creates a new flow link.

<Warning>
  Kombo does **not** deduplicate integrations based on these fields. Each
  completed flow creates a new integration. You are responsible for preventing
  customers from connecting the same tool twice. Use the [reconnection
  link](../../v1/post-integrations-integration-id-relink) if a customer needs to
  update their credentials for an existing integration.
</Warning>

#### Reacting to the flow being completed

After your user completes the flow, you can retrieve the integration details and store them in your database for future use. There are two ways to achieve this:

1. By using the ["Get integration by token" endpoint](../../v1/get-connect-integration-by-token-token)
2. By listening to the `integration-created` webhook

**Option 1: Using the endpoint**

The activation token is returned from the frontend after the user completes the integration flow. You can use this token to retrieve the integration details via the ["Get integration by token" endpoint](../../v1/get-connect-integration-by-token-token) and store them in your database.

Here's how you might implement the activation endpoint:

```js Node.js (Express + Axios) theme={null}
app.post('/integrations/kombo/activate', async (req, res) => {
  const response = await axios.get(
    `https://api.kombo.dev/v1/connect/integration-by-token/${req.body.token}`,
    {
      headers: {
        authorization: `Bearer ${KOMBO_API_KEY}`,
      },
    },
  )

  const integrationId = response.data.data.id

  // TODO: Store the integration ID in your database

  res.sendStatus(200)
})
```

**Option 2: Listening to the `integration-created` Webhook**

Alternatively, you can set up a webhook endpoint on your backend to listen for the `integration-created` event that Kombo sends when a new integration is created. This webhook contains the integration ID and other relevant details, allowing you to associate the integration with your user in your database.

Here's how you might set up the webhook endpoint:

```js Node.js (Express) theme={null}
app.post('/webhooks/kombo/integration-created', async (req, res) => {
  const integration = req.body.data

  // TODO: Verify the webhook signature for security purposes

  // TODO: Store the integration ID in your database

  res.sendStatus(200)
})
```

* Make sure to [verify the webhook signature](../../guides/webhooks#validate-the-data) to ensure that the request comes from Kombo.
* Make sure to set up the webhook in the [dashboard](https://app.kombo.dev/configuration/webhooks).

### Adding the button

For now, we're all set on the back-end side, so let's switch to the front-end:

Here we'll have to add a button that lets your users start the flow. Most of our
customers already have an "Integrations" page within their product's settings.
If you do, too, then that's the perfect place to add the button.

How exactly you're going to do this will depend on your tech stack, but it's
probably going to look something like this:

<CodeGroup>
  ```jsx React theme={null}
  <button onClick={() => connectHris()}>Connect HRIS</button>
  ```

  ```jsx Vue.js theme={null}
  <button @click="connectHris()">
    Connect HRIS
  </button>
  ```

  ```html HTML theme={null}
  <button onclick="connectHris()">Connect HRIS</button>
  ```
</CodeGroup>

<br />

<Note>
  Right now, we require you to specify the integration category when
  initializing the flow, so you'll likely want to label your button accordingly
  (e.g., "Connect HRIS" or "Connect ATS").
</Note>

When a user clicks on the button, two things need to happen:

* An integration link has to be retrieved through your endpoint
* The embedded flow has to be started

#### Getting a link

Here's what the first part might look like:

```js JavaScript theme={null}
async function getKomboConnectLink() {
  // Note: The URL below points to *your* API and could be different
  const response = await fetch('/integrations/kombo/init')
  const data = await response.json()

  return data.link
}
```

#### Opening the flow

Now it's time to actually show the flow to the user. This can be through
[the @kombo-api/connect JavaScript library](https://www.npmjs.com/package/@kombo-api/connect).
It's tiny (about 50 lines of JavaScript as of now) and basically just
initializes an `<iframe>` to display the flow.

<Note>
  **Important:** Since the Kombo Connect flow is displayed in an iframe, you'll need to ensure your Content-Security-Policy allows it. Add `frame-src https://connect.kombo.dev` to your CSP header:

  ```
  Content-Security-Policy: frame-src https://connect.kombo.dev;
  ```
</Note>

Let's, first of all, add it as a dependency to our front-end:

<CodeGroup>
  ```bash npm theme={null}
  npm install @kombo-api/connect
  ```

  ```bash yarn theme={null}
  yarn add @kombo-api/connect
  ```

  ```bash pnpm theme={null}
  pnpm add @kombo-api/connect
  ```
</CodeGroup>

Then, import it like so:

```js JavaScript theme={null}
import { showKomboConnect } from '@kombo-api/connect'
```

##### Can't use npm packages or imports?

You can also load the library from the unpkg CDN:

```html HTML theme={null}
<script src="https://unpkg.com/@kombo-api/connect@1/dist/index.js"></script>
```

This makes the library available globally as `KomboConnect`.

#### Reacting to the flow being completed

After the user completes the flow, you'll receive an activation token. This token can be used to retrieve the integration details from Kombo. Depending on the method you choose (activation endpoint or webhook), you'll handle this token differently.

If you're using the activation endpoint, send the token to your backend:

```js JavaScript theme={null}
async function activateKomboIntegration(token) {
  // Note: The URL below points to *your* API and could be different
  const response = await fetch('/integrations/kombo/activate', {
    method: 'POST',
    body: JSON.stringify({ token }),
  })
}
```

If you're using the webhook method, you don't need to handle the activation token on the frontend. Instead, the webhook will notify your backend when a new integration is created.

### Putting all together

Now it's time to put it all together:

```js JavaScript theme={null}
// You can call this whatever you want (just attach this to your button)
async function connectHris() {
  // We wrote this function earlier (make sure to import/include it)
  const link = await getKomboConnectLink()

  const activationToken = await showKomboConnect(link)

  // Not necessary if you're reacting to the `integration-created` webhook
  await activateKomboIntegration(activationToken)
}
```

<Info>
  **What if the user doesn't finish?** No integration is created until the user
  completes the entire flow. Abandoned or closed flows leave no orphan records
  in Kombo. You can safely generate a new link via `POST /connect/create-link`
  for the user to retry. To avoid duplicate integrations for users who *do*
  complete the flow, track completed `integration_id`s on your side, ideally via
  webhook.
</Info>

And that's it! You've successfully embedded Kombo Connect!


# Introduction
Source: https://docs.kombo.dev/lms/guides/connect/introduction

Our interactive embeddable connection flow.

<img alt="1376" />

We know that the experience of setting up new integrations is just as core to
your application as the integrations themselves, so we've put special care into
making this as easy and user-friendly as possible for your customers.

*The best part:* **Kombo Connect** — that's what we call our interactive
connection flow — can be
[fully embedded within your own application](./embedded-flow).

## How it works

To get a better idea of how Kombo Connect fits into your application, let's take
a look at the typical flow a customer will go through:

1. They **initiate the flow** within your app (e.g., through a "Connect HRIS"
   button)
2. They are **presented with the Kombo Connect UI** where they can:
   * Select the tool they want to connect (e.g., Factorial)
   * Get an overview of the requested data points (see [Scopes](../../features/scopes))
   * Grant access to the requested data points
   * See which credentials are required to set up the tool and how to get them
   * Enter the necessary credentials (e.g., an API key)
3. They **return to your app**, and their integration has been set up

## Getting started

The flow described above applies to the situation where you've
[*embedded* the Kombo Connect flow](./embedded-flow) into your own app. This
provides the most seamless experience but isn't the quickest way to get started.

If you just want to try out Kombo quickly and **onboard selected customers**,
consider these other options that **don't require any changes to your app**:

<CardGroup>
  <Card title="Manual setup" icon="wrench" href="./manual-setup">
    Perfect when you *already have* the relevant credentials from your customer
    and just want to add the integration to Kombo
  </Card>

  <Card title="Magic links" icon="wand-magic-sparkles" href="./magic-links">
    Similar in that they also don't require any code, but they still allow your
    customers to go through the flow and enter the credentials themselves.
  </Card>
</CardGroup>


# Magic links
Source: https://docs.kombo.dev/lms/guides/connect/magic-links

Let your customers set up integrations without changing your app.

When you're just getting started with Kombo, you might not want to invest in the
time into building a proper integration with [Kombo Connect](./introduction) yet.
Because of that, we allow you to send what we call "Magic links" to your
customers that allow them to go through the connection flow without you having
to change anything about your application.

## Setting up an integration

To get started, open up [the dashboard](https://app.kombo.dev) and click on "New
integration":

<Frame>
  <img alt="1448" />
</Frame>

Then, select "Let your customer create the integration":

<Frame>
  <img alt="764" />
</Frame>

In the next step, select the integration category (e.g., HRIS) and which
customer it's for:

<Frame>
  <img alt="1762" />
</Frame>

After clicking "Continue," you'll get a link that you can share with your
customer:

<Frame>
  <img alt="786" />
</Frame>

Clicking on this link will take your customer to a special version of the Kombo
Connect flow hosted by us:

<Frame>
  <img alt="1376" />
</Frame>

After they've gone through the flow, the integration will be set up and we will
send you a [webhook](../webhooks). You can then start using our unified API. To
learn more about that, check out
[our general Getting Started guide](../../getting-started).


# Manual setup
Source: https://docs.kombo.dev/lms/guides/connect/manual-setup

Manually set up integrations on behalf of your customers.

When you're just getting started with Kombo, you might not want to invest the
time into building a proper integration with [Kombo Connect](./introduction) yet.
Because of that, we allow you to *manually* set up integrations through the
Kombo Dashboard.

## Setting up an integration

To get started, open up [the dashboard](https://app.kombo.dev) and click on "New
integration":

<Frame>
  <img alt="1448" />
</Frame>

Then, select "Create the integration yourself":

<Frame>
  <img alt="758" />
</Frame>

In the next step, select the integration category (e.g., HRIS) and which
customer it's for:

<Frame>
  <img alt="1762" />
</Frame>

After clicking "Continue," you'll then be presented with the regular
[Kombo Connect](./introduction) flow, except that in this case, it's *you* going
through it and not your customer:

<Frame>
  <img alt="1376" />
</Frame>

After going through the flow, the integration will be set up, and you can start
using our unified API. To learn more about that, check out
[our general Getting Started guide](../../getting-started).


# Reconnecting an integration
Source: https://docs.kombo.dev/lms/guides/connect/reconnection

This document explains why and how to reconnect an integration.

## When to reconnect an integration

### Authentication issues

Sometimes customers change integration authentication details, API keys expire,
or other integration setup details are changed and Kombo can no longer
authenticate with an integration that was previously connected.

After three consecutive days of failing authentication (which we check before every
sync), Kombo will pause scheduling syncs and will prompt you to reconnect the
integration.

#### How to Identify Authentication Issues

Authentication issues can be identified in two ways: programmatically (recommended) or operationally via the Kombo dashboard.

1. **Programmatically:**
   Use the [Integration State Changed webhook](../../guides/webhooks#integration-state-changed). This webhook allows you to monitor changes in the `state` value, helping you quickly detect authentication-related issues.

2. **Operationally:**
   Open the [integrations list](https://app.kombo.dev/integrations). An [issue](../../features/issues) appears on the integration as soon as authentication starts failing, and the integration state updates as well.

By leveraging these approaches, you can promptly diagnose and address authentication challenges.

### Changes in data scope

If you want to update which data you're interacting with in your customer's HR
systems, you will likely need to update your [Kombo scope config](../../features/scopes).
Updating your scope config in Kombo will usually go hand in hand with your
customer having to update their API credentials. Therefore, expanding your scope
config will likely end up with syncs showing warnings that not all permissions
are granted to the API credentials.

Syncs failing due to scope-mismatches can be avoided by using reconnection
links, as described [below](#a-note-on-updating-the-scope-config).

## Methods of reconnecting

### Use the dashboard to create an update link

In the [Kombo dashboard](https://app.kombo.dev), navigate to any integration
that you want to reconnect. Scroll down to the **Relink integration** section to
create an update link.

You can send this link to your customer to update the credentials of the
integration. Once they have reconnected successfully, syncs will run using the
newly entered credentials.

<Frame>
  <img alt="image" />
</Frame>

### Use the API to create a reconnection link

You can also create a reconnection link using the [create reconnection link endpoint](../../v1/post-integrations-integration-id-relink).
Specify the `link_type` for it to be used either in the [embedded flow](../connect/embedded-flow),
or sent out as a [magic link](../connect/magic-links).

## A note on updating the scope config

You are able to define the scope config of a reconnection link both in the UI
and using the API.

<Frame>
  <img alt="image" />
</Frame>

Setting a different scope config than the current integration's scope config
results in the following:

* Your customer will see the updated scope config in the connection flow (i.e.,
  they will have to create credentials with the newly desired permissions)
* On connection flow completion, the scope config of the integration will
  automatically be updated to reflect the new scope config

Use this functionality to smoothly migrate your customers to a new scope config,
without running into any sync issues. While the reconnection link has not been
completed, syncs will continue successfully working using the old scope config;
the new scope config will only be used once the reconnection link has been
completed.


# Troubleshoot connection flow problems
Source: https://docs.kombo.dev/lms/guides/debugging/debug-connection-flow

Investigate and resolve issues that prevent your customers from connecting.

<Frame>
  <img alt="Pending connection detail view" />
</Frame>

When a customer cannot finish the connection flow, work through the steps below to isolate whether the problem originates from the customer’s configuration, Kombo, or the remote tool.

## 1. Identify the failing connection

* Open the [Pending Connections page](https://app.kombo.dev/pending-connections) in the dashboard.
* Locate the affected connection and open its detail view. This page aggregates the context you need, including flow status and quick links.
* If you can't find the connection, you can also try to locate it from the [Logs page](../../features/logs).

## 2. Inspect event and request logs

* Use the **Event Log** tab to understand exactly which step failed and what the customer saw in the UI. These entries often include an error message or hints the customer might have missed.
* Switch to the **Logs** tab to inspect the HTTP calls Kombo made:
  * Review failing requests. HTTP `401`/`403` responses typically mean a missing permission on the customer’s side.
  * `500`-level responses usually indicate a temporary issue in the remote tool—confirm their status page or retry later.
  * Other status codes (e.g. validation errors) can surface configuration issues on Kombo’s side.
  * Also inspect the response bodies, they might contain more information on whats failing.

<Frame>
  <img alt="Event log vs. request log tabs" />
</Frame>

For a deeper dive into logs, see [Logs](../../features/logs) and [Komboman](../../features/komboman) for reproducing calls manually.

## 3. Validate setup with connection guides

* Share the [connection guide](https://help.kombo.dev/hc/en-us/sections/14349683218961-Connection-Guides) for the tool with your customer. The guide lists mandatory permissions, API scopes, and any tool-specific prerequisites.
* Confirm that the customer followed the guide
* If the guide highlights optional scopes your product relies on, ensure the customer understands why they must be enabled.


# Diagnosing missing or incorrect data
Source: https://docs.kombo.dev/lms/guides/debugging/debug-data-issues

A step-by-step guide to troubleshooting data discrepancies between Kombo and the remote tool.

When customers report missing, outdated, or incorrect data, the goal is to determine whether the discrepancy exists inside Kombo or originates from the remote tool.

This guide provides a structured workflow to pinpoint the issue and resolve it.

## 1. Verify the data in Kombo

First, check if the data is actually missing or incorrect in Kombo's own database.

### Check Data Quality View

Use the Data Quality View to see how many data points are synced for each model and field. This helps you to get an overview whether the data is complete.

<img alt="Data Quality View" />

### Check Data Explorer

Use the [Data Explorer](../../features/data-explorer) to inspect specific records. The data explorer shows the ground truth inside of Kombo. You can find all records and their fields values inside of the data explorer.

<img alt="Data Explorer" />

### Validate with Komboman

Use [Komboman](../../features/komboman) to make requests to the Kombo API (e.g., `GET /hris/employees` or `GET /ats/applications`) and check the JSON response directly.

<img alt="Komboman" />

<Note>
  If the data is correct and up-to-date in Kombo but missing or incorrect in
  your system, the issue is likely with how you fetch data from Kombo. Ensure
  you are [syncing data correctly](../../getting-started/fetching-data).
</Note>

## 2. Check the data in the remote tool

If the data is missing or wrong inside the Kombo app, we need to verify what Kombo is receiving from the remote tool.

### Use the Custom Field Explorer

The [Custom Field Explorer](../../features/custom-fields#map-fields-based-on-live-data) shows you all the raw fields Kombo has discovered from the remote tool, including those that aren't mapped to Kombo's unified model.

* If you see the field here, Kombo has access to the data, but it just isn't mapped to a standard field. You can use remappings to update the mapping of the field that is wrong.
* This at times might not show all the fields.

<img alt="Custom Field Explorer" />

### Inspect Request Logs

Go to the [Logs page](../../features/logs) to find the actual HTTP requests Kombo performed during the sync.

* Look for the relevant endpoint (e.g., `/GET employees`).
* Inspect the **Response Body** to see the raw data Kombo received.
* You can even replay the request in [Komboman](../../features/komboman) to see the live response.

<img alt="Request Logs" />

### Use Komboman (Passthrough)

If you can't find the request in the logs, use [Komboman](../../features/komboman) to manually send a request to the remote tool's API (using the "Passthrough" mode).

* This uses the customer's actual credentials, so it shows you exactly what the API returns.
* Compare this raw JSON with what you expected to see.

## 3. Resolutions

Once you've identified where the data is missing, use these steps to resolve the issue.

### Data is not available or incorrect in the remote tool

If you cannot find the correct data in the remote tool's API response (via Komboman or Logs), Kombo cannot sync it.

* **Permission Issue**: The most common cause is that the API user/token connected to Kombo does not have permission to view these fields. Ask the customer to check their permissions and scope settings in the remote tool.
* **Setup Issue**: The specific field wasn't exposed. Read the [connection guide](https://help.kombo.dev/hc/en-us/sections/14349683218961-Connection-Guides) for the tool. Some tools require additional setup, for example, to read custom fields.
* **Wrong Endpoint**: Some tools return data only on specific endpoints. Verify in the tool's documentation if the data is expected to be returned by the endpoint Kombo is calling (which you found in the logs).

### Data is correct in the remote tool, but not in Kombo

If you see the correct data in the raw API response but it doesn't appear (or appears incorrectly) in Kombo's unified API:

* **Check Scope Configuration**: Ensure the model or field is enabled in the integration's scope configuration. If a scope is disabled, Kombo will drop that data.
* **Check Filtering**: Verify if the record is being excluded by [filtering](/hris/features/filtering/introduction) configuration. For example, employees might be filtered out based on their employment status or location (HRIS), or applications might be skipped due to [upstream filtering](/ats/features/upstream-filtering) (ATS).
* **Remap the Data**: If the data is present but not in the field you expect (or is a custom field), you can map it manually:
  * Use [Custom Fields](../../features/custom-fields) to map the raw field to a new property in Kombo.
  * Use [Remapping](../../features/remapping/introduction) to override where a standard field gets its value from.


# How to troubleshoot issues with Kombo
Source: https://docs.kombo.dev/lms/guides/debugging/introduction

Identify and resolve issues across connections, data, and actions using Kombo’s troubleshooting tools.

This guide helps you understand how to **troubleshoot and resolve issues in Kombo**—whether that’s missing data, connection problems, or failing actions.

Kombo provides built-in tooling like [Issues](../../features/issues), [Komboman](../../features/komboman), [Logs](../../features/logs), or the [Data Explorer](../../features/data-explorer) so you can investigate what’s happening behind the scenes and often fix problems yourself.

By the end of this guide you will be able to:

* verify whether an issue lies within Kombo or the connected tool
* choose the right troubleshooting tool for each situation
* collect the right evidence before reaching out to Kombo support

## Kombo support

Our support team is always here to help—but in many cases you can diagnose and even resolve issues yourself using the tools described below. When contacting support, include:

* a short description of what’s wrong
* the affected integration(s) or customers
* any screenshots, logs, or links from your troubleshooting steps

The more detail you share, the quicker we can get you back up and running.

## Common issues

<CardGroup>
  <Card title="Connection issues" icon="link-slash" href="./debug-connection-flow">
    Pending connection fails, customers get stuck in the flow, or you need to
    force a connection.
  </Card>

  <Card title="Data quality issues" icon="magnifying-glass" href="./debug-data-issues">
    Records look missing, outdated, or mapped incorrectly inside Kombo or your
    product.
  </Card>

  <Card title="Action issues" icon="bolt" href="./investigate-failing-actions">
    A write, passthrough, or dashboard-triggered action fails and you need to
    see why.
  </Card>
</CardGroup>

## Key tools for troubleshooting

<CardGroup>
  <Card title="Issues" icon="triangle-exclamation" href="../../features/issues">
    See which integrations currently need attention, and how long the problem
    has been observed.
  </Card>

  <Card title="Komboman" icon="terminal" href="../../features/komboman">
    Send manual Kombo or passthrough API requests to validate data or retry
    failing operations.
  </Card>

  <Card title="Logs" icon="scroll" href="../../features/logs">
    Inspect sync, action, and connection flow logs including detailed
    request/response payloads.
  </Card>

  <Card title="Data Explorer" icon="table" href="../../features/data-explorer">
    Inspect specific records and their field values to see the ground truth
    inside of Kombo.
  </Card>

  <Card title="Custom field explorer" icon="list" href="../../features/custom-fields#map-fields-based-on-live-data">
    Discover available custom fields in the remote tool and map them into Kombo.
  </Card>

  <Card title="Remapping" icon="sliders" href="../../features/remapping/introduction">
    Adjust how Kombo maps data into your models when the default setup is not
    the right fit.
  </Card>

  <Card title="Custom & remote fields" icon="grid" href="../../features/custom-fields">
    Learn how to work with Kombo’s field model, including automatic mapping
    rules and remote references.
  </Card>
</CardGroup>


# Investigate failing actions
Source: https://docs.kombo.dev/lms/guides/debugging/investigate-failing-actions

Diagnose failed write actions using Logs and Komboman.

While most actions succeed automatically, occasional failures are inevitable when syncing data with external systems. Strict validation rules, changing permissions, or complex data dependencies can sometimes cause requests to be rejected.

This guide introduces tools like [Logs](../../features/logs) and [Komboman](../../features/komboman) to help you isolate and understand the error.

## 1. Find the action in the logs

<Frame>
  <video />
</Frame>

To find the relevant log entry, head to the [Logs page](../../features/logs) and use the filters on the top:

* **Type**: Select **Action** to see only write operations (excluding syncs and webhooks).
* **Status**: Select **Failed** to focus on the errors.
* **Integration**: Narrow down results to a specific customer connection.
* **Date**: If you know when the error happened, setting a time range helps filter out noise.

Once you've filtered the list, you should see the failed action.

## 2. Inspect the logs

Click on the log entry to open the detail view. This is your view for understanding what happened.

* **Review the input**: Check the `Incoming Request` tab to see exactly what data you sent to Kombo.
* **Inspect the requests**: An action often involves multiple HTTP calls to the remote tool. Check the timeline for any failed requests.
* **Dig deeper**: Click on a specific request in the timeline to see the raw payload Kombo sent and the error response from the remote system. These often contain more specific details than the top-level error message.

<Frame>
  <img alt="Request log details" />
</Frame>

## 3. Common issues

We have a dedicated [Error Handling guide](/guides/errors) that covers how to handle common API errors programmatically. Below, you'll find visual examples of the most common issues specific to actions:

### Missing permissions or Invalid authentication

If you receive a `403 Forbidden` or `401 Unauthorized` error, the integration
likely lacks the necessary permissions or it's authentication is invalid. Below
are some examples of how these errors might look in the logs:

<AccordionGroup>
  <Accordion title="Missing Permissions Example">
    <Frame>
      <img alt="Missing permissions error" />
    </Frame>
  </Accordion>

  <Accordion title="Invalid Authentication Example">
    <Frame>
      <img alt="Invalid authentication error" />
    </Frame>
  </Accordion>
</AccordionGroup>

**Solution**: Identify the missing permission from the error message. Ask your
customer to check their settings or API key, as they might have revoked access
or changed their role. In some cases, they will need to [reconnect the
integration](../connect/reconnection) to grant the missing scopes.

### Invalid input

If the error is a `400 Bad Request`, `422 Unprocessable Entity`, or a validation
error, the remote tool rejected the data you sent. Below are some examples of
how these errors might look in the logs:

<AccordionGroup>
  <Accordion title="Invalid Input Example 1">
    <Frame>
      <img alt="Invalid input error 1" />
    </Frame>
  </Accordion>

  <Accordion title="Invalid Input Example 2">
    <Frame>
      <img alt="Invalid input error 2" />
    </Frame>
  </Accordion>
</AccordionGroup>

**Solution**:

1. Identify the incorrect or missing data in the `Incoming Request` tab.
2. Use [Komboman](../../features/komboman) to replay the action with adjusted inputs and verify the fix.
3. Check the integration's **Field Report** (in the dashboard) to see which fields are required by the remote tool.
4. If a connection always requires specific static inputs, you can set up Remote field overrides.

### Logical errors (e.g., Job closed)

Sometimes the request is valid, but the operation cannot be performed due to the state of the remote system (e.g., applying to a closed job or creating a duplicate candidate). Below are some examples of how these errors might look in the logs:

<AccordionGroup>
  <Accordion title="Logical Error Example 1">
    <Frame>
      <img alt="Logical error 1" />
    </Frame>
  </Accordion>

  <Accordion title="Logical Error Example 2">
    <Frame>
      <img alt="Logical error 2" />
    </Frame>
  </Accordion>

  <Accordion title="Logical Error Example 3">
    <Frame>
      <img alt="Logical error 3" />
    </Frame>
  </Accordion>
</AccordionGroup>

**Solution**: Check the state of the referenced records (e.g., is the `job_id` open?) before sending the action, or handle these specific error codes gracefully in your application.

### Temporary issues

If you see a `500` error or a timeout from the remote tool, it might be a temporary issue. Below is an example of how this error might look in the logs:

<AccordionGroup>
  <Accordion title="Temporary Issue Example">
    <Frame>
      <img alt="Temporary remote tool error" />
    </Frame>
  </Accordion>
</AccordionGroup>

**Solution**: Try resending the action directly from the log details view.

## 4. Still not sure?

If the error is unclear or you suspect a bug in Kombo:

1. Copy the URL of the failing log entry.
2. Reach out to [Kombo support](/support).
3. Paste the link so we can look at the exact same trace you are seeing.


# Environments
Source: https://docs.kombo.dev/lms/guides/environments



In Kombo, you will have access to two environments; a **production** environment (prod) and a **development** environment (dev). You can switch between these in the sidebar:

<Frame>
  <img />
</Frame>

## What differs per environment?

Only your tenant name ("Acme" in the case of the screenshot above) is shared
across environments. That means that all your other configurations, including
scopes, enabled tools, webhooks, custom fields, and secrets,
will be different per environment.

## Production

This is where you should create integrations with your customers. We are stricter
in this environment about default privacy settings and data retention.

### Saving the connection flow input in production

When connecting customers via your production environment, their connection flow
input is saved in [session storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage).
This is done so that while the same tab/window is open, your customer will not
have to enter the same data for the same input if they move back and forth
through the connection flow. When the tab/window is closed, the credentials
are forgotten. This differs from the development credential storage,
as described below.

## Development

The development environment is meant to be used with
your [sandbox environments](../getting-started/sandbox-integrations) during
development and testing. This environment is less strict about privacy settings
and data retention.

### Saving the connection flow input in development

In the development environment, the connection flow input is saved
in [local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage).
This is a quality-of-life feature meant for developers to prevent having
to enter the same inputs when creating multiple connections to the same
sandbox. Local storage will persist between browser sessions until it
is manually cleared.

### Kombo sandbox

You have access to our built-in **Kombo Sandbox** tool in the development
environment. You can create a new integration with this sandbox as you would
with any other integration, and instantly start reading data without having
to connect a HR system.

### Stale integrations

**In the development environment only**, integrations that did not receive an
API requests in the past two weeks will automatically
become [inactive](./integration-states#inactive). If you want to continue
using the integration, you can activate it again.

## Roles and Access Control

Kombo uses role-based access control so you can grant team members the right level of access. Roles are assigned per user in the dashboard.

| Role          | Environments             | Configuration          | API Keys               | User Management             |
| ------------- | ------------------------ | ---------------------- | ---------------------- | --------------------------- |
| **Admin**     | Production + Development | Full access            | Full access            | Can invite and manage users |
| **Developer** | Development only         | Full access (dev only) | Full access (dev only) | No access                   |
| **Operator**  | Production only          | Read + limited writes  | No access              | No access                   |

### Admin

Full access across both environments, including all configuration (scopes, webhooks, custom fields), API key management, and user administration.

### Developer

Full access to the Development environment only, including API keys and all configuration within that environment. Cannot access Production or manage users.

### Operator

Read access to the Production environment plus the ability to create integrations, reconnections, and provisioning links, edit integration settings, and map custom fields. Cannot manage API keys, scopes, audit logs, or users.

### SSO and MFA

Kombo's dashboard authentication supports **SSO** (SAML and OIDC) and **MFA** for users who want additional security. These are not available on all plans — contact the Kombo team to check availability and configure them for your tenant.


# Implementing New Tools
Source: https://docs.kombo.dev/lms/guides/implementing-new-tools

Learn about best practices when using a new tool.

To enable a new tool, navigate to the [tools page](https://app.kombo.dev/tools) in the Kombo dashboard and enable it.

Before enabling it, we highly recommend using Kombo's resources to learn more about the tool. The reason for this is that not all HR tools support the exact same feature set. We try to unify these differences as much as possible, but we also aim to provide the best possible resources to prevent any surprises when using a tool.

Below is a list of the resources Kombo provides, and a short explanation on why they could be useful.

## Coverage Grid

The coverage grid provides a high-level overview of which data point is supported across all of our integrations. Hovering over noteworthy data points will also offer explanations of their implementation.

You can access the [HRIS coverage grid](https://app.kombo.dev/coverage/hris) or the [ATS coverage grid](https://app.kombo.dev/coverage/ats) from your dashboard.

## Tools Page

Our [tools page](https://app.kombo.dev/tools) provides in-depth documentation on each tool. Click on a tool's name to view its content.

### Resources

Under the resources tab, you'll find links to the tool's specific resources and guides.

* **Preview Connection Flow:** An interactive overview of the connection flow. Here, you'll be able to see each step that your customer will take, allowing you to provide support if necessary.
* **Connection Guide:** A written guide meant for customers, where we provide screenshots and explanations for navigating the tool's user interface to generate credentials.
* ***Sandbox***: If the tool allows for free demo accounts, we will provide a link here.

**ATS-Specific**

* **How to View Sources**: A guide to show where your company's desired attribution will be displayed in the customer's system.
* ***How to Set Up a Source***: If a tool has a complicated process for setting up source attribution, we provide an additional guide to assist your customer in doing so here.

### Limitations

The limitations tab provides general and data-point-specific explanations of how Kombo unifies the tools' data and, in some cases, which limitations the tool comes with.

For example, when a tool's data model differs too much from the unified Kombo model, we would explain how the data is mapped to the Kombo model here.


# Integration States
Source: https://docs.kombo.dev/lms/guides/integration-states



## What is an Integration Status

After the connection flow has been completed, the integration will appear on
your [integrations page](https://app.kombo.dev/integrations).

Each integration has a status indicator informing you about the current
operational status.

<Note>
  ### API vs UI Integration States

  The [GET integration states](../v1/get-integrations-integration-id) endpoint returns a subset of the below-listed states, returning only those relating to the actual **sync status**.

  The [integrations page](https://app.kombo.dev/integrations) expands on these states for a more human-readable interface.
</Note>

## Possible Integration States

### Active

<Frame>
  <img />
</Frame>

The integration is running as expected, and data is being synced successfully.

### Sync Failing

<Frame>
  <img />
</Frame>

The last sync was not completed successfully. This can be the result of critical
errors, such as missing data, missing permissions, or the tool's API having downtime.

**Next steps:**

* Check the [logs](../features/logs) of the sync to read the error message.
* Reach out to Kombo for help with resolving an issue.

### Sync Has Warnings

<Frame>
  <img />
</Frame>

The last sync was successful with warnings. This can be the result of smaller
unexpected behavior, such as a specific field not being able to be fetched.

**Next steps:**

* Check the [logs](../features/logs) of the sync to read the warning message.
* Reach out to Kombo for help with resolving an issue.

### Quality Assurance

<Frame>
  <img />
</Frame>

If we detect any issues while performing the first sync, the integration status
will automatically be set to quality assurance mode. Our engineering team will
be notified, and we will contact you once we have resolved the issue and
re-enabled the integration.

### Authentication Failing

<Frame>
  <img />
</Frame>

The last sync failed because the credentials could no longer authenticate the
data transfer. This can be the result of expired credentials.

**Next steps:**

* [Reconnect the integration](./connect/reconnection#methods-of-reconnecting)

### Credentials Invalid

<Frame>
  <img />
</Frame>

The status is moved from **authentication failing** to **credentials invalid**
if every sync over the last 24 hours has failed due to authentication. The
integration will be automatically set to pause future syncs until new
credentials are provided.

**Next steps:**

* [Reconnect the integration](./connect/reconnection#methods-of-reconnecting)

### Setup

<Frame>
  <img />
</Frame>

An integration in the setup state has been successfully connected but no filters have been configured yet.

**Next steps:**

* [Create a provisioning link](/hris/v1/post-provisioning-groups-group-id-setup-links) to set up filters for the integration. You can also do this in the dashboard.

### Inactive

<Frame>
  <img />
</Frame>

An inactive integration will no longer automatically sync data. All credentials
and configuration are preserved — reactivating resumes syncing without
reconnection.

You can set an integration to active/inactive in two ways:

* **Dashboard:** Toggle in the settings page of the integration, as shown below.
* **API:** Use [Set integration enabled](../v1/put-integrations-integration-id-enabled) with `{ "value": false }` to pause or `{ "value": true }` to resume.

<Frame>
  <img />
</Frame>

In your [development environment](./environments#development), integrations will
be set to inactive if you did not send an API request to it over the past two
weeks. If desired, you can always reactivate it.

**Next steps:**

* Reactivate the integration in the dashboard or via the API.

### Deleted

<Frame>
  <img />
</Frame>

You previously deleted the integration. You can read more about our deletion policy [here](../features/deletion-policy).


# Partner Credentials
Source: https://docs.kombo.dev/lms/guides/partner-credentials

Learn how existing partnerships to integrated systems can be used with Kombo.

## Overview

When you are already a partner with some of the tools that we are integrating,
Kombo allows you to bring your own credentials and settings to get the most out of
the partnership.

Partner credentials and options can, for example, be the OAuth master-level credentials
that are used to issue access tokens and initialize OAuth flows. That will allow
you to show your logo and name in the OAuth flow instead of Kombo's.

For most integrations, Kombo provides a set of default credentials and settings
so that you don't need to get a partnership with every tool you want to integrate.
However, if you have your own partnership, you can configure custom partner credentials
that work in a revision system, allowing you to manage multiple credential sets and
safely update them without breaking existing integrations.

## Understanding Credential Revisions

Partner credentials work in a revision system. Each time you create or update
credentials, a new revision is created with a label you can assign (e.g.,
"Production credentials" or "Staging credentials").

### How Revisions Work

The revision system ensures that credential changes are safe and non-destructive:

* **New integrations**: When you create a new integration, it automatically uses
  the latest revision (the most recently created one).
* **Reconnecting integrations**: When you reconnect an existing integration, it
  automatically upgrades to use the latest revision.
* **Existing integrations**: Existing integrations continue using their assigned
  revision and are **not automatically migrated** when you create a new
  revision. This ensures that creating new credentials doesn't break existing
  integrations.

## Managing Credentials and Revisions

You can manage partner credentials and revisions on the [tool settings page](https://app.kombo.dev/tools)
for all tools that support this feature.

<Frame>
  <img alt="image" />
</Frame>

The new revision will become the latest revision, and all new integrations will
automatically use it.

Each integration's details page shows which revision it's currently using,
including whether it's using customer-submitted credentials or Kombo default
credentials.

## Best Practices

Always test new credential revisions in your development environment before
using them in production. This helps you catch common issues like:

* Mismatched redirect URLs
* Insufficient OAuth scopes
* Incorrect API endpoints or base URLs
* Invalid authentication tokens

### Upgrading Existing Integrations

To upgrade an existing integration to a new revision, you must reconnect it
using the [reconnection flow](./connect/reconnection). This ensures
that the integration is properly tested with the new credentials before they're
applied.

The reconnection flow allows your customer to re-authenticate with the updated
credentials, ensuring a smooth transition without breaking the integration.

### Getting Help

We are always improving the support for custom partner credentials. If you are
missing this feature for a tool, or if you encounter any issues while setting
up credentials, please reach out to us.


# Static IPs
Source: https://docs.kombo.dev/lms/guides/static-ips

Route all Kombo API calls through a fixed set of IP addresses so your customers can allowlist them.

## Use Case

Some systems are locked down to only accept inbound requests from a pre-approved set of IP addresses. Without Static IPs, Kombo's API calls to these systems would be rejected because our traffic originates from a dynamic address range.

Enabling Static IPs routes all outgoing API calls for a given integration through a fixed pool of addresses that you can share with your customer's system administrator to allowlist.

## Enabling Static IPs

Static IPs are configured per integration link at the time you create the connection link.

1. In the [Kombo dashboard](https://app.kombo.dev/integrations), click **New integration**.
2. Fill in the required fields and expand **Advanced settings**.
3. Toggle **Static IPs** on.
4. The dialog will display the IP addresses assigned to this integration. Copy them — you'll need to share them in the next step.
5. Click **Continue** and send the link to your customer as usual.

<Frame>
  <img
    alt="Static IPs toggle in the New Integration
dialog"
  />
</Frame>

## Sharing the IPs

Once you have enabled Static IPs, share the displayed IP addresses with the administrator of the connected system and ask them to add the addresses to their allowlist. Kombo's API calls will be rejected by the system until the allowlist is in place.

The exact steps to add IPs to an allowlist depend on the connected system. Refer to your customer's system documentation or share our [connection guides](https://help.kombo.dev) for step-by-step instructions.

## Existing Integrations

If you need to enable Static IPs for an integration that has already been set up, open the integration in the [Kombo dashboard](https://app.kombo.dev/integrations), go to its settings page, and toggle **Static IPs** on. The IPs to allowlist will appear immediately below the toggle.

<Frame>
  <img
    alt="Static IPs section on the Integration Settings
page"
  />
</Frame>


# How Kombo Syncs Data
Source: https://docs.kombo.dev/lms/guides/sync

Understanding how Kombo keeps integration data up-to-date internally without sacrificing API reliability and performance.

# Syncs in Kombo

We're mirroring the data in the source systems into a database at regular
intervals (or when you [manually trigger a sync](../v1/post-force-sync)). When you
call our API, we will simply read from our database, resulting in endpoints that
always respond reliably and quickly.

Through our syncing approach, we can also provide [webhooks](./webhooks) for
systems that don't provide webhooks themselves.

<Info>
  This page explains how Kombo syncs data internally. If you're looking for how
  to fetch data from Kombo into your system, see our [Fetching Data
  guide](../getting-started/fetching-data).
</Info>

<Note>
  Note that syncs adhere to [your scope config](../features/scopes), so if there
  are sensitive data points you're not using, then those will **not** end up in
  our database.
</Note>

## Full Syncs vs. Delta Syncs

Kombo uses two different sync strategies to keep your data up-to-date. Each
serves a different purpose and has different trade-offs regarding speed,
completeness, and frequency.

### Full Syncs

A full sync **re-fetches all data** from the connected system. It pulls every
record (employees, candidates, jobs, etc.) regardless of whether it changed
since the last sync.

**Key characteristics:**

* Fetches the **complete dataset** from the remote system
* **Detects deletions**: records that existed before but are no longer returned
  by the source system are marked as deleted in Kombo
* **Reconciles data quality issues**: because everything is re-fetched, full
  syncs can correct inconsistencies that may have been missed by delta syncs or
  webhooks
* **Picks up configuration changes**: if you update your
  [scope config](../features/scopes) to include new fields, a full sync is needed to
  backfill those fields across all existing records
* Runs at a **lower frequency** than delta syncs
* Takes **longer to complete** since it processes all records

Full syncs are essential because they are the only sync type that can reliably
detect deletions and ensure the complete dataset is consistent.

### Delta Syncs

A delta sync **fetches only data that changed** since the last sync. It uses
upstream filters (like `updated_after` timestamps) to request only new or
modified records from the source system.

**Key characteristics:**

* Fetches only **new and modified records**, making it significantly faster
* **Cannot detect deletions**: since it only asks for changes, it has no way of
  knowing which records were removed
* Runs at a **higher frequency** than full syncs
* **Not available for all integrations**: delta syncing depends on the source
  system's API supporting change-based filtering

### How They Work Together

When an integration supports delta syncs, Kombo runs both types on
complementary schedules:

| Sync type  | Frequency | What it fetches      | Detects deletions |
| ---------- | --------- | -------------------- | ----------------- |
| Full sync  | Lower     | All records          | Yes               |
| Delta sync | Higher    | Only changed records | No                |

For integrations that **don't** support delta syncs, Kombo runs full syncs at a
higher frequency to compensate for the lack of incremental updates.

The exact sync frequency depends on your plan and can be customized on higher
tiers.

<Info>
  Some integrations also support **upstream webhooks**, which provide near
  real-time updates for individual record changes. When webhooks are active, the
  polling sync frequency may be reduced since webhooks already keep the data
  fresh. Learn more about [upstream webhooks](./upstream-webhooks).
</Info>

## Sync Units

For some integrations, Kombo splits a sync into smaller, independent **sync
units**. Instead of syncing all data types together, each unit syncs a focused
part of the dataset (for example, one model or a group of related models) and
completes on its own. This is currently being rolled out for a subset of tools
and environments, and doesn't change how you read data from our API.

Because units run independently, a few behaviors are scoped to the unit rather
than the sync as a whole:

* **Deletion tracking is per unit**: after a unit finishes its full sync, only
  the records belonging to that unit are considered for deletion tracking.
  Records from other units are unaffected until their own unit completes.
* **Webhooks are sent per unit**: "Data changed" [webhooks](./webhooks#data-changed)
  fire as each unit processes its data, so you receive updates progressively
  rather than all at once at the end of a full sync.
* **Endpoints unlock as units finish**: for newly connected integrations, an
  endpoint becomes available as soon as the unit responsible for its data
  completes, rather than waiting for the entire initial sync to finish.

## Sync Scheduling

Kombo uses a frequency-based scheduling system that automatically determines
when syncs should run for each integration.

### How Scheduling Works

The scheduling system works by tracking the **last sync time** and adding the
**configured frequency** to determine when the next sync is due.

For example, if a full sync completed at 2:00 PM and the configured frequency is
10 hours, the next sync will be due at 12:00 AM (midnight).

### Sync Frequencies

Different sync types run at different frequencies:

* **Full syncs** run less often when delta syncs are available, and more often
  when they are not
* **Delta syncs** run more frequently than full syncs

The exact frequency depends on your plan and can be customized on higher tiers.

When you manually trigger a sync, it **moves the schedule forward**:

**Example**: Say automatic full syncs are scheduled every 10 hours:

* Last sync: 10:00 AM → Next due: 8:00 PM
* Manual sync at 2:00 PM → Next due: 12:00 AM (midnight) (not 8:00 PM)

The schedule resets from the time of the manual sync, rather than keeping the
original schedule.

## Real-time Data Updates

In addition to full and delta syncs, we are also able to receive webhooks from
selected tools to keep our data in sync more efficiently. Read more about it
[here](./upstream-webhooks).

## Data Normalization

When syncing data from connected systems, Kombo normalizes records into the
unified model. Here's how different data scenarios are handled:

### Missing and Unsupported Fields

If a field is not available in the source system or the integration doesn't
support it, Kombo sets it to `null`. Records are **never dropped** due to
missing fields — you'll always receive the full record with `null` for any
unavailable properties.

This means you should design your system to handle `null` values gracefully,
since different source systems expose different sets of fields.

### Enum Normalization

For categorical fields like `gender`, `employment_type`, or
`employment_status`, Kombo maintains extensive mapping tables that translate
hundreds of system-specific values into unified enum values. For example,
"Vollzeit" or "CDI" from a German or French system both map to `FULL_TIME`.

If a value from the source system cannot be mapped to a known enum value, Kombo
**passes through the original string** rather than discarding it. This means you
may occasionally see raw values from the source system alongside standardized
ones for less common integrations. See the documentation of the specific
endpoint and enum for more information. Some enums don't pass unknown values through.

You can use [remapping](../features/remapping/introduction) to customize how specific
values are mapped if the defaults don't fit your needs.

### Scope-Based Filtering

Fields that are not included in [your scope config](../features/scopes) are set to `null`
during sync. This ensures that sensitive data points you're not using never
enter the Kombo database, even if the source system provides them.

## How Syncs Write Data to the Database

Understanding how Kombo syncs write data to the database is crucial for
understanding data availability and timing behavior.

### Non-Atomic Data Streaming

**Syncs are not atomic operations**. Instead of waiting to commit all data at
the end of a sync, Kombo streams data directly into the database as it's
processed during the sync. This means:

* **Data becomes available immediately**: Updated records appear in API
  responses as soon as they're processed, even while the sync is still running
* **Partial sync results**: If you query the API with `updated_after` during an
  ongoing sync, you'll receive records that have already been processed
* **No "commit phase"**: There's no single point where all sync data becomes
  available at once

### Change Tracking with `changed_at`

Each record in Kombo's database has a `changed_at` timestamp that tracks when
the record was last modified. This field is automatically updated by database
triggers when any tracked field changes:

* **Immediate updates**: `changed_at` is set as soon as a record is upserted
  during sync
* **API filtering**: The `updated_after` parameter in API requests filters based
  on this `changed_at` timestamp
* **Real-time availability**: Records with updated `changed_at` timestamps
  become immediately visible in API responses that use `updated_after` filtering

### Sync Lifecycle and Database Operations

During a sync, Kombo performs these database operations:

1. **Upsert operations**: Each record is upserted (created or updated)
   immediately when processed. If there were changes, the `changed_at` timestamp
   is updated.
2. **Deletion tracking**: For full syncs, records not seen during the sync are
   marked with `remote_deleted_at` after the sync completes successfully.
3. **Reference validation**: Ensures data integrity by validating relationships
   between records.

### Implications for API Consumers

* **Progressive data updates**: You can start receiving updated data before the
  sync completes
* **Timestamp-based filtering works reliably**: Using `updated_after` will
  correctly capture changes made during ongoing syncs
* **No need to wait**: There's no need to wait for sync completion to access
  newly updated data
* **Consistent behavior**: This works the same way for all sync types (full,
  delta, and default syncs)


# Upstream webhooks
Source: https://docs.kombo.dev/lms/guides/upstream-webhooks

Kombo can subscribe to webhooks of the systems that your customers connect. We call this feature upstream webhooks. This document explains how they work and how you can leverage them.

<Note>
  Please be aware that this page covers upstream webhooks. These are webhooks
  that Kombo receives from the connected ATS/HRIS such as Personio or Recruitee.
  If you try to understand webhooks that Kombo sends to your system for new
  integrations or finished syncs, check out [this page](./webhooks).
</Note>

## Concept

Kombo subscribes to webhooks of the systems that your customers connect.
We call this feature upstream webhooks. The goal of this system is to enable you
to receive data in real-time without waiting for a normal sync to complete. Please
note that this is not available for all integrations and depending on the granted
permissions, this might require a re-connect for existing integrations.

When upstream webhooks are successfully enabled and you're subscribed to the data-changed webhook,
Kombo automatically reduces the sync frequency from 3 hours to 24 hours since most updates
are delivered in real-time.

## Availability

Upstream webhooks are available for a limited set of integrations as not all
integrations support them yet. We are actively working on implementing this
feature for more integrations.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul />

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

## Setup

Whether additional setup is required depends on the connected tool. For many
tools, we are able to subscribe to webhooks automatically through the tool's
API. However, some require a one-time manual configuration by the end-customer
via the integration's Setup Flow. Until this step is completed, real-time
updates will not be available, and changes will arrive after the next scheduled
sync instead.

All configured webhook subscriptions (automatic and manual) are shown in an
integration's settings in the Kombo dashboard and can be managed from there.

## End-Customer Experience

For most integrations, the end-customer only needs to grant a permission to the
credentials to allow us to subscribe to webhooks.

<Frame>
  <img />
</Frame>

Kombo will also diligently only subscribe to webhook event types that are compliant
with the scope config. For example, if you disable candidates and only care about jobs, we
will not subscribe to any candidate events.

## Implementation Guide

By using our [Data changed webhook](./webhooks#data-changed), you will automatically receive updates
about changes we receive from upstream webhooks. That is in addition to any
changes from syncs or other sources. Learn more about how to fetch from Kombo in
our [Fetching Data](../getting-started/fetching-data) guide.

Set up the downstream event in the [webhook config](https://app.kombo.dev/configuration/webhooks) in the Kombo dashboard.

```mermaid theme={null}
sequenceDiagram
    participant ATS as End customer's ATS/HRIS
    participant Kombo as Kombo
    participant Customer as Kombo Customer

    ATS->>Kombo: Send upstream webhook event
    Kombo->>Kombo: Verify event

    Kombo-->>ATS: GET related data
    Kombo->>Kombo: Update Kombo DB


    Kombo->>Customer: Send downstream "data-changed"
    Customer->>Customer: Verify event
    Customer->>Kombo: GET changes via Kombo API
```

You can usually expect to receive events from the connected system within 10-20 seconds.
Most systems take a few seconds before they send the webhook to Kombo.

Kombo will retry the request to your system for up to 5 times with exponential
backoff.

## Troubleshooting

Check out the logs in the Kombo dashboard to see every webhook event that we receive.
The downstream request will also be logged there with any warnings or errors that
we encountered while processing or forwarding the event.

<Frame>
  <img />
</Frame>


# Webhooks
Source: https://docs.kombo.dev/lms/guides/webhooks

Kombo sends you webhooks so that you don't have to poll our API for changes.

<Note>
  Please be aware that this page covers downstream webhooks. These are webhooks
  that Kombo sends to your system for events like new integrations or finished
  syncs. If you try to understand webhooks that Kombo receives from the
  connected ATS/HRIS such as Personio or Recruitee, check out [this
  page](./upstream-webhooks).
</Note>

## Enable Webhooks

You can configure your Kombo webhooks in the dashboard directly in the
[webhooks tab](https://app.kombo.dev/configuration/webhooks). After creating the first
webhook, a random webhook secret will be generated and shown. You can learn
how to use it in [Validate the data](#validate-the-data).

<Frame>
  <img alt="1412" />
</Frame>

## Available webhooks

### Data changed

We send a `data-changed` webhook every time data changes in Kombo. This includes
changes from regular syncs as well as updates from upstream webhooks.
Read more about fetching data [here](../getting-started/fetching-data).

<Note>
  We trigger this webhook, when we receive a change. To speed up delivery of
  changes to Kombo, ensure that upstream webhooks are enabled for the
  integration. If upstream webhooks are not enabled or not supported,
  notifications are sent after the next scheduled sync (latency equals the sync
  frequency).
</Note>

You can use this webhook to keep your database up to date by fetching only
the updated data using the `updated_after` filter.

This webhook is useful to fetch data from Kombo into your system. Read more
[here](../getting-started/fetching-data).

We will only ever send you a `data-changed` webhook if there are changes to the data.

```json data-changed theme={null}
{
  "id": "FhghqjnCi9WuAoLT8Z75CFcs",
  "type": "data-changed",
  "data": {
    "integration_id": "bombohr:ats-dev",
    "integration_tool": "bombohr",
    "integration_category": "ATS",
    "changed_models": [
      {
        "name": "ats_applications"
      }
    ]
  }
}
```

We are debouncing `data-changed` with a 30-second window by default. This means
that you will at most receive one `data-changed` webhook every 30 seconds.

When the webhook is triggered for the first time, we send it out immediately.
After that, we will wait 30 seconds, during which we will collect all events and
send them as a single webhook, thereby starting another 30-second cooldown
window. We do not wait for syncs to finish before sending out the webhook;
instead, we may send you multiple webhooks during a single sync to ensure you
receive changes as soon as possible.

### Sync finished

<Warning>
  The `sync-finished` webhook is deprecated and replaced by the [data-changed
  webhook](#data-changed). It is still available for existing setups, but should
  not be implemented in new setups. Use `data-changed` instead for [fetching
  data updates](../getting-started/fetching-data).
</Warning>

The `sync-finished` webhook is sent every time a sync finishes, regardless of
the sync state. Possible values for `sync_state` are:

* `SUCCEEDED` The sync finished successfully.
* `PARTIALLY_FAILED` The sync succeeded but had non-fatal errors. Kombo will
  take care of it.
* `FAILED` There was a critical error during the sync and the sync did not
  finish. If this happens, we get an alert and will look into the issue to fix
  it ASAP.
* `TIMED_OUT` The sync timed out before completion. This happens rarely and will
  cause an immediate and automatic restart of the sync. Kombo will be notified
  and look into the issue ASAP.
* `CANCELLED` The sync was actively canceled by Kombo. This happens very rarely,
  has no negative side-effects, and if it does happen, we will schedule a new
  sync shortly after.
* `AUTHENTICATION_FAILED` The authentication of the connection is incorrect.
  Please check the Kombo dashboard for further steps.

This webhook is useful for informing customers about when the last sync ran or if
user intervention is required due to authentication issues. This should **not** be
used to trigger data refreshes. Use the [data-changed webhook](#data-changed) for that.

<Note>
  The `sync_started_at` field represents when Kombo started syncing data from
  the connected system, not when you should start fetching from Kombo. Do not
  use this field as your `updated_after` parameter when fetching data.
  Otherwise, you might risk missing data that was created/updated via webhooks
  before the sync started.
</Note>

```json sync-finished theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "sync-finished",
  "data": {
    "sync_id": "B89SCXXho7Yw8PGo8AKJxLn4",
    "sync_state": "SUCCEEDED",
    "sync_started_at": "2021-09-01T12:00:00.000Z",
    "sync_ended_at": "2021-09-01T12:30:00.000Z",
    "sync_duration_seconds": 1800,
    "integration_id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
    "integration_tool": "personio",
    "integration_category": "HRIS",
    "end_user": {
      "origin_id": "36123",
      "creator_email": "user@example.com",
      "organization_name": "Acme, Inc."
    },
    "log_url": "https://app.kombo.dev/env/production/logs/C3xUo6XAsB2sbKC7M1gyXaRX"
  }
}
```

### Integration created

The `integration-created` webhook is sent for every integration that is created.
Please react to this webhook event by adding the integration to your database
or by performing any other business logic that is required when an integration is
created.

```json integration-created theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "integration-created",
  "data": {
    "id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
    "tool": "personio",
    "category": "HRIS",
    "end_user": {
      "origin_id": "36123",
      "creator_email": "user@example.com",
      "organization_name": "Acme, Inc."
    }
  }
}
```

### Integration deleted

The `integration-deleted` webhook is sent when an integration is deleted.
Please react to this webhook event by removing the integration from your database
or by performing any other business logic that is required when an integration is
deleted.

```json integration-deleted theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "integration-deleted",
  "data": {
    "id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
    "tool": "personio",
    "category": "HRIS",
    "end_user": {
      "origin_id": "36123",
      "creator_email": "user@example.com",
      "organization_name": "Acme, Inc."
    },
    "deleted_at": "2022-11-02T10:50:10.242Z"
  }
}
```

### Connection flow failed

The `connection-flow-failed` webhook is sent whenever an error occurs during the
connection flow. These errors could, for example, originate from a user entering
incorrect credentials or from a mismatch between the required and supplied API
permissions.

This is not an alert-type webhook, but should instead be used to collect data
and get insights into user behavior. **The connection flow can still be
successfully completed after this webhook is sent.**

You can check whether the connection flow ended successfully by following the
link under `log_url`. Additionally, the log will display the exact errors your
customer ran into, which you can use to provide support if needed.

```json connection-flow-failed theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "connection-flow-failed",
  "data": {
    "integration_tool": "personio",
    "integration_category": "HRIS",
    "end_user": {
      "origin_id": "36123",
      "creator_email": "user@example.com",
      "organization_name": "Acme, Inc."
    },
    "log_url": "https://app.kombo.dev/env/production/logs/C3xUo6XAsB2sbKC7M1gyXaRX"
  }
}
```

### Assessment order received

The `assessment:order-received` webhook is sent every time an assessment is
ordered for a candidate from within an end-customer's tool.

```json assessment:order-received theme={null}
{
  "id": "Cbfk5sHtDxrSrJBRjsDtbaN9",
  "type": "assessment:order-received",
  "data": {
    "id": "B5KQKhAgTv6ZwzrfAbqbhipd",
    "integration_id": "workday:CBNMt7dSNCzBdnRTx87dev4E",
    "package_id": "typescript_test",
    "status": "OPEN",
    "candidate": {
      "remote_id": "12345",
      "email": "john.doe@gmail.com",
      "first_name": "John",
      "last_name": "Doe",
      "phone": "+1 123 456 7890"
    },
    "application": {
      "remote_id": "54321"
    },
    "job": {
      "remote_id": "67890",
      "name": "Engineering Manager",
      "location": {
        "city": "Berlin",
        "country": "DE",
        "raw": "Berlin, Germany",
        "state": "Berlin",
        "street_1": "Lohmühlenstraße 65",
        "street_2": null,
        "zip_code": "12435"
      },
      "hiring_team": [
        {
          "first_name": "Jane",
          "last_name": "Doe",
          "remote_id": "78901",
          "email": "jane.doe@gmail.com",
          "hiring_team_roles": ["RECRUITER"]
        }
      ]
    }
  }
}
```

### Integration state changed

The `integration-state-changed` webhook is sent when the status of the
integration changes. Use this to detect stale credentials and to reconnect your
customer.

Possible values for the `"state"` key include:

* `ACTIVE` The integration is active and working.
* `INVALID` The connection [requires reconnection](./connect/reconnection) in order to work again.
* `INACTIVE` The integration has been paused, either via the [dashboard or API](./integration-states#inactive). No syncs will run until it is re-enabled.

The payload also includes `qa_status` (`PENDING`, `PASSED`, or `FAILED`) and `setup_status` (`INCOMPLETE`, `FINAL_SYNC_PENDING`, or `COMPLETED`). Together these tell you whether the integration is fully ready to serve data — see [integration states](./integration-states) for details.

```json integration-state-changed theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "integration-state-changed",
  "data": {
    "integration_tool": "personio",
    "integration_category": "HRIS",
    "integration_id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
    "end_user": {
      "origin_id": "36123",
      "creator_email": "user@example.com",
      "organization_name": "Acme, Inc."
    },
    "state": "ACTIVE",
    "qa_status": "PASSED",
    "setup_status": "COMPLETED"
    "updated_at": "2021-09-01T12:00:00.000Z"
  }
}
```

### Issue status changed

The `issue-status-changed` webhook is sent when Kombo [raises or resolves an issue](../features/issues). Subscribe once; every customer-visible issue type uses this webhook. See [issue types](../features/issue-types) for the current list. We will add more types over time, so your handler should treat `issue.type` as an open set and not fail on unknown values.

`change` is `raised` when the issue first appears or comes back after being resolved, and `resolved` when the condition clears. This webhook is only sent when the issue is raised or resolved. Snoozing only hides the issue in the Kombo dashboard, so snoozing, a snooze expiring, or updates to the message or other fields do not trigger it.

```json issue-status-changed theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "issue-status-changed",
  "data": {
    "change": "raised",
    "issue": {
      "id": "8f3a1c2e4b5d6a7c8e9f0a1b",
      "type": "integration.authentication_failed",
      "title": "Authentication failed",
      "status": "OPEN",
      "markdown_message": "**Acme, Inc.**'s personio HRIS integration failed authentication. This is often invalid, expired, or revoked credentials, but it can also be temporary provider downtime.\n\nCheck the [logs](https://app.kombo.dev/env/production/integrations/personio:CBNMt7dSNCzBdnRTx87dev4E/logs) first. If the credentials look invalid, create a reconnection link from the [integration page](https://app.kombo.dev/env/production/integrations/personio:CBNMt7dSNCzBdnRTx87dev4E) so the customer can reconnect.",
      "first_observed_at": "2021-09-01T12:00:00.000Z",
      "resolved_at": null
    },
    "integration": {
      "id": "personio:CBNMt7dSNCzBdnRTx87dev4E",
      "tool": "personio",
      "category": "HRIS",
      "end_user": {
        "origin_id": "36123",
        "creator_email": "user@example.com",
        "organization_name": "Acme, Inc."
      }
    }
  }
}
```

## Validate the data

Anyone could post data to your webhook URL. That's why we're signing each
request with a secret specific to your Kombo account. This secret is called the
**Kombo Webhook Secret** and you can find it [on the Kombo
dashboard](https://app.kombo.dev/configuration/webhooks).

Each valid webhook `POST` request from us will include the `X-Kombo-Signature`
header. To validate it, carefully follow these steps:

1. Decode the `X-Kombo-Signature` header from [`base64url`
   encoding](https://base64.guru/standards/base64url) (without padding) to raw
   bytes.
2. Compute the HMAC-SHA256 over the **raw** JSON request body (Kombo encodes
   this using two-space indentation) with your **Kombo Webhook Secret** as raw
   bytes.
3. Compare the decoded signature bytes to the computed HMAC bytes using a
   constant-time comparison function (like [Node.js's
   `timingSafeEqual`](https://nodejs.org/docs/latest-v22.x/api/crypto.html#cryptotimingsafeequala-b))
   to protect against timing attacks.

<Warning>
  If you're stuck trying to get the signatures to match, please verify that:

  1. You're using the Webhook Secret of the **correct Kombo environment** (e.g.,
     production or development).
  2. You're using the **raw JSON request body**. If your framework already parses
     the JSON body for you, make sure to re-encode it with two-space indentation
     (e.g., `JSON.stringify(body, null, 2)` in JavaScript).
  3. You're decoding the signature header from `base64url` (not standard `base64`)
     and comparing raw bytes (not re-encoding the computed HMAC for string
     comparison).
</Warning>

Here are some examples of how you could achieve this in a few different languages:

<CodeGroup>
  ```ts TypeScript theme={null}
  import { createHmac, timingSafeEqual } from 'node:crypto'

  const signatureHeader = req.headers['x-kombo-signature']

  // Get the raw UTF-8-encoded string body because this was used for signing
  const body = request.body

  // Or if you use a framework that parses the body for you, you can use this.
  // Note: This is not the same as JSON.stringify(request.body)
  const body = JSON.stringify(request.body, null, 2)

  const expected = createHmac('sha256', KOMBO_WEBHOOK_SECRET)
  .update(body, 'utf8')
  .digest()

  // Decode and compare in constant time
  const provided = Buffer.from(signatureHeader, 'base64url')
  const isValidRequest =
  provided.length === expected.length && timingSafeEqual(expected, provided)

  ```

  ```python Python theme={null}
  import base64
  import hmac
  import hashlib

  provided_signature = request.headers.get('X-Kombo-Signature')

  secret = KOMBO_WEBHOOK_SECRET.encode()
  expected = hmac.new(secret, request_body, hashlib.sha256).digest()

  # Decode the provided signature and compare in constant time
  try:
    provided = base64.urlsafe_b64decode(provided_signature + '==')
    is_valid_request = hmac.compare_digest(expected, provided)
  except Exception:
    is_valid_request = False

  return is_valid_request
  ```

  ```kotlin Kotlin theme={null}
  val providedSignature = request.getHeader("X-Kombo-Signature")
  // CharStreams is from com.google.guava:guava library
  val requestBodyAsString = request.reader.use { CharStreams.toString(it) }

  // Calculate the signature
  val algorithm = "HmacSHA256"
  val encoding = Charsets.UTF_8
  val secret = KOMBO_WEBHOOK_SECRET.toByteArray(encoding)
  val signingKey = SecretKeySpec(secret, algorithm)
  val mac = Mac.getInstance(algorithm)
  mac.init(signingKey)

  val expected = mac.doFinal(requestBodyAsString.toByteArray(encoding))

  // Decode and compare in constant time
  val isValidRequest = try {
      val provided = Base64.getUrlDecoder().decode(providedSignature)
      MessageDigest.isEqual(expected, provided)
  } catch (e: Exception) {
      false
  }

  return isValidRequest

  ```
</CodeGroup>

## Testing webhooks

The list of all created webhooks has two buttons on the right. One is for
deleting the webhook, the other is for sending a test request. This test request
will contain dummy data but will use the correct data schema.

Be careful when using this feature in production! It will send invalid data to
your webhook.

### Testing locally

For local development, you can use a service like [localtunnel](https://theboroer.github.io/localtunnel-www/)
or [ngrok](https://ngrok.com/). These tools allow you to expose a local port
through a public URL provided by them. The setup is very straightforward: Once
you've started a tunnel, simply add the provided URL as a webhook in the Kombo
dashboard. You can then send test requests to validate that your endpoint is
working properly.

## Retry behavior

If your webhook endpoint does not acknowledge the webhook (returns an error or
does not respond), Kombo will automatically retry the delivery. This ensures
reliable webhook delivery even when your endpoint is temporarily unavailable.

### Retry attempts

Kombo will retry failed webhook deliveries up to **5 times** before giving up.
Each retry uses exponential backoff with the following delays:

* After 1st failure: 1 second
* After 2nd failure: 2 seconds
* After 3rd failure: 4 seconds
* After 4th failure: 8 seconds
* After 5th failure: 16 seconds

### Error conditions that trigger retries

Kombo will retry webhook deliveries for the following error conditions:

* **Rate limit errors** (HTTP 429): Retries respect `Retry-After` headers when
  provided
* **Server errors** (HTTP 5xx): Temporary server errors that may resolve on retry
* **Connection errors**: Network timeouts, connection resets, DNS failures, and
  other transient network issues
* **Cloudflare errors** (HTTP 409 with Cloudflare 1018 error): Temporary
  Cloudflare blocking errors

### Error conditions that do not trigger retries

The following errors will **not** trigger retries, as they indicate permanent
failures:

* **Client errors** (HTTP 4xx, except 429): These typically indicate issues with
  the webhook configuration or request format
* **DNS not found** (ENOTFOUND): The webhook URL cannot be resolved

### Best practices

To ensure reliable webhook delivery:

1. **Respond quickly**: Return a 2xx status code as soon as you've received and
   validated the webhook, even if you process it asynchronously
2. **Handle idempotency**: Webhooks may be delivered multiple times due to
   retries, so ensure your webhook handler is idempotent
3. **Monitor webhook logs**: Check the Kombo dashboard for webhook delivery
   failures and retry attempts

## Automatic deactivation of webhooks

If we are unable to find your webhook endpoint for more than 7 days (HTTP status
code 404 or 410), we will automatically disable the webhook. You can always
re-enable it in the dashboard.


# Connection setup
Source: https://docs.kombo.dev/lms/implementation-guide/connection-setup



The first part of the implementation is the setup of the connection. Your customer needs to generate and share their API credentials so that we can make the necessary API calls for the integration.

There are [multiple ways of implementing this step](/lms/guides/connect/introduction), but during your development and for the first customers we highly recommend just using the Magic Link feature that we provide. This guide will therefore assume that you are using the magic links for setting up the connection.

<Note>
  For your customer-facing implementation, we highly recommend embedding Kombo
  into your product for the best results.
</Note>

1. Generate a link for your customer. You only have to go into the [dashboard](https://app.kombo.dev/integrations) and:
   * Click on New integration

     <img alt="Click on new integration" />

   * Click on "Let your customer create the integration" (during development, you can also use the first option).

     <img alt="Let your customer create" />

   * Click on "Continue".

     <img alt="Click continue" />

   * Copy the link.

     <img alt="Copy link" />

2. Wait for your customer to generate and enter their API credentials. You can see the status of any sent-out connection link in the [Kombo dashboard](https://app.kombo.dev/pending-connections).

   <Note>
     Setting up the credentials for an integration can be tricky for your
     non-technical users. That's why we highly recommend sharing our
     [step-by-step connection
     guides](https://help.kombo.dev/hc/en-us/sections/14349683218961-Connection-Guides)
     with them or guiding them through the process on a short call.
   </Note>

3. Receive the `integration-created` [webhook](/lms/guides/webhooks#integration-created). We send this webhook every time one of your customers creates a new integration.

   ```json theme={null}
   {
     "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
     "type": "integration-created",
     "data": {
       "id": "successfactors:CBNMt7dSNCzBdnRTx87dev4E",
       "tool": "successfactors",
       "category": "LMS",
       "end_user": {
         "origin_id": "36123",
         "creator_email": "user@example.com",
         "organization_name": "Acme, Inc."
       }
     }
   }
   ```

   The `end_user.origin_id` [is submitted by you](/lms/v1/post-connect-create-link) when creating a connection link and should represent the ID of your customer in your database. You need to store this ID in your database so that you'll know which LMS system belongs to which customer. For example, if you have two customers with the IDs "42" and "43", then your database could look as follows after the integrations have been created:

   | end\_user.origin\_id | kombo\_integration\_id                    |
   | -------------------- | ----------------------------------------- |
   | 42                   | `workday:8d1hpPsbjxUkoCoa1veLZGe5`        |
   | 43                   | `successfactors:B1hu5NGyhdjSq5X3hxEz4bAN` |

   <Note>
     **This ID is not for public display** and should only be accessible to your
     backend. The ID is not a secret as such but it's one of two things needed
     alongside the API key. There is no way to list all integration IDs via the
     API key so even in the case of an accidental API key leak, the data would
     still be safe.
   </Note>

## Alerting for customer problems

We will send you a `connection-flow-failed` [webhook](/lms/guides/webhooks#connection-flow-failed) every time a customer is running into an issue. You should set up some sort of alerting based on this webhook so that you can be fast to offer help to your customer, should they have an error when setting up an integration.

```json theme={null}
{
  "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
  "type": "connection-flow-failed",
  "data": {
    "integration_tool": "workday",
    "integration_category": "LMS",
    "end_user": {
      "origin_id": "36123",
      "creator_email": "user@example.com",
      "organization_name": "Acme, Inc."
    },
    "log_url": "https://app.kombo.dev/env/production/logs/C3xUo6XAsB2sbKC7M1gyXaRX"
  }
}
```

## Handling deleted integrations

It is of course also possible to delete integrations. This can be done in two ways:

* via the ["delete integration"-endpoint](/lms/v1/delete-integrations-integration-id). If you are calling this endpoint you should also take care of deleting the `kombo_integration_id` from your database.
* via the `integration-deleted` [webhook](/lms/guides/webhooks#integration-deleted). This will be sent to you if someone goes into the Kombo dashboard and deletes an integration manually. Also then you'll have to remove the `kombo_integration_id` from your database.

  ```json theme={null}
  {
    "id": "5gjAtURLPbnTiwgkaBfiA3WJ",
    "type": "integration-deleted",
    "data": {
      "id": "workday:CBNMt7dSNCzBdnRTx87dev4E",
      "tool": "workday",
      "category": "LMS",
      "end_user": {
        "origin_id": "36123",
        "creator_email": "user@example.com",
        "organization_name": "Acme, Inc."
      },
      "deleted_at": "2022-11-02T10:50:10.242Z"
    }
  }
  ```


# Content providers
Source: https://docs.kombo.dev/lms/implementation-guide/content-providers

Integration guide for content providers connecting to customer LMS systems

This guide is for **content providers** (e.g., compliance training platforms, coaching providers, video course platforms, language learning tools) who want to integrate with their customers' Learning Management Systems.

## Overview

As a content provider, you typically need to:

1. **Read users from the LMS** - automatically provision user profiles without manual signup
2. **Import your courses into the LMS** - users see your catalog in their company's LMS and get redirected to your platform
3. **Write completion data back** - track which courses users have finished

## Why integrate with customer LMS systems?

* **Discovery & assignment** - More users find and access your courses when they're in the LMS, and administrators can assign content directly to their learners
* **Analytics for stakeholders** - HR and leadership can track training completion and correlate it with outcomes
* **Sales checkbox** - "LMS integration" is a requirement in many sales cycles. Most end customers demand the content to appear in their LMS
* **ROI demonstration** - Prove your platform's value (e.g., "employees who complete 6+ hours of training score X higher on performance reviews")

## Implementation flow

The typical integration flow for content providers looks like this:

```mermaid theme={null}
flowchart LR
    subgraph you[You via Kombo]
        A[Read users] --> B[Upsert courses]
    end
    subgraph lms[In the LMS]
        C[User sees your course] --> D[User opens it]
    end
    subgraph your_platform[On Your Platform]
        E[Enroll user via Kombo] --> F[User learns] --> G[Write completion via Kombo]
    end
    you --> lms --> your_platform
```

## API endpoints you'll need

| Endpoint                                                                                                      | Purpose                                       |
| ------------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
| [GET /lms/users](/lms/v1/get-users)                                                                           | Sync employee profiles from the LMS           |
| [POST /lms/courses/bulk](/lms/v1/post-courses-bulk)                                                           | Import your course catalog (create or update) |
| [POST /lms/courses/:course\_id/deactivate](/lms/v1/post-courses-course-id-deactivate)                         | Deactivate a course in the LMS                |
| [GET /lms/course-progressions](/lms/v1/get-course-progressions)                                               | Check which users are assigned/enrolled       |
| [POST /lms/course-progressions](/lms/v1/post-course-progressions)                                             | Enroll users in courses                       |
| [POST /lms/course-progressions/:id/complete](/lms/v1/post-course-progressions-course-progression-id-complete) | Write back completion data                    |

## Step 1: Read users from the LMS

First, sync the user base from your customer's LMS. This allows you to:

* Know which employees exist in the organization
* Match users when they access your platform
* Provision accounts automatically

```bash theme={null}
curl --request GET \
  --url 'https://api.kombo.dev/v1/lms/users' \
  --header 'Authorization: Bearer <api_key>' \
  --header 'X-Integration-Id: <integration_id>'
```

The response includes user details like email, name, and remote IDs that you can use to match users in your system.

<Note>
  When a learner launches a course from the LMS and lands on your platform,
  you'll need to authenticate them (typically via SSO) and match them back to a
  Kombo user without a login prompt. See the [SSO and identity matching
  guide](/lms/implementation-guide/sso-and-identity-matching) for the
  recommended architecture.
</Note>

## Step 2: Import your course catalog

Use the [bulk upsert endpoint](/lms/v1/post-courses-bulk) to create or update courses in the customer's LMS. Each course includes a deep link that redirects users to your platform.

```bash theme={null}
curl --request POST \
  --url 'https://api.kombo.dev/v1/lms/courses/bulk' \
  --header 'Authorization: Bearer <api_key>' \
  --header 'X-Integration-Id: <integration_id>' \
  --header 'Content-Type: application/json' \
  --data '{
    "items": [
      {
        "origin_id": "cybersecurity-101",
        "course": {
          "type": "EXTERNAL",
          "title": "Introduction to Cybersecurity",
          "description": "Learn the fundamentals of cybersecurity.",
          "course_url": "https://your-platform.com/courses/cybersecurity-101",
          "thumbnail_url": "https://your-platform.com/images/cybersecurity-101.png"
        }
      },
      {
        "origin_id": "data-privacy-basics",
        "course": {
          "type": "EXTERNAL",
          "title": "Data Privacy Basics",
          "description": "Understand GDPR and data privacy best practices.",
          "course_url": "https://your-platform.com/courses/data-privacy-basics",
          "thumbnail_url": "https://your-platform.com/images/data-privacy.png"
        }
      }
    ]
  }'
```

<Note>
  The `course_url` field should be a deep link to your platform. When users
  click on the course in their LMS, they'll be redirected to your platform where
  they can consume the content.
</Note>

### Deactivating courses

When a course should no longer be available in the customer's LMS, use the [deactivate endpoint](/lms/v1/post-courses-course-id-deactivate) to make it unavailable for new enrollments while preserving existing progress records:

```bash theme={null}
curl --request POST \
  --url 'https://api.kombo.dev/v1/lms/courses/26vafvWSRmbhNcxJYqjCzuJg/deactivate' \
  --header 'Authorization: Bearer <api_key>' \
  --header 'X-Integration-Id: <integration_id>'
```

## Step 3: Track assignments and enrollments

Check which users have been assigned or enrolled in your courses:

```bash theme={null}
curl --request GET \
  --url 'https://api.kombo.dev/v1/lms/course-progressions' \
  --header 'Authorization: Bearer <api_key>' \
  --header 'X-Integration-Id: <integration_id>'
```

You can filter by specific users using the `user_ids` query parameter:

```bash theme={null}
curl --request GET \
  --url 'https://api.kombo.dev/v1/lms/course-progressions?user_ids=7xPdr68N8kG9EzLwjsN9xyz,8yQes79O9lH0FaLxktO0yza' \
  --header 'Authorization: Bearer <api_key>' \
  --header 'X-Integration-Id: <integration_id>'
```

## Step 4: Write completions back to the LMS

When a user completes a course on your platform, mark it as complete in the LMS:

```bash theme={null}
curl --request POST \
  --url 'https://api.kombo.dev/v1/lms/course-progressions/{course_progression_id}/complete' \
  --header 'Authorization: Bearer <api_key>' \
  --header 'X-Integration-Id: <integration_id>' \
  --header 'Content-Type: application/json' \
  --data '{
    "completed_at": "2024-01-15"
  }'
```

The `completed_at` field is optional and defaults to the current date if not provided.

This ensures that:

* The completion appears in the customer's LMS reports
* L\&D teams can track training progress
* Compliance requirements are documented

## Compared to SCORM

Many content providers currently use **SCORM exports** (a standard package format that LMS systems accept). However, SCORM has limitations:

* **No user sync** - You can't read users from the LMS
* **No dynamic completions** - You can't write back completions programmatically
* **Worse UX** - Users stay in the LMS instead of your optimized platform

Using Kombo's API gives you the flexibility of SCORM with the added benefits of user provisioning and real-time completion tracking.

## Next steps

1. Complete the [setup guide](/lms/implementation-guide/setup) to configure your Kombo account
2. Set up the [connection flow](/lms/implementation-guide/connection-setup) for your customers
3. Implement [SSO and identity matching](/lms/implementation-guide/sso-and-identity-matching) so learners land on your platform authenticated when they launch a course within the LMS
4. Explore the [LMS API reference](/lms/v1/get-users) for detailed endpoint documentation


# Setup
Source: https://docs.kombo.dev/lms/implementation-guide/setup



Before we can get started with development, there's a bit of setup to do. Please follow the steps below carefully so that you won't have any issues down the line.

## Log into the dashboard

Log into the Kombo dashboard. You should have received an **invite via email** but if you didn't, **reach out** to your team members or to Kombo directly via Slack/Teams.

<img alt="Kombo dashboard" />

## Scope configuration

<Note>
  The scope config allows you to set which models and properties will be included when reading data from Kombo. Additionally, when your customers create an integration, they will only be prompted to grant permission to read the properties included in your scope config.

  To understand more about this feature and how to use it to evoke a great first impression with customers, [read more in our docs](/lms/features/scopes).
</Note>

Go to the [scopes overview](https://app.kombo.dev/scope-config) and click on "**New config**" or "**Edit**" an existing one.

<img alt="Scope configuration" />

Select the data models that you need and click on "**Save**".

<img alt="Select data models" />

## Integration configuration

Go to the [tools overview](https://app.kombo.dev/tools) and select/deselect all tools that you want to offer. You can change this at any time.

You can also select if you want to enable newly released tools; on average Kombo adds one tool per week.

<img alt="Integration configuration" />

## Set up a linked account for development

To call the API you always need to have a linked LMS account to pull and push data from. You can either use our built-in mock integration to get started quickly (recommended), or [get yourself a sandbox via a free trial](/lms/getting-started/sandbox-integrations).

To use our built-in sandbox, go to the [integrations tab](https://app.kombo.dev/integrations) and click on "**New integration**", selecting **Kombo Sandbox** as your tool.

<div>
  <img alt="Create sandbox integration" />

  <img alt="Select Kombo Sandbox" />
</div>

What you see now is the so-called connection flow. Customers will see this UI when connecting their LMS to your product via Kombo. You can preview the various connection flows of the different tools on the [tools page](/lms/guides/implementing-new-tools#resources).

Click "**Continue**" and "**Set up integration**".

<img alt="Set up integration" />

**Click** on the tile that just appeared to get to the details page of the integration.

<img alt="Integration tile" />

On this page, you can find all info related to the integration. For now, you will only need the integration ID.

<img alt="Integration details" />

## Set up webhooks

Webhooks are a fundamental part of your Kombo implementation. There are multiple different webhook types for different purposes (you can find all of them [here](/lms/guides/webhooks)) but setting them up always works the same:

Go to the [webhooks tab](https://app.kombo.dev/configuration/webhooks).

<img alt="Webhooks tab" />

Create a webhook, give it a descriptive label, enter the URL, and select the desired type.

<img alt="Create webhook" />

Send a test webhook by clicking the test button.

<img alt="Test webhook" />

<Note>
  Later on in this guide, we will talk more about the most important types of
  webhooks, but you can find an all-encompassing overview on our [webhooks
  page](/lms/guides/webhooks).
</Note>

## Create Kombo API key

Go to the [Secrets tab](https://app.kombo.dev/secrets) and click on "**New API key**".

<img alt="Secrets tab" />

Name the API key and click "**Create API key**".

<img alt="Create API key" />

Copy the token and store it somewhere safe.

<img alt="Copy API key" />

## Test your setup

You made it through the setup and have everything in place to get started developing!

To verify you set up the sandbox integration and API key correctly, try the following HTTP request to the ["get integration details"-endpoint](/lms/v1/get-integrations-integration-id):

```bash theme={null}
curl --request GET \
  --url https://api.kombo.dev/v1/integrations/{integration_id} \
  --header 'Authorization: <api_key>'
```

You can also use any other endpoint like ["get courses"](/lms/v1/get-courses) or ["get course progressions"](/lms/v1/get-course-progressions). The Sandbox integration will return you some sample data for it.

<Tip>
  **Tip:** You can use our [official server-side SDKs](/libraries-and-sdks) to
  interact with the Kombo API in an ergonomic and type-safe manner. Check if
  your tech stack is already supported!
</Tip>

## Optional: set up Postman collection

To make development easier, we recommend setting up a Postman collection. It takes only one minute and can be done like this:

* **Copy** the link of our OpenAPI schema:

  ```bash theme={null}
  https://api.kombo.dev/openapi.json
  ```

* Open Postman, and click **Import**

  <img alt="Postman import" />

* **Paste** the URL and click **Import**

  <img alt="Postman URL" />

  <img alt="Postman Collection" />


# SSO and identity matching
Source: https://docs.kombo.dev/lms/implementation-guide/sso-and-identity-matching

Authenticate learners launching from the LMS and match them to Kombo's synced user data without a login prompt.

This guide is for **content providers** implementing the learner launch flow: when an end-customer's user clicks a course in their LMS, they land on your platform via the deep link you pushed through Kombo. This page covers how to authenticate that learner without a login prompt and how to match them to the user data you already sync from the LMS.

For the broader content provider flow (syncing users, pushing courses, writing completions), see the [content providers guide](/lms/implementation-guide/content-providers).

## Why this guide exists

When a learner launches a course from their LMS, you need to answer:

1. Who is this user?
2. Which end-customer do they belong to?
3. Are they authorized to view this specific course?

Without solving these, you'll either have to show a login screen – which adds friction that the LMS integration was meant to avoid – or serve content to unauthenticated users, which isn't acceptable for enterprise deployments.

This guide covers **identity** – how to authenticate the learner without a login prompt and match them to the Kombo user data you already sync. Authorization is covered briefly at the end, with guidance on how to handle it using Kombo's existing endpoints.

## Recommended architecture

We recommend a hub-and-spoke model where both the LMS and your platform are SAML Service Providers trusting your end-customer's enterprise Identity Provider (Okta, Entra ID, Google Workspace, ADFS, etc.).

```mermaid theme={null}
flowchart LR
    IdP["Enterprise IdP<br/>(Okta, Entra, ...)"]
    LMS["LMS<br/>(Service Provider)"]
    CP["Your platform<br/>(Service Provider)"]
    IdP -.->|SAML trust| LMS
    IdP -.->|SAML trust| CP
```

The launch flow:

```mermaid theme={null}
sequenceDiagram
    participant L as Learner
    participant LMS
    participant IdP as Enterprise IdP
    participant CP as Your platform

    Note over L,IdP: Learner already signed into LMS via IdP<br/>(active IdP session)
    L->>LMS: Click course
    LMS-->>L: Redirect to course_url
    L->>CP: GET /course/...
    CP-->>L: Redirect to IdP (unauthenticated)
    L->>IdP: SSO request
    IdP-->>L: SAML assertion (from existing session)
    L->>CP: POST assertion to ACS endpoint
    Note over CP: Extract shared identifier,<br/>create session
    CP-->>L: Serve content
```

The learner sees a brief redirect and lands in the content. No login screen.

<Note>
  Kombo is **not** in the authentication path. The seamless experience comes
  from the IdP's existing session, not from anything Kombo does at launch time.
  Your platform's uptime during course launch depends only on your
  infrastructure and your end-customer's IdP – not on ours.
</Note>

### Why the hub-and-spoke model (and not LMS-as-IdP)

Some LMSs (e.g. SAP SuccessFactors via its OCN framework) can act as SAML Identity Providers themselves. In that model, your platform would configure a SAML trust relationship with each end-customer's LMS instance instead of with their enterprise IdP.

We recommend the enterprise IdP path as the default:

* Enterprise customers already use their IdP for every other SaaS app. Using it for your platform too is consistent with how they manage identity everywhere else.
* The enterprise IdP is more stable than the LMS. LMS instances change, get migrated, or get replaced; the IdP tends to outlive all of them.
* Some LMSs (notably Workday Learning) can't act as an IdP at all, so you'll need the enterprise IdP path for those customers regardless.

The LMS-as-IdP model is a reasonable fallback when the end-customer won't or can't configure your platform directly against their enterprise IdP. It works the same way structurally – SAML assertions with a shared identifier – but the SAML trust is established with the LMS instead of the IdP.

## Identity matching: the actual Kombo-specific part

Authentication alone isn't enough. Once the learner is authenticated via SSO, your platform has *some* identity for them – usually an email, maybe a name. But to call Kombo's API on their behalf (checking enrollments, writing completions), you need to map this authenticated user to a Kombo user.

What you need is a **shared identifier** that:

* Exists in both the SAML assertion and in Kombo's synced user data
* Is unique and stable
* Comes through reliably at every launch

The shared identifier is the LMS-side user ID that Kombo exposes as the `remote_id` field on each user returned from [`GET /lms/users`](/lms/v1/get-users). If your platform receives the same identifier in the SAML assertion, you can:

* Look the user up via `GET /lms/users?remote_ids=E12345` and use the Kombo `id` downstream
* Or, on action endpoints (e.g. enroll, complete), use the `remote:` prefix (e.g. `user_id: "remote:E12345"`) to skip the lookup entirely

A few important details about what `remote_id` actually holds, per LMS:

* **SAP SuccessFactors** – the Learning `studentID` (as displayed in Learning admin). Many SF tenants are configured so this equals the Employee Central user ID, but that's a per-tenant choice, not a guarantee – confirm with the end-customer's IT team which identifier their IdP should pass.
* **Workday Learning** – the Workday **WID**, pulled from `Worker_Reference`. This is the master identifier Workday uses for the worker across its systems, so customers who already surface a Workday identifier to their IdP are likely passing the WID already. Note that it's **not** the human-readable Employee ID – if the end-customer's IdP only has the Employee ID, that won't match, and you'll need to either have the WID surfaced as an attribute or [fall back to email](#tier-3-email-fallback).
* **Cornerstone OnDemand** – the system's internal user ID.

<Note>
  For the LMSs above, `remote_id` is a single clean primary key. Elsewhere in
  Kombo it can occasionally be a composite when the remote system has no single
  stable key – if you ever see that for an LMS user, parse out the relevant
  component and match on it, or [fall back to email](#tier-3-email-fallback) if
  that isn't possible. [We're happy to help](/support) figure out the specific
  case.
</Note>

### Where the shared identifier comes from

This varies based on how your end-customer has set up their identity architecture. The three common cases:

**Case A – Enterprise IdP with HRIS as source of truth.** Most common for corporate customers. The identifier (typically an employee identifier – see the per-LMS notes above for which specific field matches) is synced from the HR system into the IdP via SCIM or directory sync. To get it into the SAML assertion to your platform, the end-customer's IT team configures the SAML app for your platform to include the identifier as a claim.

**Case B – Enterprise IdP with the LMS maintaining its own user database.** The LMS user ID may not exist in the IdP at all. Either the end-customer has configured a sync between their LMS and their IdP (so the LMS ID is available as an attribute), or they haven't – in which case you'll need to fall back to a weaker identifier like email.

**Case C – LMS itself is the IdP.** The SAML assertion comes directly from the LMS. The LMS user ID is naturally available in the assertion, but you need to know where to look for it (the `NameID` element vs. a specific custom attribute).

The guide below applies to all three cases – what changes is the conversation your team has with the end-customer's IT team during onboarding.

### Three tiers of identity configuration

In order of preference, there are three ways to get the shared identifier into the SAML assertion. Recommend the `NameID` approach during onboarding, fall back to a custom SAML attribute or email matching as needed.

#### Tier 1: NameID (recommended)

The end-customer configures their IdP so the SAML `NameID` element carries the LMS user ID.

```xml theme={null}
<saml:Subject>
  <saml:NameID Format="urn:oasis:names:tc:SAML:2.0:nameid-format:persistent">
    E12345
  </saml:NameID>
</saml:Subject>
```

On your side, you read `NameID` from the assertion and use it directly as the user's `remote_id` when calling Kombo's API. No additional configuration on your platform.

This is the cleanest setup, but it's often not available – `NameID` is frequently already mapped to email for other SAML apps your end-customer uses, and changing it would break those.

#### Tier 2: Custom SAML attribute (alternative)

If `NameID` is taken, the end-customer configures a custom SAML attribute with the LMS user ID. A conventional name is `lms_user_id`, but it can be whatever fits their naming scheme.

```xml theme={null}
<saml:AttributeStatement>
  <saml:Attribute Name="lms_user_id">
    <saml:AttributeValue>E12345</saml:AttributeValue>
  </saml:Attribute>
</saml:AttributeStatement>
```

Your platform needs a per-end-customer configuration option for which attribute to read. Store this alongside your other per-tenant SAML settings.

#### Tier 3: Email fallback

If neither the `NameID` nor custom-attribute approach is possible (e.g. the end-customer's IdP doesn't have the LMS user ID available at all, or their IT policy won't allow custom attributes), you'll have to fall back to matching on email.

Call Kombo's users endpoint with the `work_emails` filter:

```bash theme={null}
curl --request GET \
  --url 'https://api.kombo.dev/v1/lms/users?work_emails=jane.doe@acme.com' \
  --header 'Authorization: Bearer <api_key>' \
  --header 'X-Integration-Id: <integration_id>'
```

Take the Kombo user's `id` from the response and use it for subsequent API calls. Email matching is case-insensitive.

<Warning>
  Email is a weaker identifier than an LMS user ID. The concrete risks:

  * **Emails change** (marriage, rebranding, moves between subsidiaries). If the LMS and IdP update at different times, the assertion email won't match any synced Kombo user until both sides catch up, and the learner can't launch in the meantime. Document for the end-customer that email changes need to be mirrored between the LMS and the IdP.
  * **Emails aren't guaranteed unique.** In multi-tenant LMS setups (one instance serving multiple subsidiaries) the same address can map to more than one user.
  * **No match, no launch.** If the email doesn't resolve to a Kombo user, you have no ID to enroll against or write completions to.

  Use email matching only when the `NameID` and custom-attribute approaches are genuinely unavailable. If email matching won't work for a given end-customer either, see [the FAQ on falling back when no viable identifier is available](#no-viable-identifier).
</Warning>

### What your engineering team needs to implement

Your platform already accepts SAML assertions from enterprise IdPs – we're not going to document that here. The Kombo-specific pieces are:

* **Extract the shared identifier** from `NameID`, the configured custom SAML attribute, or the email – whichever your end-customer's IdP provides.
* **Use the identifier with Kombo's API.**
  * When you have the LMS-side user ID (from `NameID` or a custom attribute), pass it directly on action endpoints like [enroll](/lms/v1/post-course-progressions) using the `remote:` prefix (e.g. `user_id: "remote:E12345"`); the same prefix works for `course_revision_id`. On `GET` filter endpoints, resolve the Kombo user once via `GET /lms/users?remote_ids=E12345` and reuse the returned `id` on subsequent calls.
  * When you only have the email, resolve via `work_emails` first.

## Conceptual example: custom SAML attribute setup

A concrete scenario to ground the tiers:

**Setup:**

* End-customer uses an enterprise IdP (e.g. Entra ID, Okta).
* Their LMS is an enterprise system where the user has a stable LMS-side ID (e.g. SuccessFactors `studentID`, Workday WID).
* That ID is available in the IdP as a user attribute (synced from their HR system or LMS).
* `NameID` is already mapped to email for other SAML apps, so they expose the LMS user ID as a custom attribute instead.

**Configuration steps for the end-customer IT team:**

1. Add your platform as an Enterprise Application / SAML app in their IdP.
2. Configure the SAML SSO settings (your entity ID, ACS URL, signing certificate).
3. In the attributes/claims section, add a custom claim named `lms_user_id` mapped to the user attribute containing the LMS user ID.
4. Assign the relevant users or groups to the application.

**What the assertion looks like:**

```xml theme={null}
<saml:Assertion>
  <saml:Subject>
    <saml:NameID Format="...emailAddress">jane.doe@acme.com</saml:NameID>
  </saml:Subject>
  <saml:AttributeStatement>
    <saml:Attribute Name="lms_user_id">
      <saml:AttributeValue>E12345</saml:AttributeValue>
    </saml:Attribute>
    <!-- ... other attributes like name, email, etc. ... -->
  </saml:AttributeStatement>
</saml:Assertion>
```

**What your platform does on receipt (pseudo-code):**

```python theme={null}
# This is what Kombo exposes as `remote_id` on GET /lms/users.
lms_user_id = assertion.get_attribute("lms_user_id")     # "E12345"

# Store on the session for subsequent Kombo API calls.
session.user            = authenticated_user
session.lms_user_id     = lms_user_id   # matches Kombo's remote_id
session.integration_id  = tenant.kombo_integration_id
```

Later, when you call Kombo on behalf of this user:

* On the [enroll endpoint](/lms/v1/post-course-progressions), pass `user_id: "remote:E12345"` directly. For complete, use the `course_progression_id` returned by enroll.
* On `GET` endpoints with filters, resolve first: `GET /lms/users?remote_ids=E12345` → use the returned Kombo `id`.

<Note>
  The specific attribute names, UI paths, and setup steps vary by IdP and by how
  the end-customer has provisioned their users. The end-customer's IT team will
  know their setup best – the guide above is the template, not a prescriptive
  script.
</Note>

## Authorization: identity doesn't solve everything

With everything above in place, you know who the learner is and can make API calls on their behalf. What you still don't know is whether they're actually authorized to view the specific course they clicked.

There are two patterns we see content providers use, depending on how their end-customers work:

### Pattern 1: Learning library (SSO is the gate)

The LMS admin publishes content broadly and any authenticated employee can view it. SSO handles authentication and, by extension, authorization – if you're in the IdP, you're an employee, and you can view the library.

This is the simplest pattern and works well for self-serve content. No enrollment checks needed on your side.

### Pattern 2: Assigned content (enrollment is the gate)

For compliance training, onboarding, or role-specific courses, the LMS admin assigns specific courses to specific users. Your platform should check that the learner was actually assigned the course before serving it.

```mermaid theme={null}
flowchart TD
    Launch([Learner launches course])
    Auth{Authenticated<br/>via SSO?}
    Enroll{Enrolled in<br/>this course?}
    Serve([Serve content])
    Error([Show error state])
    Deny([Deny access])

    Launch --> Auth
    Auth -->|No| Deny
    Auth -->|Yes| Enroll
    Enroll -->|ENROLLED, IN_PROGRESS,<br/>or COMPLETED| Serve
    Enroll -->|No progression found| Error
    Enroll -->|DROPPED or null| Deny
```

Use Kombo's [course progressions endpoint](/lms/v1/get-course-progressions), filtering by user and course. A few things to know about this endpoint:

* **Filter by Kombo IDs.** `user_ids` and `course_ids` on [`GET /lms/course-progressions`](/lms/v1/get-course-progressions) take Kombo IDs. Since the SAML assertion gives you an LMS-side user ID, resolve it once with `GET /lms/users?remote_ids=E12345` and reuse the returned `id` on subsequent calls.
* **Progressions live at the revision level.** Each progression row has a `course_revision_id` (a specific version of a course), not a `course_id` directly. The `course_ids` filter takes the parent course ID and internally matches progressions on all of that course's revisions – which is what you want 99% of the time.
* **Store the Kombo course ID at upsert time.** [Bulk upsert](/lms/v1/post-courses-bulk) is an [async endpoint](/lms/guides/async-endpoints): `POST /lms/courses/bulk` returns a `task_id`, and you poll `GET /lms/courses/bulk/{task_id}` until completion to get each course's Kombo `id` alongside the `origin_id` you supplied. Persist that mapping alongside your own course data. Subsequent enrollment checks can then resolve your internal course ID to the Kombo course ID directly from your own store. If the mapping is ever lost, [`GET /lms/courses`](/lms/v1/get-courses) returns `origin_id` in the payload.
  So in practice, the check looks like:

```bash theme={null}
# 1. Resolve user (from the SAML-provided remote_id)
curl --request GET \
  --url 'https://api.kombo.dev/v1/lms/users?remote_ids=E12345' \
  --header 'Authorization: Bearer <api_key>' \
  --header 'X-Integration-Id: <integration_id>'
# → kombo_user_id

# 2. Look up progressions
curl --request GET \
  --url 'https://api.kombo.dev/v1/lms/course-progressions?user_ids=<kombo_user_id>&course_ids=<kombo_course_id>' \
  --header 'Authorization: Bearer <api_key>' \
  --header 'X-Integration-Id: <integration_id>'
```

For writes, [enroll](/lms/v1/post-course-progressions) takes `user_id` and `course_revision_id` directly (use the `remote:` prefix to pass LMS-side IDs without a separate lookup). Note that enroll is keyed on `course_revision_id`, not the parent `course_id` used in the filter above – grab the revision id from the course response or from a progressions row. [Complete](/lms/v1/post-course-progressions-course-progression-id-complete) takes a `course_progression_id` path parameter; reuse the Kombo ID returned by enroll, or resolve it via [`GET /lms/course-progressions`](/lms/v1/get-course-progressions).

Grant access when the progression `status` is `ENROLLED`, `IN_PROGRESS`, or `COMPLETED`. Anything else – or no progression at all – should usually mean no access.

<Note>
  **The sync delay caveat.** Because Kombo syncs enrollment data periodically
  rather than fetching it in real time, there's a gap between when an admin
  assigns a course and when Kombo has the data. The exact gap depends on the LMS
  and on the sync frequency configured for your integration. Expect it to be on
  the order of minutes to a few hours for most LMSs.
</Note>

This matters for the edge case where an admin assigns a course and the learner clicks it immediately. Our recommendation:

* Treat the enrollment check as the authoritative gate.
* If the check fails (no progression found), show the learner an error state that explains the likely cause – for example: *"This course isn't available to you yet. If your administrator just assigned it, please check back in a short while."*
* Log these cases so you can tell the difference between genuine "unauthorized" attempts and sync-delay misses.

We're actively working on reducing sync latency and exploring more granular sync options.

## FAQ / gotchas

**What if the end-customer's IdP can't pass custom attributes?** Very rare in practice – all major enterprise IdPs support this. If you hit a genuine blocker, [fall back to email matching](#tier-3-email-fallback).

**What about users who exist in the LMS but not in the IdP (e.g. contractors, external trainees)?** These users won't be able to launch courses via SSO at all. Depending on your product, you may want to offer a separate login flow for these users, or work with the end-customer to ensure all learners are in the IdP.

**My end-customer passes the Workday Employee ID in SAML, but `remote_id` on [`/lms/users`](/lms/v1/get-users) doesn't match. Why?** Workday Learning keys its user records on the WID (an internal Workday ID from `Worker_Reference`), not the human-readable Employee ID. Have the end-customer surface the WID as an additional IdP attribute so it reaches your platform in the SAML assertion – no change needed on your side beyond reading the new attribute.

**Does the SAML trust relationship need to be set up per end-customer?** Yes. Each end-customer has their own IdP and their own SAML metadata. Your platform needs a tenant-aware SAML setup where each end-customer has their own SP configuration. Most enterprise SaaS products already have this; if yours doesn't, consider a service like WorkOS or Auth0 that federates many IdPs behind a single integration.

**Can I avoid the per-end-customer SAML setup?** Not really – identity is inherently per-customer. The configuration work moves to whoever owns the trust relationship (your platform, WorkOS, etc.), but it doesn't disappear.

<a />

**What if my end-customer can't set up SSO at all (or no viable identifier comes through)?** You have two fallback paths. First, you can show your own login screen after the redirect – not ideal for the first launch, but if you keep session lifetimes generous (weeks or months), repeat launches are seamless. Some content providers run this way in production and report it's acceptable in practice; the friction is concentrated on the first click, not every visit. Second, depending on your product, you might offer a one-time account claim flow (learner enters email, receives verification link, creates credentials) which bridges the first login a bit more smoothly.

## Next steps

<CardGroup>
  <Card title="Content providers guide" icon="book-open-reader" href="/lms/implementation-guide/content-providers">
    The broader integration flow: syncing users, pushing courses, and writing
    completions back.
  </Card>

  <Card title="LMS API reference" icon="magnifying-glass" href="/lms/v1/get-users">
    Detailed endpoint documentation for users, courses, and course progressions.
  </Card>
</CardGroup>


# Talent management
Source: https://docs.kombo.dev/lms/implementation-guide/talent-management

Integration guide for talent management platforms reading from customer LMS systems

This guide is for **talent management platforms**, **skills intelligence tools**, and **intranet platforms** that need to read learning data from their customers' LMS systems.

## Overview

As a talent management platform, you typically need to:

1. **Fetch the learning catalog** – pull course/program data including title, description, topics, and skills
2. **Pull training history and completions** – sync what employees have completed and what skills they've acquired
3. **Suggest personalized content** – match employees with relevant courses based on skills they want to develop
4. **Deep link to the LMS** – send users directly to courses in their LMS

## Why integrate with customer LMS systems?

* **Personalized recommendations drive upskilling** – employees are more likely to develop relevant skills when courses are suggested based on their career goals
* **Single source of truth** – your platform becomes the central hub for employee data, including learning history
* **Career paths** – show employees what training they need to reach their target roles
* **Visibility of training ROI** – stakeholders can see the complete learning journey and skills development

## Implementation flow

The typical integration flow for talent management platforms:

```mermaid theme={null}
flowchart LR
    subgraph you[You via Kombo]
        A[Read courses] --> B[Read completions]
    end
    subgraph your_platform[On Your Platform]
        C[Match to skill goals] --> D[User sees recommendations]
    end
    subgraph lms[In the LMS]
        E[User takes course]
    end
    you --> your_platform --> lms
```

## API endpoints you'll need

| Endpoint                                                        | Purpose                                       |
| --------------------------------------------------------------- | --------------------------------------------- |
| [GET /lms/courses](/lms/v1/get-courses)                         | Fetch the learning catalog with rich metadata |
| [GET /lms/course-progressions](/lms/v1/get-course-progressions) | Read training history and completion status   |
| [GET /lms/users](/lms/v1/get-users)                             | Sync user profiles and organizational context |

## Step 1: Fetch the learning catalog

Pull the course catalog from your customer's LMS to understand what training is available:

```bash theme={null}
curl --request GET \
  --url 'https://api.kombo.dev/v1/lms/courses' \
  --header 'Authorization: Bearer <api_key>' \
  --header 'X-Integration-Id: <integration_id>'
```

The response includes course metadata like:

* Title and description
* URL (for deep linking)
* Skill assignments

<Note>
  Training libraries can be large. Use pagination and incremental sync
  strategies to handle high data volumes efficiently. See our [fetching data
  guide](/lms/getting-started/fetching-data) for best practices.
</Note>

## Step 2: Sync training history and completions

Fetch completion data to understand what each employee has learned:

```bash theme={null}
curl --request GET \
  --url 'https://api.kombo.dev/v1/lms/course-progressions' \
  --header 'Authorization: Bearer <api_key>' \
  --header 'X-Integration-Id: <integration_id>'
```

This gives you:

* Which courses each employee has completed
* Progress status
* Completion dates

## Step 3: Sync user data

Pull user profiles to match learning data with employees in your platform:

```bash theme={null}
curl --request GET \
  --url 'https://api.kombo.dev/v1/lms/users' \
  --header 'Authorization: Bearer <api_key>' \
  --header 'X-Integration-Id: <integration_id>'
```

This helps you match users across systems (e.g., using email or remote IDs).

## Step 4: Build personalized recommendations

With the catalog and completion data, your platform can:

1. **Identify skill gaps** - compare completed courses against target role requirements
2. **Recommend relevant training** - suggest courses based on career goals
3. **Track learning journeys** - visualize progress toward skill development
4. **Generate insights** - report on training ROI and skill coverage

## Next steps

1. Complete the [setup guide](/lms/implementation-guide/setup) to configure your Kombo account
2. Set up the [connection flow](/lms/implementation-guide/connection-setup) for your customers
3. Review the [fetching data guide](/lms/getting-started/fetching-data) for sync best practices
4. Explore the [LMS API reference](/lms/v1/get-courses) for detailed endpoint documentation


# Important Changes
Source: https://docs.kombo.dev/lms/important-changes

Significant platform changes that may affect your integration.

<Update label="2026-07-21" description="Timesheet retention outside the sync window">
  ## Timesheets that age out of the sync window are no longer marked as deleted

  Kombo only keeps a rolling window of timesheets up to date during sync (default: the last **2 months**, configurable via the **"Historical timesheet months to sync"** setting). Previously, timesheets that fell outside that window were marked as deleted on the next full sync.

  **What changed:** Kombo now only deletion-tracks timesheets **inside** that window. Timesheets that age out of the window are **kept** and are not marked with `remote_deleted_at` just because they were not re-fetched. Within the window, timesheets that disappear from the remote HRIS are still marked as deleted as usual.

  ### Who is affected

  Anyone relying on timesheets outside the window receiving a `remote_deleted_at` value (or disappearing from default list responses) simply because they aged out of the re-fetch window.

  ### What you should do

  * Treat aging out of the window as **retention**, not deletion — do not expect those rows to be marked deleted.
  * If you need history beyond what you've kept up to date, configure a larger window upfront or archive timesheets on your side.
  * Contact Kombo support if you need the window changed for your environment (the setting is read-only in the dashboard).

  See the [Time & Attendance guide](/hris/features/time-and-attendance) and the [GET timesheets](/hris/v1/get-timesheets) endpoint for details.
</Update>

<Update label="2026-05-19" description="New HTTP status code for integration setup errors">
  ## Integration setup errors now return HTTP status code 409 instead of 503

  From **Tuesday, May 19, 2026**, the following [Kombo error codes](/guides/errors) will start returning **HTTP `409 Conflict`** instead of **HTTP `503 Service Unavailable`**:

  | Error code                                                                        | Meaning                                                      |
  | --------------------------------------------------------------------------------- | ------------------------------------------------------------ |
  | [`INTEGRATION.SETUP_INCOMPLETE`](/guides/errors#integration-setup_incomplete)     | The integration setup hasn't been finished yet.              |
  | [`INTEGRATION.SETUP_SYNC_PENDING`](/guides/errors#integration-setup_sync_pending) | The initial sync after connection is still running.          |
  | [`INTEGRATION.QA_FAILED`](/guides/errors#integration-qa_failed)                   | The integration's setup data didn't pass our quality checks. |

  We're making these changes in accordance with [our error handling best practices](/guides/errors#error-format) that we announced with the release of structured error codes in August 2025:

  Error handling logic on top of the Kombo API should, if available, **always make use of the `error.code` field** in the response, and **only** fall back to the HTTP status code if the `error.code` is not present (which should rarely happen).

  We're changing these specific codes because `409 Conflict` ([RFC 7231](https://www.rfc-editor.org/rfc/rfc7231#section-6.5.8)) matches the actual error state better. The `error.code` values themselves are **not changing**.

  ### What you should do

  Start by checking whether your implementation currently branches on the HTTP status code (`503` specifically, or `5xx` in general) when handling any of the three error codes above.

  * **If it doesn't, you're all set** and don't need to take any action.
  * **If it does**, please update that logic to rely on the `error.code` field instead of the HTTP status code, so it keeps behaving correctly once these errors start returning `409`.

  While you're at it, you may want to consider adding explicit handling for [`INTEGRATION.SETUP_INCOMPLETE`](/guides/errors#integration-setup_incomplete), [`INTEGRATION.SETUP_SYNC_PENDING`](/guides/errors#integration-setup_sync_pending), and [`INTEGRATION.QA_FAILED`](/guides/errors#integration-qa_failed) if you don't have it yet:

  * `INTEGRATION.SETUP_INCOMPLETE` and `INTEGRATION.QA_FAILED` should be surfaced to the affected end-customer or admin user because they usually require manual intervention.
  * `INTEGRATION.SETUP_SYNC_PENDING` resolves once the initial sync finishes, but initial syncs can take hours in some cases. We recommend relying on [webhooks](guides/webhooks) instead of retrying silently or polling aggressively.
</Update>

<Update label="2026-03-20" description="Concurrency limiting enforced">
  ## Action concurrency limiting is now enforced

  Kombo now enforces concurrency limits on action endpoints. Previously,
  concurrent requests were measured but not rejected. Now, when more than 30
  action requests are in flight simultaneously for a single integration,
  additional requests are rejected with HTTP `429` and the error code
  `PLATFORM.CONCURRENCY_LIMIT_EXCEEDED`.

  **Who is affected:** Customers sending many parallel action requests (e.g.,
  bulk-creating candidates or moving applications) may start receiving `429`
  responses they were not receiving before. Model read endpoints are not affected
  (e.g. `GET /ats/candidates`)

  **What to do:**

  * Handle the new `PLATFORM.CONCURRENCY_LIMIT_EXCEEDED` error code in your
    retry logic.
  * Use exponential backoff starting at \~1s.
  * Optionally, check the `Concurrency-Remaining` response header to throttle
    proactively.

  See the full [Concurrency Limiting](guides/concurrency-limiting) guide for
  details.
</Update>


# Introduction
Source: https://docs.kombo.dev/lms/introduction

Learn how to get started with Kombo's unified LMS API.

Kombo's unified LMS API allows reading data from and
writing data to Learning Management Systems
through a single standardized interface.

## Implementation guides

Choose the guide that matches your use case:

<CardGroup>
  <Card title="Content providers" icon="book-open-reader" href="/lms/implementation-guide/content-providers">
    For compliance training, coaching platforms, video courses, and language
    learning tools pushing content to customer LMS systems.
  </Card>

  <Card title="Talent management" icon="chart-user" href="/lms/implementation-guide/talent-management">
    For skill intelligence, intranet platforms, and career pathing tools reading
    learning data from customer LMS systems.
  </Card>
</CardGroup>

## Resources

<CardGroup>
  <Card title="Setup guide" icon="wrench" href="/lms/implementation-guide/setup">
    Configure your Kombo account, create API keys, and set up your development
    environment.
  </Card>

  <Card title="Connection setup" icon="link" href="/lms/implementation-guide/connection-setup">
    Learn how to connect your customers' LMS systems using magic links.
  </Card>

  <Card title="Explore the API reference" icon="magnifying-glass" href="/lms/v1/get-users">
    Explore what data you can read and write through our unified endpoints.
  </Card>
</CardGroup>


# Delete integration
Source: https://docs.kombo.dev/lms/v1/delete-integrations-integration-id

DELETE /integrations/{integration_id}
Delete the specified integration.

**⚠️ This can not be undone!**


# Check API key
Source: https://docs.kombo.dev/lms/v1/get-check-api-key

GET /check-api-key
Check whether your API key is working properly.



# Get integration by token
Source: https://docs.kombo.dev/lms/v1/get-connect-integration-by-token-token

GET /connect/integration-by-token/{token}
Use this endpoint with the token you get from the connection flow to retrieve information about the created integration.

It works in a similar way as the OAuth2 code flow to securely retrieve information and connect the integration to your user.

> Check out [our full guide](/connect/embedded-flow) for more details about implementing the connection flow into your app.

This endpoint is used to ensure users can't trick your system connecting their
account in your system to another customers integration. You don't get the integration ID
from the `showKomboConnect(link)` function but only the short lived token used
for this endpoint so that users can't send you arbitrary data that you would put
into your system.


# Get course progressions
Source: https://docs.kombo.dev/lms/v1/get-course-progressions

GET /lms/course-progressions
Get course progressions

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/lms/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/lms/connectors/cornerstoneondemand">Cornerstone OnDemand</a></li>
    <li><img /><a href="/lms/connectors/workday">Workday</a></li>
    <li><img /><a href="/lms/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/lms/connectors/360learning">360Learning</a></li>
    <li><img /><a href="/lms/connectors/talentlms">TalentLMS</a></li>
    <li><img /><a href="/lms/connectors/docebo">Docebo</a></li>
    <li><img /><a href="/lms/connectors/coursera">Coursera</a></li>
    <li><img /><a href="/lms/connectors/udemy">Udemy Business</a></li>
    <li><img /><a href="/lms/connectors/linkedinlearning">LinkedIn Learning</a></li>
    <li><img /><a href="/lms/connectors/moodle">Moodle</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Retrieve all course progressions from the LMS system. Course progressions track users enrollment and completion status in courses.

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Get courses
Source: https://docs.kombo.dev/lms/v1/get-courses

GET /lms/courses
Get courses

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/lms/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/lms/connectors/cornerstoneondemand">Cornerstone OnDemand</a></li>
    <li><img /><a href="/lms/connectors/workday">Workday</a></li>
    <li><img /><a href="/lms/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/lms/connectors/360learning">360Learning</a></li>
    <li><img /><a href="/lms/connectors/talentlms">TalentLMS</a></li>
    <li><img /><a href="/lms/connectors/docebo">Docebo</a></li>
    <li><img /><a href="/lms/connectors/coursera">Coursera</a></li>
    <li><img /><a href="/lms/connectors/udemy">Udemy Business</a></li>
    <li><img /><a href="/lms/connectors/linkedinlearning">LinkedIn Learning</a></li>
    <li><img /><a href="/lms/connectors/moodle">Moodle</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Retrieve all courses available in the LMS. Courses are structured learning programs that users can enroll in and complete.

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Get status of “Upsert courses” task
Source: https://docs.kombo.dev/lms/v1/get-courses-bulk-task-id

GET /lms/courses/bulk/{task_id}
Poll for the status of an existing “Upsert courses” task.

<Info>
  This endpoint returns the current status of a task. Poll it at regular intervals until the task reaches a terminal status. Learn more in our [async endpoints guide](/lms/guides/async-endpoints). The possible statuses are:

  * `PENDING` – The task is still being processed.
  * `COMPLETED` – The task finished successfully. The `data` field contains the results.
  * `FAILED` – The task encountered an error. Check the `error` field for details.
</Info>


# Get integration details
Source: https://docs.kombo.dev/lms/v1/get-integrations-integration-id

GET /integrations/{integration_id}
Get the specified integration with everything you need to display it to your customer.



# Get custom fields with current mappings
Source: https://docs.kombo.dev/lms/v1/get-integrations-integration-id-custom-fields

GET /integrations/{integration_id}/custom-fields
Get all custom fields available on the specified integration.

\**This includes the mapping to the corresponding integration field if applicable*


# Get integration fields
Source: https://docs.kombo.dev/lms/v1/get-integrations-integration-id-integration-fields

GET /integrations/{integration_id}/integration-fields
Get all fields available on the specified integration.

**This includes the mapping to your custom fields**


# Get tools
Source: https://docs.kombo.dev/lms/v1/get-tools-category

GET /tools/{category}
Get a list of the tools (i.e., integrations) enabled in your environment.

This can (in combination with the `integration_tool` parameter of [the "Create Link" endpoint](/v1/post-create-link)) be used to, for example, display a custom list or grid of available integrations to your end users instead of exposing Kombo Connect's standard tool selector.


# Get users
Source: https://docs.kombo.dev/lms/v1/get-users

GET /lms/users
Get users

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/lms/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/lms/connectors/cornerstoneondemand">Cornerstone OnDemand</a></li>
    <li><img /><a href="/lms/connectors/workday">Workday</a></li>
    <li><img /><a href="/lms/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/lms/connectors/360learning">360Learning</a></li>
    <li><img /><a href="/lms/connectors/talentlms">TalentLMS</a></li>
    <li><img /><a href="/lms/connectors/docebo">Docebo</a></li>
    <li><img /><a href="/lms/connectors/coursera">Coursera</a></li>
    <li><img /><a href="/lms/connectors/udemy">Udemy Business</a></li>
    <li><img /><a href="/lms/connectors/linkedinlearning">LinkedIn Learning</a></li>
    <li><img /><a href="/lms/connectors/moodle">Moodle</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Retrieve all users from the LMS system. Users are learners who can enroll in and complete courses.

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`


# Updates an integration fields passthrough setting
Source: https://docs.kombo.dev/lms/v1/patch-integrations-integration-id-integration-fields-integration-field-id

PATCH /integrations/{integration_id}/integration-fields/{integration_field_id}
When enabled, the integration field will be passed as part of the `integration_fields` array on the specific model endpoint. Providing false will disable the passthrough for the specified field.



# Activate integration (optional)
Source: https://docs.kombo.dev/lms/v1/post-connect-activate-integration

POST /connect/activate-integration
Use this endpoint with the token you get from the connection flow to retrieve information about the created integration. It works in a similar way as the OAuth2 code flow to securely retrieve information and connect the integration to your user. You do not need to call this endpoint for an integration to become active.

<Warning>We are deprecating this endpoint in favour of the [get integration by code endpoint](/v1/get-integration-by-token-token). To migrate you only have to change to the new API endpoint.</Warning>

### Example Request Body

```json theme={null}
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtZXNzYWdlIjoiVGhpcyBpcyBub3QgYW4gYWN0dWFsIHRva2VuLiJ9.JulqgOZBMKceI8vh9YLpVX51efND0ZyfUNHDXLrPz_4"
}
```


# Create connection link
Source: https://docs.kombo.dev/lms/v1/post-connect-create-link

POST /connect/create-link
Generate a unique link that allows your user to enter the embedded Kombo Connect flow.

> Check out [our full guide](/connect/embedded-flow) for more details about implementing the connection flow into your app.

> Kombo will not deduplicate integrations for you that are created with this endpoint. You are responsible for keeping track of integrations in your system and prevent customers from connecting the same tool again. Use the [reconnection link](/v1/post-integrations-integration-id-relink) endpoint if you want a customer to update their credentials.

### Example Request Body

```json theme={null}
{
  "end_user_email": "test@example.com",
  "end_user_organization_name": "Test Inc.",
  "integration_category": "HRIS",
  "integration_tool": "personio",
  "end_user_origin_id": "123",
  "language": "en",
  "link_type": "EMBEDDED"
}
```


# Enroll user in course
Source: https://docs.kombo.dev/lms/v1/post-course-progressions

POST /lms/course-progressions
Enroll a user in a course revision.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/lms/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/lms/connectors/cornerstoneondemand">Cornerstone OnDemand</a></li>
    <li><img /><a href="/lms/connectors/workday">Workday</a></li>
    <li><img /><a href="/lms/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/lms/connectors/360learning">360Learning</a></li>
    <li><img /><a href="/lms/connectors/talentlms">TalentLMS</a></li>
    <li><img /><a href="/lms/connectors/docebo">Docebo</a></li>
    <li><img /><a href="/lms/connectors/coursera">Coursera</a></li>
    <li><img /><a href="/lms/connectors/moodle">Moodle</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

<Note>
  This endpoint requires the permission **Create and manage course progressions** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "user_id": "7xPdr68N8kG9EzLwjsN9xyz",
  "course_revision_id": "3KMdr68N8kG9EzLwjsN9aoz"
}
```


# Complete course
Source: https://docs.kombo.dev/lms/v1/post-course-progressions-course-progression-id-complete

POST /lms/course-progressions/{course_progression_id}/complete
Mark a course revision as completed for a user.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/lms/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/lms/connectors/cornerstoneondemand">Cornerstone OnDemand</a></li>
    <li><img /><a href="/lms/connectors/workday">Workday</a></li>
    <li><img /><a href="/lms/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/lms/connectors/360learning">360Learning</a></li>
    <li><img /><a href="/lms/connectors/docebo">Docebo</a></li>
    <li><img /><a href="/lms/connectors/moodle">Moodle</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

<Note>
  This endpoint requires the permission **Create and manage course progressions** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "completed_at": "2024-04-15",
  "score": 93
}
```


# Upsert courses
Source: https://docs.kombo.dev/lms/v1/post-courses-bulk

POST /lms/courses/bulk
Create or update multiple courses in the LMS.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/lms/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/lms/connectors/cornerstoneondemand">Cornerstone OnDemand</a></li>
    <li><img /><a href="/lms/connectors/workday">Workday</a></li>
    <li><img /><a href="/lms/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/lms/connectors/360learning">360Learning</a></li>
    <li><img /><a href="/lms/connectors/talentlms">TalentLMS</a></li>
    <li><img /><a href="/lms/connectors/moodle">Moodle</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

<Info>
  **Note:** This endpoint is asynchronous – it returns a `task_id` immediately and processes the request in the background. Use the corresponding `GET` endpoint to poll for the task status until it reaches `COMPLETED` or `FAILED`. Learn more in our [async endpoints guide](/lms/guides/async-endpoints).
</Info>

<Note>
  This endpoint requires the permission **Upsert courses** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "items": [
    {
      "origin_id": "course-1",
      "course": {
        "type": "EXTERNAL",
        "title": "Building LMS integrations with Kombo",
        "description": "Learn how to build and integrate Learning Management System (LMS) integrations with Kombo. This course covers the unified LMS API, course management, user enrollment, progress tracking, and best practices for building robust LMS connectors.",
        "course_url": "https://docs.kombo.dev/lms/introduction",
        "thumbnail_url": "https://kombo.dev/images/courses/lms-integrations-thumbnail.png",
        "duration": 45,
        "languages": [
          "en",
          "de-CH"
        ]
      }
    },
    {
      "origin_id": "course-2",
      "course": {
        "type": "EXTERNAL",
        "title": "Introduction to TypeScript",
        "description": "Learn one of the most popular programming languages of the recent years quickly and efficiently. Results guaranteed!",
        "course_url": "https://example.com",
        "thumbnail_url": "https://example.com/images/thumbnail.jpg",
        "duration": 60,
        "languages": [
          "en-US",
          "pl-PL"
        ]
      }
    }
  ]
}
```


# Deactivate course
Source: https://docs.kombo.dev/lms/v1/post-courses-course-id-deactivate

POST /lms/courses/{course_id}/deactivate
Deactivate a course in the LMS.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li><img /><a href="/lms/connectors/successfactors">SAP SuccessFactors</a></li>
    <li><img /><a href="/lms/connectors/workday">Workday</a></li>
    <li><img /><a href="/lms/connectors/sandbox">Kombo Sandbox</a></li>
    <li><img /><a href="/lms/connectors/360learning">360Learning</a></li>
    <li><img /><a href="/lms/connectors/talentlms">TalentLMS</a></li>
    <li><img /><a href="/lms/connectors/moodle">Moodle</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

Deactivates a course, making it unavailable for new enrollments while preserving existing progress records.

<Note>
  This endpoint requires the permission **Upsert courses** to be enabled in [your scope config](/scopes).
</Note>


# Trigger sync
Source: https://docs.kombo.dev/lms/v1/post-force-sync

POST /force-sync
Trigger a sync for a specific integration.

<Warning>Please note that it is **not** necessary nor recommended to call this endpoint periodically on your side. Kombo already performs periodic syncs for you and you should only trigger syncs yourself in special cases (like when a user clicks on a "Sync" button in your app).</Warning>


# Create provisioning setup link (deprecated)
Source: https://docs.kombo.dev/lms/v1/post-hris-provisioning-groups-group-id-setup-links

POST /hris/provisioning-groups/{group_id}/setup-links
Create a new link that can be passed to the Kombo Connect SDK to open the provisioning setup UI.

<Warning>
  **This endpoint is deprecated!**

  Please use the [Create Setup Flow link endpoint](/v1/post-integrations-integration-id-setup-link) instead. It supports the full Setup Flow (including filtering, field mapping, and any other enabled steps) and works for any integration category, not just HRIS.
</Warning>


# Create reconnection link
Source: https://docs.kombo.dev/lms/v1/post-integrations-integration-id-relink

POST /integrations/{integration_id}/relink
Create a link that will allow the user to reconnect an integration. This is useful if you want to allow your users to update the credentials if the old ones for example expired.

Embed this the same way you would [embed the connect link](/connect/embedded-flow). By default, the link will be valid for 1 hour.

### Example Request Body

```json theme={null}
{
  "language": "en",
  "scope_config_id": "9Pv6aCFwNDEzPNmwjSsY9SQx",
  "link_type": "EMBEDDED"
}
```


# Create Setup Flow link
Source: https://docs.kombo.dev/lms/v1/post-integrations-integration-id-setup-link

POST /integrations/{integration_id}/setup-link
Create a link that lets your customer run the [Setup Flow](/hris/features/setup-flow/introduction) for an integration. Use this to send customers back into setup steps like field mapping or employee filtering without having to go through the initial connection flow again. Pass the returned URL to `showKomboConnect` from the Kombo Connect SDK, the same way you do with a connection link.

The integration must have at least one Setup Flow step enabled (e.g. field mapping or employee filtering); otherwise this endpoint returns a `PLATFORM.INPUT_INVALID` error. Steps can be enabled from the Integration Settings tab in the dashboard or via the [Create Connection Link endpoint](./post-connect-create-link).


# Send passthrough request
Source: https://docs.kombo.dev/lms/v1/post-passthrough-tool-api

POST /passthrough/{tool}/{api}
Send a request to the specified integration's native API.

At Kombo we put a lot of work into making sure that our unified API covers all our customers' use cases and that they never have to think about integration-specific logic again. There are cases, however, where our customers want to build features that are very integration-specific. That's where this endpoint comes in.

Pass in details about the request you want to make to the integration's API and we'll forward it for you. We'll also take care of setting the right base URL and authenticating your requests.

To get started, please pick the relevant API (some tools provide multiple to due different base URLs or authentication schemes) from the table below and pass in the `{tool}/{api}` identifier as part of the path.

| Integration                  | `{tool}/{api}`                     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| ---------------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| 360Learning                  | `360learning/v2`                   | 360Learning [API v2](https://360learning.readme.io/docs). We automatically handle authentication and use `https://app.360learning.com/api/v2/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| a3innuva Nómina              | `a3innuvanomina/laboral`           | a3innuva Nómina API [docs](https://a3developers.wolterskluwer.es/). Requests are automatically authenticated using OAuth access tokens (refreshed when needed). Base URL: `https://a3api.wolterskluwer.es/Laboral/api`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Abacus Umantis               | `abacusumantis/v1`                 | [Umantis API v1](https://recruitingapp-91005709.umantis.com/api/v1/swagger-ui). We automatically authenticate all requests and use `https://\{subdomain\}.umantis.com/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Abacus                       | `abacus/api`                       | Abacus [REST API](https://apihub.abacus.ch/). We automatically authenticate all requests and use `https://\{\{abacusUrl\}\}/api/entity/v1/mandants/\{\{mandantId\}\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Absence.io                   | `absenceio/v2`                     | Absence.io [API](https://docs.absence.io/). We automatically authenticate all requests and use `https://app.absence.io/api/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| ADP Decidium                 | `adpdecidium/default`              | [ADP Decidium API](https://developers.adp.com/apis/api-explorer/hcm-offrg-dge). We automatically authenticate all requests and use `https://api.eu.adp.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| ADP Workforce Now            | `adpworkforcenow/default`          | [ADP Workforce Now API v2](https://developers.adp.com/build/api-explorer/hcm-offrg-wfn). We automatically authenticate all requests and use the correct subdomain.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| AFAS Software                | `afas/api`                         | AFAS' [API](https://connect.afas.nl/rest/get). We automatically authenticate all requests and use `https://\{domain\}/ProfitRestServices` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| AlexisHR                     | `alexishr/v1`                      | [AlexisHR's v1 API](https://docs.alexishr.com/) We automatically authenticate all requests and use `https://\{subdomain\}.alexishr.com` as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| ApplicantStack               | `applicantstack/api`               | ApplicantStack's [API](https://helpas.payrollservers.info/s/article/API-Integration-Guide). We automatically authenticate all requests and use `https://\{subdomain\}.applicantstack.com/api/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Apploi                       | `apploi/rest-api`                  | The [Apploi API](https://integrate.apploi.com/). We automatically authenticate all requests and use `https://partners.apploi.com/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Ashby                        | `ashby/v1`                         | Ashby's [V1 API](https://developers.ashbyhq.com/reference/introduction). We automatically authenticate all requests with the provided credentials and use `https://api.ashbyhq.com` as the base URL. Please note that Ashby uses an RPC-style API. Please check [the Ashby API documentation](https://developers.ashbyhq.com/reference/introduction) for details on how to use it.                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| Asymbl                       | `asymbl/v63`                       | We use `https://\{subdomain\}.my.salesforce.com` as the base URL. Find the official docs [here](https://asymblinc.github.io/ats/ats.html).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Avature                      | `avature/custom-api`               | Avatures's Custom API. Call `Get /openapi` to retrieve the specific custom API schema. We automatically authenticate all requests and use the instance specific custom API URL as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Avionté                      | `avionte/front-office-v1`          | Avionte's API. We automatically authenticate all requests and use `https://api.avionte.com/front-office/v1` as the base URL. Documentation for the BOLD Front Office API: [https://developer.avionte.com/reference/get-all-talent-tags](https://developer.avionte.com/reference/get-all-talent-tags)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| BambooHR                     | `bamboohr/v1`                      | BambooHR's [API](https://documentation.bamboohr.com/reference/get-employee). We automatically authenticate all requests using the customer credentials `https://api.bamboohr.com/api/gateway.php/\{subdomain\}/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| BITE                         | `bite/v1`                          | [Bite's v1 API](https://api.b-ite.io/docs/#/). We automatically authenticate all requests and use your configured API base URL with `/v1` appended (default `https://api.b-ite.io/v1`).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| BoondManager                 | `boondmanager/api`                 | BoondManager [REST API](https://ui.boondmanager.com/administrator/developer/apisandbox). We automatically authenticate all requests and use `https://ui.boondmanager.com/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Breezy HR                    | `breezyhr/v3`                      | [BreezyHR's v3 API](https://developer.breezy.hr/reference/overview). We automatically authenticate all requests and use "[https://api.breezy.hr/v3/](https://api.breezy.hr/v3/)" as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| Bullhorn for Salesforce      | `bullhorn4salesforce/v66`          | We use `https://\{subdomain\}.my.salesforce.com/services/data/v66.0` as the base URL. Find the official docs [here](https://kb.bullhorn.com/bh4sf/Content/BH4SF/Topics/bh4sfRestAPI.htm).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Bullhorn                     | `bullhorn/default`                 | [Bullhorn's API](https://bullhorn.github.io/rest-api-docs/index.html). We automatically use the right `https://\{subdomain\}.bullhornstaffing.com/rest-services/\{corpToken\}` base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| CareerPlug                   | `careerplug/api`                   | We use `https://api.careerplug.com` as the base URL. Find the official docs [here](https://api.careerplug.com/docs#api).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Carerix                      | `carerix/api`                      | Carerix [REST API](https://docs.carerix.io/rest/introduction). We automatically authenticate all requests and use `https://api.carerix.com` as the base URL. Please note that Carerix uses XML for request and response bodies.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Carerix                      | `carerixgraphql/graphql`           | Carerix [GraphQL API](https://docs.carerix.io/graphql/welcome). We automatically authenticate all requests (OAuth2 client credentials) and use `https://api.carerix.io/graphql/v1` as the base URL. Send GraphQL requests as `POST /graphql` with a JSON body of `\{ "query": "...", "variables": \{ ... \} \}`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| CEGID TalentSoft Customer    | `talentsoftcustomer/v1`            | Cegid Talentsoft Recruiting FrontOffice API: [API Documentation](https://developers.cegid.com/api-details#api=cegid-talentsoft-recruiting-frontoffice) We automatically authenticate all requests and use `https://\{customer_subdomain\}.talent-soft.com/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| CEGID TalentSoft FrontOffice | `talentsoft/v2`                    | Cegid Talentsoft Recruiting FrontOffice [API](https://developers.cegid.com/api-details). We automatically authenticate all requests using the provided credentials and use `https://\{domain\}/api/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Ceipal                       | `ceipal/v1`                        | We use `https://api.ceipal.com/v1` as the base URL. Find the official docs [here](https://developer.ceipal.com/ceipal-ats-version-one/ceipal-ats-v1-api-reference).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Cezanne HR                   | `cezannehr/dataservice`            | [CezanneHR's v7 dataservice API](https://api.cezannehr.com/).We automatically authenticate all requests and use the base URL `https://\{subdomain\}.cezanneondemand.com/cezanneondemand/v7/dataservice.svc`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Compleet (Persy)             | `compleetpersy/api`                | Compleet Persy [REST API](https://persy-api.refined.site/space/PAPI/450166808/Requirements+Jobfeed+%2F+Anforderungen+f%C3%BCr+Jobfeeds). We automatically authenticate all requests and use `https://www.germanpersonnel.de/persy/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Compleet                     | `compleetpitcher/pitcher`          | Compleet's Pitcher API. We automatically authenticate all requests and use the configured base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Connexys By Bullhorn         | `connexys/api`                     | [Connexy's API](https://api.conexsys.com/client/v2/docs/#section/Overview). We automatically authenticate all requests and use `https://\{connexys_domain\}/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Cornerstone OnDemand         | `cornerstoneondemand/core-hr`      | Cornerstone's [Core HR API](https://csod.dev/reference/core-hr/). We automatically authenticate all requests using the client ID and secret and use `https://\{your_domain\}.csod.com/services/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Cornerstone OnDemand         | `cornerstoneondemand/learning`     | Cornerstone's [Learning API](https://csod.dev/reference/learning/). We automatically authenticate all requests using the client ID and secret and use `https://\{your_domain\}.csod.com/services/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Cornerstone OnDemand         | `cornerstoneondemand/recruiting`   | Cornerstone's [Recruiting API](https://csod.dev/reference/recruiting/). We automatically authenticate all requests using the client ID and secret and use `https://\{your_domain\}.csod.com/services/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Cornerstone TalentLink       | `cornerstonetalentlink/apply`      | Cornerstone TalentLink's Apply API. We automatically authenticate all requests using the provided credentials and API key, and use `https://apiproxy.shared.lumessetalentlink.com/apply` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Cornerstone TalentLink       | `cornerstonetalentlink/rest`       | Cornerstone TalentLink's [REST API](https://developer.lumesse-talenthub.com/rest-api-developers-guide/1.21.33/index.html?page=rest-api\&subpage=introduction). We automatically authenticate all requests using the provided credentials and API key, and use `https://apiproxy.shared.lumessetalentlink.com/tlk/rest` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Coursera                     | `coursera/v1`                      | We use `https://api.coursera.com/ent` as the base URL. Find the official docs [here](https://dev.coursera.com).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Coveto (legacy SOAP API)     | `coveto/public`                    | We automatically use `https://\{subdomain\}.coveto.de` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Coveto (REST API)            | `covetorest/v1`                    | We automatically use `https://\{subdomain\}.coveto.de/public/api/v1` as the base URL. [https://demo.coveto.de/swagger-ui/index.html#/](https://demo.coveto.de/swagger-ui/index.html#/)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Crelate                      | `crelate/api`                      | Crelate [REST API](https://app.crelate.com/api3/docs/index.html). We automatically authenticate all requests and use `https://app.crelate.com/api3` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| d.vinci admin                | `dvinciadmin/odata-api`            | [DVinci ODATA API](https://dvinci.freshdesk.com/en/support/solutions/articles/75000059523-odata-reporting-api).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| d.vinci admin                | `dvinciadmin/rest-api`             | [DVinci REST API](https://static.dvinci-easy.com/files/d.vinci%20rest-api.html).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| d.vinci                      | `dvinci/apply-api`                 | The [DVinci Apply API](https://static.dvinci-easy.com/files/d.vinci%20application-apply-api.html). All requests are authenticated by Kombo and use `https://\{dvinci_domain\}/p/\{portal_path\}/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| d.vinci                      | `dvinci/rest-api`                  | The [DVinci REST API](https://static.dvinci-easy.com/files/d.vinci%20rest-api.html). All requests are authenticated by Kombo and use `https://\{dvinci_domain\}/restApi/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Databites                    | `databites/v1`                     | We use `https://\{subdomain\}.databites.de` as the base URL. Find the official docs [here](https://\{subdomain}.databites.de/api-dokumentationen/public-integrations/index).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| DATEV LODAS                  | `datev/eau`                        | DATEV's [eau](https://developer.datev.de/en/product-detail/eau-api/1.0.0/overview) API. We automatically authenticate all requests and use \`[https://eau.api.datev.de/\\\{platform](https://eau.api.datev.de/\\\{platform)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | platform-sandbox}/v1/clients/\{client-id}/\` as the base URL. |
| DATEV                        | `datevhr/eau`                      | DATEV's [eau](https://developer.datev.de/en/product-detail/eau-api/1.0.0/overview) API. We automatically authenticate all requests and use \`[https://eau.api.datev.de/\\\{platform](https://eau.api.datev.de/\\\{platform)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | platform-sandbox}/v1/clients/\{client-id}/\` as the base URL. |
| DATEV                        | `datevhr/hr-exports`               | DATEV's [hr-exports](https://developer.datev.de/en/product-detail/hr-exports/1.0.0/overview). We automatically authenticate all requests and use \`[https://hr-exports.api.datev.de/\\\{platform](https://hr-exports.api.datev.de/\\\{platform)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | platform-sandbox}/v1/clients/\{client-id}\` as the base URL.  |
| DATEV                        | `datevhr/hr:payrollreports`        | DATEV's [hr:payrollreports](https://developer.datev.de/en/product-detail/hr-payrollreports/2.0.0/overview) API. We automatically authenticate all requests and use \`[https://hr-payrollreports.api.datev.de/\\\{platform](https://hr-payrollreports.api.datev.de/\\\{platform)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | platform-sandbox}/v1/clients/\{client-id}/\` as the base URL. |
| DATEV                        | `datevlauds/lauds`                 | DATEV's [hr-exchange](https://developer.datev.de/de/product-detail/hr-exchange/1.0.0/overview). We automatically authenticate all requests and use \`[https://hr-exchange.api.datev.de/\\\{platform](https://hr-exchange.api.datev.de/\\\{platform)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | platform-sandbox}/v1/clients/\{client-id}\` as the base URL.  |
| Dayforce                     | `dayforce/V1`                      | [Dayforce's API](https://developers.dayforce.com/Build/Home.aspx). We automatically authenticate all requests and use `\{\{baseUrl\}\}/Api/\{\{clientNamespace\}\}/V1` as the base URL                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Deel                         | `deel/api`                         | Deel's [API](https://developer.deel.com/reference/). We automatically authenticate all requests using the provided credentials and use `https://\{api_domain\}/rest` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                               |
| Digital Recruiters           | `digitalrecruiters/api`            | Cegid Digital Recruiters [Talent Acquisition API](https://cegid-hr-developers.talentsoft.net/docs/tutorial-basics/Talent%20Acquisition/Getting%20Started). We automatically authenticate all requests by replacing `:token` in the request URL with your configured access token and use your configured Digital Recruiters domain as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Docebo                       | `docebo/api`                       | Docebo [API](https://developer.docebo.com). We automatically handle authentication and use `https://\{subdomain\}.docebosaas.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| Eightfold                    | `eightfold/api`                    | Eightfold's [API](https://apidocs.eightfold.ai/). We automatically authenticate all requests and use  `https://apiv2.\{region\}/api/v2/core/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Employment Hero              | `employmenthero/default`           | EmploymentHero [API](https://developer.employmenthero.com/api-references/#icon-book-open-introduction). We automatically authenticate all requests using the credentials supplied by the customer and use `https://api.employmenthero.com/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Eploy                        | `eploy/api`                        | Eploy's [API](https://www.eploy.com/resources/developers/api-documentation/). We automatically authenticate all requests. The base URL is `https://\{hostname\}/api`, where `\{hostname\}` is either `\{subdomain\}.eploy.net` or your full custom hostname when applicable.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| eRecruiter                   | `erecruiter/api`                   | [eRecruiter's API](https://api.erecruiter.net/swagger/ui/index). We automatically authenticate all requests and use `https://\{domain\}/Api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Eurécia                      | `eurecia/api`                      | Eurécia [REST API](https://api.eurecia.com/eurecia/fw/swagger/index.html#/) We automatically authenticate all requests and use `https://\{domain\}/eurecia/rest` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| Factorial                    | `factorial/api`                    | Factorial's [API](https://apidoc.factorialhr.com/). We automatically authenticate all requests and use `https://api.factorialhr.com/api` or `https://api.demo.factorial.dev/api` as the base URL, depending on the connected instance.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Flatchr                      | `flatchr/api`                      | Flatchr's [API](https://developers.flatchr.io/docs/getting_started). We automatically authenticate all requests and use `https://api.flatchr.io` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| Flatchr                      | `flatchr/career`                   | Flatchr's [Career API](https://developers.flatchr.io/docs/QuickStart/Candidats/Creer_un_candidat). We automatically authenticate all requests and use `https://career.flatchr.io` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| Fountain                     | `fountain/v2`                      | Fountain's [Hire API](https://developer.fountain.com/reference/get_v2-applicants). We automatically authenticate all requests. The base URL depends on how the integration is connected: Fountain One (OAuth) requests go to `https://services.fountain.com/api/servicehire/v2`, while legacy API-key requests go to `https://\{subdomain\}.fountain.com/api/v2`.                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| Fourth                       | `fourth/uk-employee`               | Fourth [UK Employee API](https://developer.fourth.com/en-gb/docs/uk-employee-api/reference) We automatically authenticate all requests and use `https://api.fourth.com/hr/organisations/\{organisation_id\}/` as the base URL. We also enforce the required query params for all requests.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Gem                          | `gem/api`                          | Gem's [ATS API](https://api.gem.com/ats/v0/reference) We automatically authenticate all requests and use `https://api.gem.com/ats/v0` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Google Workspace             | `googleworkspace/admin`            | [Googles's API](https://developers.google.com/admin-sdk/directory/reference/rest). We automatically authenticate all requests and use '[https://admin.googleapis.com](https://admin.googleapis.com)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                               |
| Google Workspace             | `googleworkspace/people`           | [Googles's API](https://developers.google.com/people/api/rest). We automatically authenticate all requests and use '[https://people.googleapis.com](https://people.googleapis.com)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Greenhouse (V1)              | `greenhouse/harvest-v2`            | Greenhouse [Harvest API v2](https://developers.greenhouse.io/harvest.html). We automatically authenticate all requests using the API key and use `https://harvest.greenhouse.io/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Greenhouse (V1)              | `greenhouse/harvest`               | Greenhouse [Harvest API v1](https://developers.greenhouse.io/harvest.html). We automatically authenticate all requests using the API key and use `https://harvest.greenhouse.io/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Greenhouse (V3)              | `greenhousev3/harvestv3`           | We use `https://harvest.greenhouse.io/v3` as the base URL. Find the official docs [here](https://harvestdocs.greenhouse.io/reference/).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Greenhouse Job Board         | `greenhousejobboard/boards-api`    | [Greenhouse Job Board API](https://developers.greenhouse.io/job-board). We automatically authenticate all requests and use '[https://boards-api.greenhouse.io/v1/boards/\\\{job\_board\_token\\}](https://boards-api.greenhouse.io/v1/boards/\\\{job_board_token\\})' as the base URL. Optionally, you can provide a custom job\_board\_token to use a different job board.                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Greenhouse                   | `greenhouse/harvest-v2`            | Greenhouse [Harvest API v2](https://developers.greenhouse.io/harvest.html). We automatically authenticate all requests using the API key and use `https://harvest.greenhouse.io/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Greenhouse                   | `greenhouse/harvest`               | Greenhouse [Harvest API v1](https://developers.greenhouse.io/harvest.html). We automatically authenticate all requests using the API key and use `https://harvest.greenhouse.io/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Greenhouse                   | `greenhouse/harvestv3`             | We use `https://harvest.greenhouse.io/v3` as the base URL. Find the official docs [here](https://harvestdocs.greenhouse.io/reference/).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| GuideCom                     | `guidecom/api`                     | GuideCom's API. We automatically authenticate all requests and use the configured API base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Gusto                        | `gusto/v1`                         | [Gusto API](https://docs.gusto.com/app-integrations/docs/introduction). We automatically authenticate all requests with OAuth and use `\{api_base_url\}/v1` as the base URL (`https://api.gusto.com/v1` in production, `https://api.gusto-demo.com/v1` in development).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Hailey HR                    | `haileyhr/api`                     | Hailey HR's [API](https://api.haileyhr.app/docs/index.html). We automatically authenticate all requests using the provided credentials and use `https://api.haileyhr.app` as the base URL. Connections created against the `DEMO` remote environment are routed to `https://api.demo.haileyhr.app` instead.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Hansalog                     | `hansalog/vision`                  | Hansalog's [Vision API](https://hansalog-vision.document360.io/docs/). We automatically authenticate all requests and use `https://\{subdomain\}.hansalog-cloud.de/vision` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Haufe Umantis                | `umantis/v1`                       | [Umantis API v1](https://recruitingapp-91005709.umantis.com/api/v1/swagger-ui). We automatically authenticate all requests and use `https://\{subdomain\}.umantis.com/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| HeavenHR                     | `heavenhr/v2`                      | [HeavenHR API](https://api.heavenhr.com/). We automatically authenticate all requests using the provided credentials and use `https://api.heavenhr.com/api/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Heyrecruit                   | `heyrecruit/v2`                    | [Heyrecruit's v2 API](https://documenter.getpostman.com/view/23241256/2s9YysBLcf#47e271ac-47c8-4c75-9cc6-b8c506e9dad6). We automatically authenticate all requests using the client ID and secret and use `https://app.heyrecruit.de/api/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| HiBob                        | `hibob/docs`                       | This passthrough is only used for fetching employee documents in HiBob. It is present as a workaround while we are working on a new endpoint for fetching documents in HRIS. It should not be used for any other purpose. We automatically authenticate all requests using the service user credentials and use `https://app.hibob.com/api/docs/employees/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| HiBob                        | `hibob/hire`                       | [HiBob's Hire API](https://apidocs.hibob.com/docs/how-to-integrate-with-ats-hire-api). We automatically authenticate all requests using the hire service user credentials. The base URL is configured during the integration setup.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| HiBob                        | `hibob/v1`                         | [HiBob's v1 API](https://apidocs.hibob.com/reference/get_people). We automatically authenticate all requests using the service user credentials (or, for old integrations, the API key) and use `https://api.hibob.com/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| HoorayHR                     | `hoorayhr/api`                     | [HoorayHR API](https://api.hoorayhr.io/documentation/). We automatically authenticate all requests and use `https://api.hoorayhr.io` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                               |
| HR Office                    | `hroffice/soap`                    | [HROffice SOAP API](https://api.hroffice.nl/HROfficeCoreService.asmx). We automatically authenticate all requests and wrap them in a SOAP envelope. Build the request `Body` with the raw XML parameters for your operation (e.g., `\<languageId\>1\</languageId\>`). Use `/` as your `path`. Set your `method` to `POST`. You need to specify the `api_options` object and set `operation_name` to the SOAP operation you want to call (e.g., `GetAllJobByLanguage`).                                                                                                                                                                                                                                                                                                                                              |                                                               |
| HR WORKS                     | `hrworks/v2`                       | HRWorks's v2 [API](https://developers.hrworks.de/2.0/endpoints). We automatically authenticate all requests using the customer credentials.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| HR4YOU                       | `hr4you/v2`                        | [HR4YOU's v2 API](https://apiprodemo.hr4you.org/api2/docs). We automatically authenticate all requests and use the customers provided base URL (e.g. `https://your-company.hr4you.org/` or a custom domain).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Humaans                      | `humaans/api`                      | Humaans' [API](https://docs.humaans.io/api/). We automatically authenticate all requests using the API key and use `https://app.humaans.io/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| iCIMS                        | `icims/default`                    | [iCIMS Default API](https://developer-community.icims.com/). We automatically authenticate all requests and use `https://api.icims.com/customers/\{customer_id\}` as the base url.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| InRecruiting by Zucchetti    | `inrecruiting/default`             | [inRecruiting's v3 API](https://inrecruiting.intervieweb.it/api-docs/). We automatically authenticate all requests and use the customers domain as base URL                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Insperity                    | `insperity/api`                    | Insperity [APIs](https://developer.insperity.com/) We automatically authenticate all requests and use `https://api.insperity.com` as the base URL. For staging environments, we use `https://apistage.insperity.com`. Note that all requests require the company ID to be specified in the path or body.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| IRIS Cascade                 | `iriscascade/v2`                   | IRIS Cascade HR [API](https://swagger.hrapi.co.uk/). We automatically authenticate all requests using the provided credentials and use `https://api.iris.co.uk/hr/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| JazzHR                       | `jazzhr/v1`                        | [JazzHR's v1 API](https://www.resumatorapi.com/v1/#!`).We automatically authenticate all requests and use "[https://api.resumatorapi.com/v1/](https://api.resumatorapi.com/v1/)" as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| JobAdder                     | `jobadder/api`                     | We use `https://api.jobadder.com/v2` as the base URL. Find the official docs [here](https://api.jobadder.com/v2/docs).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| JobDiva                      | `jobdiva/api`                      | We automatically authenticate all requests and use `https://api.jobdiva.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Jobvite                      | `jobvite/api`                      | We automatically authenticate all requests and use '[https://api.jobvite.com/api/v2](https://api.jobvite.com/api/v2)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Jobvite                      | `jobvite/v2`                       | We use `https://api.jobvite.com/api/v2` as the base URL. Find the official docs [here](https://help.jobvite.com/hc/en-us/articles/8870636608925-Jobvite-API).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Jobylon                      | `jobylon/feed`                     | The [Jobylon Feed API](https://developer.jobylon.com/feed-api/). We automatically authenticate all requests and use `https://\{subdomain\}.jobylon.com/feeds/\{job_hash\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Jobylon                      | `jobylon/push`                     | The [Jobylon Push API](https://developer.jobylon.com/push-api-and-webhooks/). We automatically authenticate all requests and use `https://\{subdomain\}.jobylon.com/p1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| JOIN                         | `join/v2`                          | Join's [V2 API](https://docs.join.com/reference/getting-started). We automatically authenticate all requests and use `https://api.join.com/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Kenjo                        | `kenjo/api`                        | Kenjo's [API](https://kenjo.readme.io/reference/generate-the-api-key). We automatically authenticate all requests using the API key. The base URL is `https://api.kenjo.io/` (or `https://sandbox-api.kenjo.io/` for sandbox environments).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Kula                         | `kula/v1`                          | Kula's [REST API](https://developers.kula.ai/docs/getting-started/overview). We automatically authenticate all requests with the provided credentials and use `https://api.kula.ai/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Lattice Talent               | `latticetalent/talent`             | Lattice's [Talent API](https://developers.lattice.com/reference/introduction). We automatically authenticate all requests using API key credentials with `https://api.latticehq.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                               |
| Lattice                      | `lattice/passthrough`              | Lattice's [API](https://developers.lattice.com/v2/docs/base-url-1). We automatically authenticate all requests using OAuth credentials with `https://api.latticehq.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Lattice                      | `lattice/talent`                   | Lattice's [Talent API](https://developers.lattice.com/docs/introduction-1). We automatically authenticate all requests using OAuth credentials with `https://api.latticehq.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| Laura                        | `laura/api`                        | We automatically authenticate all requests and use `https://\{subdomain\}.rekrytointi.com/api/v1.2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Leapsome                     | `leapsome/scim`                    | Leapsome [SCIM API](https://api.leapsome.com/scim/v1/api-docs/). We automatically authenticate all requests using the credentials supplied by the customer and use `https://api.leapsome.com/scim/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Leapsome                     | `leapsome/v1`                      | Leapsome [API](https://api.leapsome.com/v1/api-docs/). We automatically authenticate all requests using the credentials supplied by the customer and use `https://api.leapsome.com/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Lever                        | `lever/v1`                         | [Lever's v1 API](https://hire.lever.co/developer/documentation). We automatically authenticate all requests using the partner credentials which have been configured in the Lever tool settings (this uses Kombo's partner credentials by default).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| LinkedIn Learning            | `linkedinlearning/v2`              | LinkedIn Learning [API v2](https://learn.microsoft.com/en-us/linkedin/learning/).  We automatically handle authentication and use `https://api.linkedin.com/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| Logic Melon                  | `logicmelon/json`                  | We use `https://api.logicmelon.co.uk` as the base URL. Find the official docs [here](https://api.logicmelon.com/JSON/Multiposter.asmx).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Loket                        | `loket/api`                        | [Loket's REST API](https://developers.loket.nl/). We automatically authenticate all requests and use `https://\{api_domain\}` as the base URL, where `api_domain` is the API domain configured during integration setup (e.g. `api.loket.nl`).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Loxo                         | `loxo/v1`                          | [Loxo's API](https://loxo.readme.io/reference/loxo-api). We automatically authenticate all requests and use '[https://app.loxo.co/api/\\\{agency\_slug\\}](https://app.loxo.co/api/\\\{agency_slug\\})' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Lucca                        | `lucca/api`                        | [Luccas's API](https://developers.lucca.fr/api-reference/legacy/introduction). We automatically authenticate all requests and use 'https\://\{account}.\{ilucca                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | ilucca-demo}.\{region}/' as the base URL.                     |
| Manatal                      | `manatal/career-page`              | Manatal's Career Page API. We use `https://api.manatal.com/open/v3/career-page/\{client_slug\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| Manatal                      | `manatal/open-api-v3`              | [Manatal's Open API v3](https://developers.manatal.com/reference/getting-started). We automatically authenticate all requests and use `https://api.manatal.com/open/v3` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Mercury                      | `mercury/v1`                       | Mercury's [V1 API](https://apim-uks-thirdpartyintegration-prod.azure-api.net/swagger/index.html?urls.primaryName=V1). We automatically authenticate all requests with the `subscription-key` and `tenant-id` headers and use the configured server URL with `/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Mercury                      | `mercury/v2`                       | Mercury's [V2 API](https://apim-uks-thirdpartyintegration-prod.azure-api.net/swagger/index.html?urls.primaryName=V2). We automatically authenticate all requests with the `subscription-key` and `tenant-id` headers and use the configured server URL with `/api/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Mercury                      | `mercury/v3`                       | Mercury's [V3 API](https://apim-uks-thirdpartyintegration-prod.azure-api.net/swagger/index.html?urls.primaryName=V3). We automatically authenticate all requests with the `subscription-key` and `tenant-id` headers and use the configured server URL with `/api/v3` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| MHR People First             | `peoplefirst/v1`                   | MHR People First [v1 API](https://docs.people-first.com/api/api-docs/api-docs.html). We automatically authenticate all requests using the access token and tenant/environment codes. For default environments, we use `https://\{tenant_code\}.people-first.com/api/v1` as the base URL. For non-default environments, we use `https://\{tenant_code\}-\{environment_code\}.people-first.com/api/v1`.                                                                                                                                                                                                                                                                                                                                                                                                               |                                                               |
| Microsoft Azure AD           | `azuread/v1`                       | [AzureAD's API](https://learn.microsoft.com/en-us/graph/api/resources/identity-network-access-overview?view=graph-rest-1.0). We automatically authenticate all requests.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Microsoft Entra ID           | `entraid/v1`                       | [AzureAD's API](https://learn.microsoft.com/en-us/graph/api/resources/identity-network-access-overview?view=graph-rest-1.0). We automatically authenticate all requests.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Moodle                       | `moodle/rest`                      | Moodle REST Web Services API. All calls go to `/webservice/rest/server.php` with `wsfunction` and `wstoken` parameters. We automatically handle authentication and use `\{site_url\}/webservice/rest/server.php` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| Mysolution                   | `mysolution/default`               | [Mysolution's API](https://swagger.mysolution.nl/). We automatically authenticate all requests and use the customer's domain as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Nmbrs                        | `nmbrs/soap`                       | [Nmbrs SOAP API](https://api.nmbrs.nl/soap/v3/). We automatically authenticate all requests and use `https://api.nmbrs.nl/soap/v3/` as the base URL. Set `data` to your raw XML string (the content that will be placed inside the `\<soap:Body\>` tag). Use `/` as your `path`, as we will always send requests to `https://api.nmbrs.nl/soap/v3/\{service_name\}.asmx`. Set your `method` to `POST`. You need to specify the `api_options` object and set `service_name` to the name of the service you want to call. Available services include `EmployeeService` and `CompanyService`.                                                                                                                                                                                                                          |                                                               |
| Odoo                         | `odoo/json2`                       | Odoo's [JSON-2 API](https://www.odoo.com/documentation/19.0/developer/reference/external_api.html). We automatically authenticate all requests and use `https://\{domain\}.odoo.com/json/2` as the base URL. Odoo JSON-2 requests are always `POST` requests and use paths like `/\{model\}/\{method\}` (e.g. `/res.partner/search_read`).                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Okta                         | `okta/v1`                          | [Okta's API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/ApiServiceIntegrations/). We automatically authenticate all request ans use 'https\://\<your-okta-domain>/api/v1' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Onlyfy                       | `onlyfy/v1`                        | Onlyfy's [Public v1 REST API](https://onlyfy.io/doc/v1#section/Introduction). We automatically authenticate all requests using the `apikey` header and use `https://api.prescreenapp.io/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Oracle HCM                   | `oraclehcm/api`                    | Oracle HCM Cloud [REST API](https://docs.oracle.com/en/cloud/saas/human-resources/24d/farws/index.html). We automatically authenticate all requests and use `https://\{domain\}/` as the base URL, where domain is your Oracle Cloud domain.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Oracle Recruiting Cloud      | `oraclerecruiting/rest`            | [Oracle's REST API](https://docs.oracle.com/en/cloud/saas/human-resources/24d/farws/rest-endpoints.html). We automatically authenticate all requests and use 'https\://\{company\_url}' as the base url.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Oracle Recruiting Cloud      | `oraclerecruiting/rest`            | [Oracles's REST API](https://docs.oracle.com/en/cloud/saas/human-resources/24d/farws/rest-endpoints.html). We automatically authenticate all requests and use 'https\://\{company\_url}' as the base url.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Oracle Taleo                 | `taleo/soap`                       | [Taleo's API](https://docs.oracle.com/en/cloud/saas/taleo-enterprise/23b/otwsu/c-taleoapi.html). We automatically authenticate all requests and use 'https\://\{your-subdomain}.taleo.net/enterprise/soap' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| OTYS                         | `otys/json-rpc`                    | [OTYS JSON-RPC API](https://ows.otys.nl/info/). We authenticate with your stored API key and inject the session token as the first element of the JSON-RPC `params` array on each request (except `loginByUid`, which uses `params` as sent). Requests use `https://ows.otys.nl` as the base URL (for example `POST /jservice.php` with the RPC method in the URL fragment, matching OTYS conventions).                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| PageUp People                | `pageup/v1`                        | We use `https://assessment-mock-api.dc0.pageuppeople.com` as the base URL. Find the official docs [here](https://developers.pageuppeople.com/Api/Partners/Assessment).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| PageUp People                | `pageup/v3`                        | We use `https://\<environment\>.\<dataCentreId\>.pageuppeople.com/v3/\<tenantId\>/recruitment` as the base URL. Find the official docs [here](https://developers.pageuppeople.com/Api/Recruitment).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Paradox                      | `paradox/v1`                       | We use `\{api_url\}/api/v1` as the base URL. Find the official docs [here](https://paradox.readme.io/).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Paradox                      | `paradox/v1public`                 | We use `\{api_url\}/api/v1/public` as the base URL. Find the official docs [here](https://paradox.readme.io/).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Paychex                      | `paychex/api`                      | Paychex [REST API](https://developer.paychex.com/documentation). We automatically authenticate all requests and use `https://api.paychex.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Paycom                       | `paycom/v1`                        | Paycom's REST API. We automatically authenticate all requests using the provided SID and API Token and use `https://api.paycomonline.net/v4/rest/index.php/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Paycor                       | `paycor/v1`                        | [Paycors's v1 API](https://developers.paycor.com/explore#section/Getting-Started). We automatically authenticate all requests and use '[https://apis.paycor.com](https://apis.paycor.com)'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| PayFit                       | `payfitcustomer/api`               | PayFit [Partner API](https://developers.payfit.io/reference). We automatically authenticate all requests using the provided API key and use `https://partner-api.payfit.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| PayFit                       | `payfitpartner/partner-api`        | PayFit [Partner API](https://developers.payfit.io/reference). We automatically authenticate all requests using the OAuth access token and use `https://partner-api.payfit.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Paylocity                    | `paylocity/default`                | [Paylocity's Weblink API](https://developer.paylocity.com/integrations/reference/authentication-weblink). We automatically authenticate all requests and use 'https\://\{api                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | dc1demogw}.paylocity.com/' as the base URL.                   |
| Paylocity                    | `paylocity/next-gen`               | [Paylocity's NextGen API](https://developer.paylocity.com/integrations/reference/authentication). We automatically authenticate all requests and use '[https://dc1prodgwext.paylocity.com/](https://dc1prodgwext.paylocity.com/)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |                                                               |
| PeopleHR                     | `peoplehr/default`                 | [PeopleHR's API](https://apidocs.peoplehr.com/#). We automatically authenticate all request ans use '[https://api.peoplehr.net](https://api.peoplehr.net)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| PeopleXD                     | `peoplexd/b2b`                     | PeopleXD's [B2B API](https://documenter.getpostman.com/view/3101638/TzeTHUDu#intro). We automatically authenticate all requests and use `https://api.corehr.com/ws/\{tenant_id\}/corehr` or `https://uatapi.corehr.com/ws/\{tenant_id\}/corehr` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| Personio                     | `personio/jobboard`                | API endpoints exposed on Personio's public job board pages ([currently just the XML feed](https://developer.personio.de/reference/get_xml)). We automatically use the right `https://\{company\}.jobs.personio.de` base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Personio                     | `personio/personnel`               | Personio's [Personnel Data API](https://developer.personio.de/reference/get_company-employees). We automatically authenticate all requests using the client ID and secret and use `https://api.personio.de/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                               |
| Personio                     | `personio/personnelv2`             | Personio's [V2 Personnel Data API](https://developer.personio.de/v2.0/reference/introduction). We automatically authenticate all requests using the client ID and secret and use `https://api.personio.de/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Personio                     | `personio/recruiting`              | Personio's [Recruiting API](https://developer.personio.de/reference/get_company-employees). We automatically authenticate all requests using the Recruiting access token and use `https://api.personio.de/v1/recruiting` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Personio                     | `personio/recruitingV2`            | Personio's [V2 Recruiting API](https://developer.personio.de/reference/get_v2-recruiting-applications). We automatically authenticate all requests using the Recruiting access token, send the `Beta` header and use `https://api.personio.de/v2/recruiting` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Phenom                       | `phenom/rest-api`                  | The [Phenom API](https://developer.phenom.com/). We automatically authenticate all requests and use `https://api-stg.phenompro.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Pinpoint                     | `pinpoint/v1`                      | Pinpoint's [JSON:API](https://developers.pinpointhq.com/docs). We automatically authenticate all requests using the `X-API-KEY` header and use `https://\{subdomain\}.pinpointhq.com/api/v1` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Planday                      | `planday/api`                      | Planday's [HR API v1.0](https://openapi.planday.com/api/hr?version=v1.0). We automatically authenticate all requests and use `https://openapi.planday.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Recruit CRM                  | `recruitcrm/api`                   | We use `https://api.recruitcrm.io` as the base URL. Find the official docs [here](https://docs.recruitcrm.io/docs/rcrm-api-reference/ZG9jOjMyNzk0NA-getting-started).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                               |
| RecruiterFlow                | `recruiterflow/v1`                 | RecruiterFlow API [docs](https://docs.recruiterflow.com/). We automatically authenticate all requests using the RF-Api-Key header and use `https://api.recruiterflow.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Remote                       | `remotecom/default`                | Remote's [API](https://remote.com/resources/api/getting-started). We automatically authenticate all requests using provided credentials. The base URL is `https://gateway.remote.com/v1` for production API keys (prefixed `ra_live_`), or `https://gateway.remote-sandbox.com/v1` for sandbox API keys.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| rexx systems                 | `rexx/default`                     | Rexx's HRIS export API. There is only one endpoint: `Get /`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                               |
| Rippling                     | `rippling/api`                     | Rippling's [API](https://developer.rippling.com/documentation). We automatically authenticate all requests and use `https://api.rippling.com/platform/api` or`https://rest.ripplingapis.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Sage HR                      | `sagehr/api`                       | Sage HR's [API](https://developer.sage.com/hr/reference/api-ref). We automatically authenticate all requests and use `https://\{subdomain\}.sage.hr/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Sage People                  | `sagepeople/salesforce-rest-api`   | Sage People is built on Salesforce's [API](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_what_is_rest_api.htm). We automatically authenticate all requests and use `https://\{customer_name\}.my.salesforce.com/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| SAP SuccessFactors           | `successfactors/lms-odata-v4`      | We use `https://\{api_domain\}/learning/odatav4` as the base URL. Find the official docs [here](https://help.sap.com/docs/successfactors-learning/sap-successfactors-learning-odata-apis).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| SAP SuccessFactors           | `successfactors/odata-v2`          | [SuccessFactors' OData V2 API](https://help.sap.com/doc/74597e67f54d4f448252bad4c2b601c9/2211/en-US/SF_HCM_OData_API_REF_en.pdf). We automatically authenticate all requests and use `https://\{api_domain\}\{path?\}/odata/v2` as the base URL (the optional `\{path\}` is used when connecting via proxied/gateway domains).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| SD Worx                      | `sdworx/default`                   | SD Worx's [OData API](https://apistaging.cobra.sdworx.com/Resources). We automatically authenticate all requests using the client ID and secret and use `\{api_url\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Silae                        | `silae/rest`                       | [Silae's REST API](https://silae-api.document360.io/docs). We automatically authenticate all requests and use '[https://payroll-api.silae.fr/payroll](https://payroll-api.silae.fr/payroll)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Simployer                    | `simployer/v1`                     | [AlexisHR's v1 API](https://docs.alexishr.com/) We automatically authenticate all requests and use `https://\{subdomain\}.alexishr.com` as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| SmartRecruiters              | `smartrecruiters/default`          | Smartrecruiters [API](https://developers.smartrecruiters.com/reference/apply-api). We automatically authenticate all requests using OAuth and use `https://api.smartrecruiters.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| SmartRecruiters              | `smartrecruiters/default`          | Smartrecruiters [API](https://developers.smartrecruiters.com/reference/apply-api). We automatically authenticate all requests using the credentials supplied by the customer and use `https://api.smartrecruiters.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Softgarden                   | `softgarden/apply-api`             | [Softgarden's Apply API](https://dev.softgarden.de/apply-api/). We automatically authenticate all requests and use '[https://jobdb.softgarden.de/jobdb/public](https://jobdb.softgarden.de/jobdb/public)' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Softgarden                   | `softgarden/frontend-v3`           | \[Softgarden's Frontend API v3]\([https://dev.softgarden.de/frontend-v3/](https://dev.softgarden.de/frontend-v3/). We automatically authenticate all requests and use '[https://api.softgarden.io/api/rest](https://api.softgarden.io/api/rest)' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Spark Hire Recruit           | `comeet/api`                       | [Spark Hire Recruit's API.](https://developers.comeet.com/reference/recruiting-api-overview)We automatically authenticate all requests and use `https://api.comeet.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Spott                        | `spott/protected`                  | The [Spott API](https://docs.gospott.com). We automatically authenticate all requests and use `https://api.gospott.com` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Sympa                        | `sympa/api`                        | Sympa's [API](https://documenter.getpostman.com/view/33639379/2sA3kXG1vX#intro). We automatically authenticate all requests and use `https://api.sympahr.net/api/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| Taleez                       | `taleez/0`                         | [Taleez's API](https://api.taleez.com/swagger-ui/index.html). We automatically authenticate all requests and use `https://api.taleez.com/0` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Talention                    | `talention/v1`                     | Talention's API. We automatically authenticate all requests and use `https://\{api_domain\}/tms/\{account_id\}/external/api/1.0` as the base URL. Documentation is provided privately by Talention. Contact Kombo support for assistance with specific endpoints.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |
| TalentLMS                    | `talentlms/v2`                     | We use `https://\{subdomain\}.talentlms.com/api/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Teamtailor Job Boards        | `teamtailorjobboards/direct-apply` | Teamtailor's [Job Board Direct Apply API](https://partner.teamtailor.com/job_boards/direct_apply/#direct-apply). We automatically authenticate all requests and use `https://5qbn6o9x4h.execute-api.eu-west-1.amazonaws.com/production` as the base URL. All requests are automatically signed with HMAC-SHA256 signature.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| Teamtailor                   | `teamtailor/v1`                    | We use `https://api.teamtailor.com/v1` as the base URL. Find the official docs [here](https://docs.teamtailor.com/).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                               |
| Tellent Recruitee            | `recruitee/default`                | The [Recruitee API](https://api.recruitee.com/docs/index.html). We automatically authenticate all requests and use `https://api.recruitee.com/c/\{company_id\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| Tellent Recruitee            | `recruitee/v1`                     | We use `https://api.recruitee.com/c/\{company_id\}` as the base URL. Find the official docs [here](https://docs.recruitee.com/reference).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| TrackerRMS                   | `trackerrms/v1`                    | We use `https://evousapi.tracker-rms.com` as the base URL. Find the official docs [here](https://evousapi.tracker-rms.com/swagger/index.html).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| TRAFFIT                      | `traffit/v2`                       | Traffit's [v2 API](https://api.traffit.com). We authenticate all requests with the Traffit API key and use the base URL `https://yourdomain.traffit.com/api/integration/v2`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| TriNet PEO                   | `trinetpeo/v1`                     | We use `https://api.trinet.com` as the base URL. Find the official docs [here](https://developers.trinet.com).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Ubeeo                        | `ubeeo/api`                        | Ubeeo ATS API. We automatically authenticate all requests using OAuth client credentials and use `https://api.ats-platform.com` as the base URL (sandbox: `https://api.acc.ats-platform.com`).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| Udemy Business               | `udemy/learning`                   | Udemy Business REST API. We automatically handle authentication and use `https://\{account_name\}.udemy.com/api-2.0/organizations/\{account_id\}/` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                               |
| UKG Pro WFM                  | `ukgprowfm/api`                    | UKG Pro WFM's [API](https://developer.ukg.com/wfm/reference/welcome-to-the-ukg-pro-workforce-management-api). We automatically authenticate all requests and use `https://\{hostname\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| UKG Pro                      | `ukgpro/default`                   | [UKG Pro's HRIS API](https://developer.ukg.com/hcm/reference/get_personnel-v1-person-details). We automatically authenticate all requests and use  `https://\{hostname\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                               |
| UKG Pro                      | `ukgpro/recruting`                 | [UKG Pro's Recruiting API](https://developer.ukg.com/hcm/reference/retrieveapplications). We automatically authenticate all requests and use  `https://\{hostname\}/talent/recruiting/v2/\{tenantalias\}/api` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                               |
| UKG Ready                    | `ukgready/api`                     | UKG Ready [API](https://secure.saashr.com/ta/docs/rest/public/). We automatically authenticate all requests using the provided credentials and use `https://\{api_domain\}` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Visma Peple                  | `peple/hrm`                        | [Visma Payroll Reporting API](https://api.analytics1.hrm.visma.net/docs/openapi.html). We automatically authenticate all requests using the client credentials and use '[https://api.analytics1.hrm.visma.net](https://api.analytics1.hrm.visma.net)' as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Visma Raet - Youforce        | `youforce/v1.0`                    | [Youforce's basic v1.0 API](https://vr-api-integration.github.io/youforce-api-documentation/postman_collections.html). We automatically authenticate all requests and use '[https://api.youforce.com](https://api.youforce.com)' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Visma YouServe               | `youserve/learning`                | Visma YouServe [Learning API](https://youserve-domain-api.github.io/SwaggerUI/learning.html). We automatically authenticate all requests using OAuth 2.0 with the provided credentials and use `https://api.youserve.nl/learning/v1.0` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                               |
| Workable                     | `workable/v1`                      | **Deprecated: Use `v3` instead.** Workable's [API](https://workable.readme.io/reference/generate-an-access-token). We automatically authenticate all requests using the client ID and secret and use `https://\{subdomain\}.\{environment\}.com/spi/v3` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                                               |
| Workable                     | `workable/v3`                      | Workable's [API](https://workable.readme.io/reference/generate-an-access-token). We automatically authenticate all requests using the client ID and secret and use `https://\{subdomain\}.\{environment\}.com/spi/v3` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Workday                      | `workday/custom-report`            | [Workday's Custom Reports](https://community.workday.com/sites/default/files/file-hosting/productionapi/index.html). We automatically authenticate all requests and use `https://\{domain\}/ccx/service/customreport2/\{tenant\}/` as the base URL. Set your `method` to `GET`. The `path` should be the report path after the tenant, e.g., `/\{report_owner\}/\{report_name\}`. You can include query parameters in the `params` object (e.g., `format=json`).                                                                                                                                                                                                                                                                                                                                                    |                                                               |
| Workday                      | `workday/rest`                     | [Workday's REST API](https://community.workday.com/sites/default/files/file-hosting/restapi/index.html). We automatically authenticate all requests and use the correct Workday REST base URL for your tenant. The base URL follows the format: https\://\{domain}/api/\{service\_name}/\{version}/\{tenant}. You can specify any valid REST endpoint and method. See the Workday REST API documentation for available endpoints. You must specify the `api_options` object and set `service_name` to the name of the service you want to call. You can also specify the `version` (e.g., "v1", "v2"); if omitted, it defaults to "v1".                                                                                                                                                                             |                                                               |
| Workday                      | `workday/soap`                     | [Workday's SOAP API](https://community.workday.com/sites/default/files/file-hosting/productionapi/index.html). We automatically authenticate all requests. Set `data` to your raw xml string. Use `/` as your `path`, as we will always send requests to `https://\{domain\}/ccx/service/\{tenant\}/\{service_name\}`. Set your `method` to `POST`. You need to specify the `api_options` object and set `service_name` to the name of the service you want to call. Find all available services [here](https://community.workday.com/sites/default/files/file-hosting/productionapi/versions/v41.0/index.html). The string that you submit as `data` will be the content of the `soapenv:Body` tag in the request. You can set the `service_version` to any valid Workday service version (the default is `38.2`). |                                                               |
| workforce.com                | `workforcecom/api`                 | Workforce.com [API](https://my.workforce.com/api/v2/documentation). We automatically authenticate all requests using the provided credentials and use `https://my.tanda.co` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                               |
| Zelt                         | `zelt/partner`                     | Zelt's [Partner API](https://go.zelt.app/apiv2/swagger). We automatically authenticate all requests using the connected OAuth credentials and use `https://go.zelt.app/apiv2/partner` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                               |
| Zoho Recruit                 | `zohorecruit/v2`                   | Zoho Recruit's [V2 API](https://www.zoho.com/recruit/developer-guide/apiv2/modules-api.html). We automatically authenticate all requests and use `https://recruit.\{domain\}/recruit/v2` as the base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                               |
| Zvoove Recruit               | `zvooverecruit/applicants`         | [Zvoove Recruit's Applicants API](https://api.zvoove.com/docs/). We automatically authenticate all requests using the applicants API key and use 'https\://\{domain}/api/public' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                               |
| Zvoove Recruit               | `zvooverecruit/jobs`               | [Zvoove Recruit's Jobs API](https://api.zvoove.com/docs/). We automatically authenticate all requests using the jobs API key and use 'https\://\{domain}/api/public' as base URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                               |

<Note>Please note that the passthrough API endpoints are only meant for edge cases. That's why we only expose them for new integrations after understanding a concrete customer use case. If you have such a use case in mind, please reach out to Kombo.</Note>


# Set integration enabled
Source: https://docs.kombo.dev/lms/v1/put-integrations-integration-id-enabled

PUT /integrations/{integration_id}/enabled
Enable or disable the specified integration. When disabling, all currently running syncs will be cancelled.

All authentication credentials and configuration are preserved. Syncs can be resumed by re-enabling the integration.

You may use this to, for example, pause syncing for customers that are temporarily not using the integration.


# Product Capabilities & Clarifications
Source: https://docs.kombo.dev/misconceptions-and-clarifications

_Last updated: March 30, 2026._

There are many misconceptions shared about what Kombo does and how it works. This page provides the facts, with links to official docs and case studies.

## Myth 1: Does Kombo store data?

### Answer

Yes. Kombo stores data to deliver faster API responses, critical features like
filtering, change tracking, deletion tracking, and reliability during upstream
outages. This approach has become the preferred option for companies connecting
enterprise clients with high-volume, fast-moving data.

### Why this matters

* **Performance:** Kombo uses local caches and “updated-after” timestamps to
  fetch only what changed since the last sync. Customers avoid building complex
  caching logic and reduce infrastructure load by up to 95%.
* **Advanced features:** Cached data powers real-time webhooks, multi-field
  filtering, comprehensive change and deletion tracking, and detailed error
  reporting during syncs to identify issues quickly.
* **Resilience:** If upstream systems like Workday or BambooHR experience
  outages, Kombo continues to serve the latest cached data. Applications keep
  running while Kombo retries in the background.

### Proof

* [Docs: Fetching Data](/ats/getting-started/fetching-data)
* [Docs: Filtering](/hris/features/filtering/introduction)
* [Docs: Delta Sync](/ats/guides/sync#delta-syncs)
* [Docs: Audit logs](/ats/features/audit-logs)
* [Docs: Logs](/ats/features/logs)
* [Case study:
  Classet](https://www.kombo.dev/case-study/how-classet-built-their-real-time-phone-screening-with-kombo)

## Myth 2: Is Kombo focused on European integrations?

### Answer

No. Kombo has the widest ATS and HRIS coverage in the U.S., with most of its
customers based there. It has built out the widest ATS and HRIS coverage for the
U.S., integrating with systems like iCIMS, UKG Pro, Fountain, ADP Workforce Now,
Paylocity, and many more.

### Proof

* [Docs: iCIMS](/ats/connectors/icims)
* [Docs: UKG Pro](/ats/connectors/ukgpro)
* [Docs: Fountain](/ats/connectors/fountain)
* [Docs: ADP Workforce Now](/hris/connectors/adpworkforcenow)
* [Docs: Paylocity](/hris/connectors/paylocity)

## Myth 3: Is Kombo a European company?

### Answer

No, Kombo is a global company with offices in New York and Berlin.

### Proof

[About Kombo](http://kombo.dev)

[Official Imprint](https://www.kombo.dev/imprint)

## Myth 4: Does Kombo support real-time data sync?

### Answer

Yes, Kombo combines native webhooks where supported with high-frequency delta
syncs for systems that don't offer webhooks. Especially for high-volume use
cases, this is the preferred approach by end-customers, as it allows for
processing operations near-real time without introducing a lot of load to the
system.

### Proof

* [Docs: Real-time data](/ats/features/real-time-data)
* [Case study:
  Classet](https://www.kombo.dev/case-study/how-classet-built-their-real-time-phone-screening-with-kombo)

## Myth 5: Does Kombo support webhooks?

### Answer

Yes. Kombo provides webhook support for integrating real-time events.

### Proof

* [Docs: Webhooks guide](/ats/guides/webhooks#webhooks)
* [Case study:
  Ribbon](https://www.kombo.dev/case-study/how-ribbon-won-enterprise-deals-with-kombos-ats-coverage)

## Myth 6: Do end customers want to connect with a middleware like Kombo?

### Answer

Yes. Kombo has connected over 20,000 end customers and some of the most
security-conscious Fortune 500 companies, including some of the largest strategy
consultancies, automotive, manufacturing, and retail companies worldwide.

### Proof

• [Case study:
Ravio](https://www.kombo.dev/case-study/how-ravio-built-their-compensation-analytics-platform-with-kombo)

## Myth 7: Can you customize beyond standard data models with Kombo?

### Answer

Yes. Kombo supports adding new fields to the standard models via custom fields
and a passthrough API for integration-specific features and edge cases.

### Proof

* [Docs: Passthrough guide](/ats/features/passthrough-api)
* [Docs: Custom fields](/ats/features/custom-fields)


# Permissions and scopes
Source: https://docs.kombo.dev/permissions-and-scopes

Customize the data that is being synced by Kombo.

### Only sync the data you need

By default, Kombo syncs all available data from connected systems. This can be pretty convenient for exploring what’s available during development, but as soon as you take Kombo into production, you’ll likely want to restrict what data is extracted and stored for privacy and security reasons.

For this purpose, Kombo provides what we call [Scopes](/hris/features/scopes). These allow you to configure precisely which models and data points are being extracted and stored. Scopes can, for example, be used to anonymize data by removing all personally identifiable information from the data we store.

<Frame>
  <img alt="1464" />
</Frame>

### How it works

When your customer connects to your product using Kombo Connect and is prompted to create credentials, we dynamically let them know which permissions to set based on your configured scope config.

We allow you to define the scope config on a per-field level. This way, your customers can see exactly which data points you’re accessing, and you can build trust and eradicate concerns during the sales process. We always request as little permissions as possible.


# Reading and writing data
Source: https://docs.kombo.dev/reading-and-writing-data

How you send requests to Kombo

### Fetching Data

Kombo reads data from your connected HR systems in regular intervals.
This ensures that you will always have a reliable data source, whether your customer is using a modern,
well-kept HR system or a legacy system with irregular downtimes.

Our API is designed to enable you to keep your data source up-to-date and as effectively as possible.
[Listen to our webhooks](/hris/getting-started/fetching-data#listening-to-data-changed-webhook) and [filter purely based on the changed data](/hris/getting-started/querying-api#filtering).
You'll receive all data in the unified model, meaning you only have to integrate once.

### Writing data

You will also format your request data using our unified model when writing to an HR system via Kombo to ensure that you don't have to worry about tool-specific differences when writing data either.
For tools that require additional fields, we dynamically generate [remote fields](/hris/features/remote-fields).

### Further resources

Explore our further resources to dive deeper:

<CardGroup>
  <Card title="Querying the API" icon="magnifying-glass" href="/hris/getting-started/querying-api">
    Learn how to filter and paginate the Kombo `GET` endpoints.
  </Card>

  <Card title="Fetching Data" icon="download" href="/hris/getting-started/fetching-data">
    Learn how to efficiently keep data in your system up-to-date.
  </Card>

  <Card title="Official SDKs" icon="code" href="/libraries-and-sdks">
    Use our official SDKs for ergonomic and type-safe API interactions.
  </Card>
</CardGroup>


# Support
Source: https://docs.kombo.dev/support

Be an expert in every tool you offer

### Getting an account

Kombo does not offer self-serve signup. If you'd like to try Kombo or see a
demo, [book a call with us](https://www.kombo.dev/demo).

### Reaching us

All Kombo plans include unlimited Slack and email support. As a customer, you
have access to a **shared Slack or Teams channel** that is set up during
onboarding. This is the fastest way to get help with implementation questions,
tool-specific behavior, or debugging.

If you don't have access to the shared channel yet, reach out to
[support@kombo.dev](mailto:support@kombo.dev).

### Resources

With how diverse HR tools can be, we've learned that we should document as many
of these differences as possible. On a per-tool basis, Kombo provides detailed
guides for your customers to follow while connecting to your product; guides
specific to your use case (for example, for ATS systems, knowing where to find
the candidate source); a list of tool-specific limitations; and any other
miscellaneous learnings that we've made with the tool, to enable you to
integrate with confidence.

<CardGroup>
  <Card title="How do we prioritize Support Requests?" icon="ranking-star" href="/support/how-we-prioritize-support-requests">
    Guidelines for selecting P0–P3 based on business impact and urgency.
  </Card>

  <Card title="The Dashboard" icon="house" href="/the-dashboard">
    List integrations, configure scopes, view logs, and manage webhooks.
  </Card>

  <Card title="Implementing new tools" icon="circle-info" href="/hris/guides/implementing-new-tools">
    Best practices when rolling out new integrations.
  </Card>
</CardGroup>


# How do we prioritize Support Requests?
Source: https://docs.kombo.dev/support/how-we-prioritize-support-requests



We prioritize support tickets based on **business impact and urgency**.

The issue may be treated differently depending on your use case, timing, and
scope of impact. For example:

* A temporary sync delay may be low impact in one workflow, but business-critical
  in another.
* A minor data issue could affect a single user or scale across hundreds of
  employees.
* A request may be low urgency today, but critical if tied to an upcoming
  go-live.

We encourage you to select the priority that best reflects **the impact on your
business**, using the guidelines below. While priority is primarily driven by
your reported impact, we also consider:

* **Scope of impact**
* **Type of issue** (tool-wide, environment-specific, or isolated)
* **Customer commitments and contractual agreements**

This ensures we respond effectively to issues that may have broader system-wide
implications. This means that our Support team will review the priority selected
and we may also reclassify tickets to ensure consistent prioritization across all
customers.

## Priority Levels

### P0 – Urgent (Critical Business Impact)

**Only use this when your business operations are critically blocked or at risk.
This will trigger an alert to our Engineer on-call so we can provide a first
response as quickly as possible.**

* Complete loss of production service or core functionality and no workaround
  available
* Significant business impact (e.g. revenue loss, operational halt, failed
  go-live)
* Multiple Integrations/Connections impacted
* Critical integrations are unavailable or failing
* Time-sensitive situations where delays are unacceptable (e.g. imminent go-live
  or deadline)

### P1 – High (Significant Impact)

**Use this when functionality is seriously degraded, but operations can continue
in a limited way.**

* Core functionality is impaired
* Key features are unreliable or partially failing
* Important Integrations/Connections or key workflows are affected
* Workarounds exist but are not sustainable
* Risk of escalation or missed deadlines if not resolved quickly

### P2 – Medium (Moderate Impact)

**Use this when the issue affects non-critical functionality or has a manageable
workaround.**

* Partial loss of functionality
* Limited impact on workflows or users
* Workarounds allow business operations to continue
* No immediate deadline pressure

### P3 – Low (Minimal Impact / Requests)

**Use this for minor issues, general questions, or feature requests.**

* No meaningful impact on business operations
* Cosmetic issues or usability improvements
* Feature Requests
* "How-to" questions

If you're unsure which priority to select, we recommend choosing the lower
priority and providing additional context. Our team will review and adjust as
needed.


# The dashboard
Source: https://docs.kombo.dev/the-dashboard

Your hub for developing and configuring your integrations

### Integrations

Your dashboard contains a list of all your integrations. At a glance, we provide an overview of each integration's individual [state](/hris/guides/integration-states) and any open [issues](/hris/features/issues), so you can see if everything is running smoothly. You can also click on an integration for additional configuration, such as filtering which employees are synced in the case of HRIS systems.

<Frame>
  <img alt="1376" />
</Frame>

### Managing integrations

From the integrations list you can click into any integration to configure it
(e.g. employee filtering for HRIS) or delete it. You can also switch between
your **Production** and **Development** environments using the sidebar toggle.

Configuration that applies across integrations -- such as
[scopes](/hris/features/scopes), [webhooks](/hris/guides/webhooks), and
[custom fields](/hris/features/custom-fields) -- is available under the
**Configuration** section in the sidebar.

### Tool Coverage

The [tool coverage](/hris/guides/implementing-new-tools#coverage-grid) grid makes it easy for you to see which functionality is covered by which tool; not every tool will expose the same feature set, so seeing the coverage enables you to easily see if integrating a tool is feasible with your product's need.

### Logs

[Request logs](/hris/features/logs) help you be compliant with the data that Kombo processes; you can see every request that Kombo is making. It also lets you understand which endpoints are causing problems (like `403` errors on missing permissions) and debug them yourself.

<CardGroup>
  <Card title="You already use Kombo? Head to the dashboard here" icon="link" href="https://app.kombo.dev/" />
</CardGroup>