> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kombo.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# UKG Pro ATS Integration

> 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 cols={2}>
  <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                                                |
    | ------------------------------ | ---------------------------------------------------- |
    | 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` |
      \| API Passthrough |  |
      \| Scope Testing |  |
      \|   Per Model Tests |  |
      \| Delta Syncs |  |
      \| Custom Field Explorer |  |
      \|   Jobs |  |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** UKG Pro

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

<CardGroup cols={2}>
  <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>