> ## 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.

# Lattice HRIS Integration

> 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 cols={2}>
  <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 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="Performance Review Cycles">
      | Field                       | Notes |
      | --------------------------- | ----- |
      | id                          |       |
      | remote\_id                  |       |
      | changed\_at                 |       |
      | remote\_deleted\_at         |       |
      | name                        |       |
      | review\_period\_start\_date |       |
      | 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 |
    | ------------------ | ----- |
    | Connection Guide   |       |
    | Employment History |       |
    | OAuth              |       |
    | API Passthrough    |       |
    | 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" required>
      **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" required>**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" required>**Legal last name**<br />
        Unified field: `last_name`</ResponseField>
        <ResponseField name="company_employee_id" type="text" required>**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" required>
      **Contact Information**

      <Expandable title="properties">
        <ResponseField name="personal_email" type="text" required>**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 cols={2}>
  <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>