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

# HiBob HRIS Integration

> 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 cols={2}>
  <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        |       |
    </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                                                |
    | --------------------- | ---------------------------------------------------- |
    | Connection Guide      |                                                      |
    | Prerequisites         |                                                      |
    | Employment History    |                                                      |
    | OAuth                 |                                                      |
    | API Passthrough       |                                                      |
    | Scope Testing         |                                                      |
    | Per Model Tests       |                                                      |
    | Per Field Tests       | The individual field detection might be inconsistent |
    | Delta Syncs           |                                                      |
    | Group Types           |                                                      |
    | DEPARTMENT            |                                                      |
    | COST\_CENTER          |                                                      |
    | Custom Field Explorer |                                                      |
    | Employees             |                                                      |
  </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" required>**First Name**<br />
        The first name of the employee<br />
        Unified field: `first_name`</ResponseField>
        <ResponseField name="surname" type="text" required>**Last Name**<br />
        The last name of the employee<br />
        Unified field: `last_name`</ResponseField>
        <ResponseField name="email" type="text" required>**Private Email**<br />
        The private email address of the employee<br />
        Unified field: `private_email`</ResponseField>

        <ResponseField name="work" type="object" required>
          **Work**

          <Expandable title="properties">
            <ResponseField name="site" type="single_select" required>**Site**<br />
            The employee's site.</ResponseField>
            <ResponseField name="startDate" type="date" required>**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" required>**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" required>**Display name**<br />
                The name that will be shown in Bob's UI during field mapping</ResponseField>
                <ResponseField name="value" type="text" required>**Value**</ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="number" type="array">
              **Number fields**

              <Expandable title="items">
                <ResponseField name="id" type="text" required>**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" required>**Display name**<br />
                The name that will be shown in Bob's UI during field mapping</ResponseField>
                <ResponseField name="value" type="number" required>**Value**</ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="date" type="array">
              **Date fields**

              <Expandable title="items">
                <ResponseField name="id" type="text" required>**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" required>**Display name**<br />
                The name that will be shown in Bob's UI during field mapping</ResponseField>
                <ResponseField name="value" type="date" required>**Value**</ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="boolean" type="array">
              **Boolean fields**

              <Expandable title="items">
                <ResponseField name="id" type="text" required>**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" required>**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" required>**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" required>**Display name**<br />
                The name that will be shown in Bob's UI during field mapping</ResponseField>
                <ResponseField name="amount" type="number" required>**Amount**</ResponseField>
                <ResponseField name="currency" type="single_select" required>**Currency**</ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="multilist" type="array">
              **Multilist fields**

              <Expandable title="items">
                <ResponseField name="id" type="text" required>**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" required>**Display name**<br />
                The name that will be shown in Bob's UI during field mapping</ResponseField>

                <ResponseField name="values" type="array" required>
                  **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" required>**First Name**<br />
        The first name of the employee<br />
        Unified field: `first_name`</ResponseField>
        <ResponseField name="surname" type="text" required>**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" required>**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" required>
          **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" required>**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" required>**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>
