> ## 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 Ready ATS Integration

> 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 cols={2}>
  <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 |       |
      | current\_stage\_id  |       |
      | job\_id             |       |
      | candidate\_id       |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | 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>
        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="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                                                                         |
    | ------------------------------ | ----------------------------------------------------------------------------- |
    | 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` |
      \| API Passthrough |  |
      \| Scope Testing |  |
      \|   Per Model Tests |  |
      \| Delta Syncs |  |
      \| Custom Field Explorer |  |
      \|   Jobs |  |
      \|   Candidates |  |
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** UKG Ready

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

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