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

# [DEPRECATED] Create employee

> Create a new employee.

<Warning>
  We are deprecating this endpoint in favor of the new [create employee form](/hris/features/create-employee) endpoint.
</Warning>

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/personio/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/personio">Personio</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/workday/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/workday">Workday</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/successfactors/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/successfactors">SAP SuccessFactors</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/factorial/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/factorial">Factorial</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/adpworkforcenow/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/adpworkforcenow">ADP Workforce Now</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/bamboohr/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/bamboohr">BambooHR</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/hibob/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/hibob">HiBob</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/cezannehr/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/cezannehr">Cezanne HR</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/entraid/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/entraid">Microsoft Entra ID</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/azuread/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/azuread">Microsoft Azure AD</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/googleworkspace/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/googleworkspace">Google Workspace</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/nmbrs/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/nmbrs">Nmbrs</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/remotecom/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/remotecom">Remote</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/okta/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/okta">Okta</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/sagehr/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/sagehr">Sage HR</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/humaans/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/humaans">Humaans</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/oraclehcm/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/oraclehcm">Oracle HCM</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/zohopeople/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/zohopeople">Zoho People</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/gusto/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/gusto">Gusto</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/breathehr/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/breathehr">Breathe HR</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/alexishr/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/alexishr">AlexisHR</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/simployer/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/simployer">Simployer</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/paylocity/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/paylocity">Paylocity</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/paycor/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/paycor">Paycor</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/insperity/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/insperity">Insperity</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/rippling/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/rippling">Rippling</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/sapling/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/sapling">Kallidus (Sapling)</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/peoplehr/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/peoplehr">PeopleHR</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/planday/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/planday">Planday</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/cornerstoneondemand/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/cornerstoneondemand">Cornerstone OnDemand</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/square/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/square">Square</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/leapsome/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/leapsome">Leapsome</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/sympa/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/sympa">Sympa</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/sandbox/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/sandbox">Kombo Sandbox</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

<Note>
  This endpoint requires the permission **Create and manage employees** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "first_name": "John",
  "last_name": "Doe",
  "work_email": "john.doe@acme.com",
  "gender": "MALE",
  "date_of_birth": "1986-01-01",
  "start_date": "2020-04-07",
  "job_title": "Integrations Team Lead",
  "home_address": {
    "city": "Berlin",
    "country": "DE",
    "state": "Berlin",
    "street_1": "Sonnenallee 63",
    "zip_code": "12045"
  }
}
```


## OpenAPI

````yaml POST /hris/employees
openapi: 3.1.0
info:
  title: Kombo API
  version: 1.0.0
servers:
  - url: https://api.kombo.dev/v1
    description: Kombo EU API
  - url: https://api.us.kombo.dev/v1
    description: Kombo US API
security:
  - ApiKey: []
tags:
  - name: General
  - name: Kombo Connect
    description: >-
      Endpoints for Kombo Connect, our end-user-facing flow for setting up new
      integrations.
  - name: Unified HRIS API
    description: Unified endpoints to access all the HR concepts you might need.
  - name: Unified ATS API
    description: Unified endpoints to access all the ATS concepts you might need.
  - name: Unified ATS (Assessment & Background Check) API
    description: >-
      Unified endpoints to operate Assessments and Background Checks for many
      applicant tracking systems.
  - name: Unified LMS API
    description: Unified endpoints to access all the LMS concepts you might need.
  - name: AI Apply
    description: Endpoints for AI-powered job application features.
  - name: Custom Endpoints
    description: Custom integration-specific endpoints.
paths:
  /hris/employees:
    post:
      tags:
        - Unified HRIS API
      summary: '[DEPRECATED] Create employee'
      description: >-
        Create a new employee.


        <Warning>
          We are deprecating this endpoint in favor of the new [create employee form](/hris/features/create-employee) endpoint.
        </Warning>


        <Accordion title="Supported integrations" icon="list-check">

        This feature is currently available for the following integrations:


        <ul>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/personio/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/personio">Personio</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/workday/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/workday">Workday</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/successfactors/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/successfactors">SAP SuccessFactors</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/factorial/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/factorial">Factorial</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/adpworkforcenow/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/adpworkforcenow">ADP Workforce Now</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/bamboohr/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/bamboohr">BambooHR</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/hibob/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/hibob">HiBob</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/cezannehr/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/cezannehr">Cezanne HR</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/entraid/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/entraid">Microsoft Entra ID</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/azuread/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/azuread">Microsoft Azure AD</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/googleworkspace/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/googleworkspace">Google Workspace</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/nmbrs/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/nmbrs">Nmbrs</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/remotecom/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/remotecom">Remote</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/okta/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/okta">Okta</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/sagehr/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/sagehr">Sage HR</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/humaans/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/humaans">Humaans</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/oraclehcm/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/oraclehcm">Oracle HCM</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/zohopeople/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/zohopeople">Zoho People</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/gusto/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/gusto">Gusto</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/breathehr/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/breathehr">Breathe HR</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/alexishr/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/alexishr">AlexisHR</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/simployer/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/simployer">Simployer</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/paylocity/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/paylocity">Paylocity</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/paycor/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/paycor">Paycor</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/insperity/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/insperity">Insperity</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/rippling/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/rippling">Rippling</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/sapling/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/sapling">Kallidus (Sapling)</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/peoplehr/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/peoplehr">PeopleHR</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/planday/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/planday">Planday</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/cornerstoneondemand/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/cornerstoneondemand">Cornerstone
        OnDemand</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/square/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/square">Square</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/leapsome/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/leapsome">Leapsome</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/sympa/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/sympa">Sympa</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/sandbox/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/sandbox">Kombo Sandbox</a></li>

        </ul>


        You'd like to see this feature for another integration? Please reach
        out!

        We're always happy to discuss extending our coverage.

        </Accordion>



        <Note>
          This endpoint requires the permission **Create and manage employees** to be enabled in [your scope config](/scopes).
        </Note>


        ### Example Request Body


        ```json

        {
          "first_name": "John",
          "last_name": "Doe",
          "work_email": "john.doe@acme.com",
          "gender": "MALE",
          "date_of_birth": "1986-01-01",
          "start_date": "2020-04-07",
          "job_title": "Integrations Team Lead",
          "home_address": {
            "city": "Berlin",
            "country": "DE",
            "state": "Berlin",
            "street_1": "Sonnenallee 63",
            "zip_code": "12045"
          }
        }

        ```
      operationId: PostHrisEmployees
      parameters:
        - in: header
          name: X-Integration-Id
          schema:
            type: string
          description: ID of the integration you want to interact with.
          example: bamboohr:HWUTwvyx2wLoSUHphiWVrp28
          required: true
      requestBody:
        description: POST /hris/employees Request body
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostHrisEmployeesRequestBody'
            examples:
              example1:
                value:
                  first_name: John
                  last_name: Doe
                  work_email: john.doe@acme.com
                  gender: MALE
                  date_of_birth: '1986-01-01'
                  start_date: '2020-04-07'
                  job_title: Integrations Team Lead
                  home_address:
                    city: Berlin
                    country: DE
                    state: Berlin
                    street_1: Sonnenallee 63
                    zip_code: '12045'
      responses:
        '200':
          description: POST /hris/employees Positive response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostHrisEmployeesPositiveResponse'
              examples:
                example1:
                  value:
                    status: success
                    data:
                      id: 26vafvWSRmbhNcxJYqjCzuJg
                      remote_id: '32'
                      employee_number: '3243422'
                      first_name: John
                      last_name: Doe
                      nationality: French
                      display_full_name: John Doe
                      job_title: Integrations Team Lead
                      work_email: john.doe@acme.com
                      personal_email: john@doe.me
                      mobile_phone_number: 801-555-4687
                      ssn: 555-32-6395
                      tax_id: 12 345 678 901
                      gender: MALE
                      ethnicity: BLACK_AFRICAN_AMERICAN
                      marital_status: MARRIED
                      employment_status: INACTIVE
                      employment_type: FULL_TIME
                      weekly_hours: 40
                      avatar: >-
                        https://resources.bamboohr.com/images/photo_person_150x150.png
                      work_location_id: 7E2gyuv6TmvtByzBxW9Sxt53
                      legal_entity_id: xB32bied320csBSsl3XWdlw33
                      manager_id: 9pf2pxBB8VX8EQMC9aipW2Bo
                      home_address:
                        city: Berlin
                        country: DE
                        raw: |-
                          Sonnenallee 63
                          12045 Berlin
                          Germany
                        state: Berlin
                        street_1: Sonnenallee 63
                        street_2: null
                        zip_code: '12045'
                      bank_accounts:
                        - account_number: '1234567890'
                          bank_name: Commerzbank
                          bic: COBADEFFXXX
                          domestic_bank_routing:
                            number: '34567890'
                            type: DE_BANKLEITZAHL
                          holder_name: John Doe
                          iban: DE12345678901234567890
                      date_of_birth: '1986-01-01T00:00:00.000Z'
                      start_date: '2020-04-07T00:00:00.000Z'
                      termination_date: '2022-05-20T00:00:00.000Z'
                      remote_created_at: '2020-04-07T12:32:01.000Z'
                      changed_at: '2022-08-07T14:01:29.196Z'
                      remote_deleted_at: null
                      custom_fields: {}
                      integration_fields: []
                      remote_data: null
                    warnings:
                      - message: This is an example warning!
        default:
          $ref: '#/components/responses/ErrorResponseHRIS'
components:
  schemas:
    PostHrisEmployeesRequestBody:
      type: object
      properties:
        first_name:
          type: string
          description: The first name of the employee.
        last_name:
          type: string
          description: The last name of the employee.
        work_email:
          type: string
          description: >-
            The email address of the employee to be created. For tools where the
            personal email address is required, we map this input to the
            personal email. This is documented on a per-tool basis.
          format: email
        gender:
          type: string
          enum:
            - MALE
            - FEMALE
            - NON_BINARY
            - NOT_SPECIFIED
          description: The gender of the employee.
        job_title:
          type: string
          description: The title of the position this person is working in.
        home_address:
          type: object
          properties:
            street_1:
              type: string
            street_2:
              type: string
            city:
              type: string
            state:
              type: string
            zip_code:
              type: string
            country:
              type: string
              pattern: ^[A-Z]{2}$
              description: >-
                The uppercase two-letter ISO country (e.g., `DE`). For systems
                that use codes in formats other than `ISO 3166-1 alpha-2`, Kombo
                transforms the ISO Codes to the appropriate value.
          description: The employee's home address.
        date_of_birth:
          description: >-
            The employee's date of birth. This is a plain date (i.e.,
            `yyyy-MM-dd`), all time information is discarded.
          type: string
          format: date-time
          pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?)?Z?$
          externalDocs:
            url: >-
              https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
        mobile_phone_number:
          type: string
        home_phone_number:
          type: string
        nationality:
          type: string
          pattern: ^[A-Z]{2}$
          description: >-
            The uppercase two-letter ISO country (e.g., `DE`). For systems that
            use codes in formats other than `ISO 3166-1 alpha-2`, Kombo
            transforms the ISO Codes to the appropriate value.
        start_date:
          description: >-
            Start date of the employee. Also considered to be the hire date.
            This is a plain date (i.e., `yyyy-MM-dd`), all time information is
            discarded.
          type: string
          format: date-time
          pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?)?Z?$
          externalDocs:
            url: >-
              https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
        legal_entity_id:
          type: string
          description: >-
            The Kombo ID of the legal entity the employee should be in. This
            field is required for certain integrations.
        location_id:
          type: string
          description: >-
            The Kombo ID of the location the employee should be in. This field
            is required for certain integrations.
        remote_fields:
          type: object
          properties:
            humaans:
              type: object
              properties:
                employee:
                  type: object
                  additionalProperties: true
                  description: >-
                    Fields that we will pass through to Humaans `Employee`
                    object.
              description: Fields specific to Humaans.
            hibob:
              type: object
              properties:
                employee:
                  type: object
                  additionalProperties: true
                  description: >-
                    Fields that we will pass through to HiBob's `Person`
                    endpoint.
              description: Fields specific to HiBob.
            sympa:
              type: object
              properties:
                GenericNewHire:
                  type: object
                  additionalProperties: true
                  description: >-
                    Fields that we will pass through to Sympa's `Employee`
                    object.
              description: Fields specific to Sympa.
            peoplehr:
              type: object
              properties:
                job_role_effective_date:
                  description: >-
                    The effective date of the employee's current role. This is a
                    plain date (i.e., `yyyy-MM-dd`), all time information is
                    discarded.
                  type: string
                  format: date-time
                  pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?)?Z?$
                  externalDocs:
                    url: >-
                      https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
                department:
                  type: string
              description: Fields specific to PeopleHR.
            zohopeople:
              type: object
              properties:
                employee_id:
                  type: string
                  minLength: 1
                  description: >-
                    A personnel code used to identify individuals working for
                    the business.
              description: Fields specific to Zoho People.
            workday:
              type: object
              properties:
                job_requisition_id:
                  type: string
                  description: >-
                    Workday job requisition ID of that the employee should be
                    hired for. Provide either this or `position_id`.
                position_id:
                  type: string
                  description: >-
                    Workday position ID of that the employee should be hired to.
                    Provide either this or `job_requisition_id`.
                ssn:
                  type: string
                  description: The social security number of the employee.
                bank_account:
                  type: object
                  properties:
                    iban:
                      type: string
                    bic:
                      type: string
                    bank_name:
                      type: string
                  required:
                    - iban
                    - bic
                    - bank_name
                  description: The employee's bank account.
              description: Fields specific to Workday.
            deel:
              type: object
              properties:
                candidate_id:
                  type: string
                  description: The unique identifier of the candidate in the ATS.
                candidate_link:
                  type: string
                  description: The link to the candidate's profile in the ATS.
              required:
                - candidate_id
                - candidate_link
              description: Fields specific to Deel.
            bamboohr:
              type: object
              properties:
                employee:
                  type: object
                  additionalProperties: true
                  description: >-
                    Fields that we will pass through to BambooHR `Employee`
                    object.
              description: Fields specific to BambooHR.
            oracle:
              type: object
              properties:
                group_id:
                  type: string
                  description: >-
                    The business unit group ID for which the employee should be
                    created. It can be found as a group with the type `null`.
                department_id:
                  type: string
                  description: >-
                    The department group ID for which the employee should be
                    created. It can be found as a group with the type
                    `DEPARTMENT`.
              required:
                - group_id
                - department_id
              description: Fields specific to Oracle HCM.
            adpworkforcenow:
              type: object
              properties:
                onboarding_template_code:
                  type: string
                  description: >-
                    The onboarding template to be used for the created employee.
                    View the possible values in the Kombo dashboard by clicking
                    on the ADP Workforce Now integration and viewing the field
                    report in the settings tab.
                applicant_payroll_profile_group_code:
                  type: string
                  description: >-
                    The payroll group code (a.k.a. "Company Code") to be used
                    for the created employee. View the possible values in the
                    Kombo dashboard by clicking on the ADP Workforce Now
                    integration and viewing the field report in the settings
                    tab.
                manager_position_id:
                  type: string
                  description: >-
                    The position ID of the employment of the manager. Available
                    as mappable custom field on employments. Not the employment
                    ID or employment remote ID!
                home_organization_unit_code:
                  type: string
                  description: >-
                    The remote id of a Kombo group with type "DEPARTMENT" that
                    will be used as the employee's home department.
                personal_email:
                  type: string
                  description: The personal email for the employee.
              required:
                - onboarding_template_code
                - applicant_payroll_profile_group_code
              description: Fields specific to ADP Workforce Now.
            azuread:
              type: object
              properties:
                password:
                  type: string
                  description: >-
                    Azure / entra requires a password to be set when creating a
                    user. The user has to use the password on his initial
                    sign-in and will be forced to change the password once
                    signed in.
              required:
                - password
              description: Fields specific to Azure AD/Entra ID.
            paycor:
              type: object
              properties:
                paygroupRemoteId:
                  type: string
                  description: >-
                    [REQUIRED] Remote ID of a Kombo Group with type
                    "COST_CENTER"
                departmentRemoteId:
                  type: string
                  description: '[REQUIRED] Remote ID of a Kombo Group with type "DEPARTMENT"'
              required:
                - paygroupRemoteId
                - departmentRemoteId
              description: Fields specific to Paycor.
            planday:
              type: object
              properties:
                department_remote_id:
                  type: string
                  description: >-
                    The remote ID of the department for which the employee
                    should be assigned to. It can be found as a group with the
                    type `DEPARTMENT`.
              required:
                - department_remote_id
              description: Fields specific to PlanDay.
            dayforce:
              type: object
              properties:
                social_security_number:
                  type: string
                  description: The social security number of the employee
                pay_type:
                  type: string
                  description: >-
                    The pay type of the employee. This needs to be a valid
                    XRefCode from Dayforce.
                pay_class:
                  type: string
                  description: >-
                    The pay class of the employee. This needs to be a valid
                    XRefCode from Dayforce.
                pay_group:
                  type: string
                  description: >-
                    The pay group of the employee. This needs to be a valid
                    XRefCode from Dayforce.
                base_rate:
                  type: number
                  format: double
                  minimum: -1.7976931348623157e+308
                  description: The base rate of the employee.
                role:
                  type: string
                  description: >-
                    The role of the employee. This needs to be a valid XRefCode
                    from Dayforce.
                location:
                  type: string
                  description: >-
                    The location of the employee. This needs to be a valid
                    XRefCode from Dayforce.
                department:
                  type: string
                  description: >-
                    The department of the employee. This needs to be a valid
                    XRefCode from Dayforce.
                job:
                  type: string
                  description: >-
                    The job of the employee. This needs to be a valid XRefCode
                    from Dayforce.
                country:
                  type: string
                  description: >-
                    The country of the employee. This needs to be a valid
                    XRefCode from Dayforce.
              required:
                - social_security_number
                - pay_type
                - pay_class
                - pay_group
                - base_rate
                - role
                - location
                - department
                - job
                - country
              description: Fields specific to Dayforce.
          description: >-
            Additional fields that we will pass through to specific HRIS
            systems.
      required:
        - first_name
        - last_name
    PostHrisEmployeesPositiveResponse:
      type: object
      properties:
        status:
          type: string
          const: success
        data:
          type: object
          properties:
            id:
              type: string
              description: >-
                The globally unique ID of this object generated by Kombo. We
                recommend using this as a stable primary key for syncing.
            remote_id:
              type: string
              description: >-
                The raw ID of the object in the remote system. We don't
                recommend using this as a primary key on your side as it might
                sometimes be compromised of multiple identifiers if a system
                doesn't provide a clear primary key.
            employee_number:
              type:
                - string
                - 'null'
              description: The employee’s organization-internal employee number.
            first_name:
              type:
                - string
                - 'null'
              description: The employee’s first name.
            last_name:
              type:
                - string
                - 'null'
              description: The employee’s last name.
            nationality:
              type:
                - string
                - 'null'
              description: The employee’s nationality.
            display_full_name:
              type:
                - string
                - 'null'
              description: >-
                The employee’s full name, including any middle names. Not all HR
                systems provide an explicit display name, so we recommend
                falling back to `first_name` and `last_name`.
            job_title:
              type:
                - string
                - 'null'
              description: The employee’s job title.
            work_email:
              type:
                - string
                - 'null'
              pattern: >-
                ^(?!\.)(?!.*\.\.)([\w'+-.]*)[\w+-]@([\da-z][\da-z-]*\.)+[a-z]{2,}$
              description: >-
                The employee’s work email address. If the email address is
                invalid, we will set this to `null`.
            personal_email:
              type:
                - string
                - 'null'
              pattern: >-
                ^(?!\.)(?!.*\.\.)([\w'+-.]*)[\w+-]@([\da-z][\da-z-]*\.)+[a-z]{2,}$
              description: >-
                The employee’s personal email address. If the email address is
                invalid, we will set this to `null`.
            mobile_phone_number:
              type:
                - string
                - 'null'
              description: The employee’s mobile phone number.
            ssn:
              type:
                - string
                - 'null'
              description: The employee’s social security number
            tax_id:
              type:
                - string
                - 'null'
              description: The employee’s tax ID.
            gender:
              anyOf:
                - type: string
                  enum:
                    - MALE
                    - FEMALE
                    - NON_BINARY
                    - NOT_SPECIFIED
                - type: string
                  description: >-
                    If we can't find a clear mapping: The original string passed
                    through.
                - type: 'null'
              description: The employee’s gender.
            ethnicity:
              anyOf:
                - type: string
                  enum:
                    - WHITE
                    - ASIAN
                    - HISPANIC_LATINO
                    - HAWAIIAN
                    - NATIVE_AMERICAN
                    - BLACK_AFRICAN_AMERICAN
                    - MULTIPLE_ETHNICITIES
                    - DECLINE_TO_SPECIFY
                - type: string
                  description: >-
                    If we can't find a clear mapping: The original string passed
                    through.
                - type: 'null'
              description: >-
                The employee’s ethnicity. In rare cases where we can’t find a
                clear mapping, the original string is passed through.
            marital_status:
              anyOf:
                - type: string
                  enum:
                    - SINGLE
                    - MARRIED
                    - DOMESTIC_PARTNERSHIP
                    - WIDOWED
                    - DIVORCED
                    - SEPARATED
                    - NOT_MARRIED
                - type: string
                  description: >-
                    If we can't find a clear mapping: The original string passed
                    through.
                - type: 'null'
              description: >-
                The employee’s current marital status. In rare cases where we
                can’t find a clear mapping, the original string is passed
                through.
            employment_status:
              anyOf:
                - type: string
                  enum:
                    - ACTIVE
                    - PENDING
                    - INACTIVE
                    - LEAVE
                - type: string
                  description: >-
                    If we can't find a clear mapping: The original string passed
                    through.
                - type: 'null'
              description: >-
                The employee’s current employment status:


                - `ACTIVE`: the employee is **actively employed**

                - `PENDING`: the employee is **not actively employed yet** (but
                they signed their contract or are part of an onboarding process)

                - `INACTIVE`: the employee is **not actively employed** anymore

                - `LEAVE`: the employee is still employed but **currently on
                leave** (note that not all HR systems support this status — use
                our absences API for detailed information)

                 In rare cases where we can’t find a clear mapping, the original string is passed through.
            employment_type:
              anyOf:
                - type: string
                  enum:
                    - FULL_TIME
                    - PART_TIME
                    - CONTRACT
                    - INTERNSHIP
                    - FREELANCE
                    - WORKING_STUDENT
                    - APPRENTICESHIP
                    - TRAINING
                - type: string
                  description: >-
                    If we can't find a clear mapping: The original string passed
                    through.
                - type: 'null'
              description: >-
                The employee’s current employment type:


                - `FULL_TIME`: the employee is actively employed

                - `PART_TIME`: the employee is working only part of the usual
                working hours

                - `CONTRACT`: the employee is working temporarily under a
                contract

                - `INTERNSHIP`: the employee is working as an intern

                - `FREELANCE`: the employee is working as a freelancer

                - `WORKING_STUDENT`: the employee is working as a working
                student

                - `APPRENTICESHIP`: the employee is working in an apprenticeship

                - `TRAINING`: the employee is working in a training program

                 In rare cases where we can’t find a clear mapping, the original string is passed through.
            weekly_hours:
              type:
                - number
                - 'null'
              format: double
              minimum: -1.7976931348623157e+308
              description: The employee’s weekly working hours.
            avatar:
              type:
                - string
                - 'null'
              description: >-
                URL to the employee’s avatar. This is either the raw URL from
                the HR system (in cases where it can be requested without
                short-lived authentication) _or_ a URL to a temporarily cached
                version of the file hosted by Kombo. Kombo will delete the
                cached file after its deletion in the source system.
            work_location_id:
              type:
                - string
                - 'null'
              description: >-
                The Kombo ID of the employee’s work location. The ID can be used
                to retrieve the work location from the `get work locations`
                endpoint.
            legal_entity_id:
              type:
                - string
                - 'null'
              description: >-
                The Kombo ID of the employee’s legal entity. The ID can be used
                to retrieve the legal entity from the `get legal entities`
                endpoint.
            manager_id:
              type:
                - string
                - 'null'
              description: >-
                The Kombo ID of the employee’s manager. The ID can be used to
                retrieve the manager from the `get employees` endpoint.
            home_address:
              type:
                - object
                - 'null'
              properties:
                city:
                  type:
                    - string
                    - 'null'
                country:
                  type:
                    - string
                    - 'null'
                  description: >-
                    Contains the ISO2 country code if possible. If not, it
                    contains the original value.
                raw:
                  type:
                    - string
                    - 'null'
                  description: >-
                    If we have address data, this is filled with the raw address
                    string.
                state:
                  type:
                    - string
                    - 'null'
                street_1:
                  type:
                    - string
                    - 'null'
                  description: >-
                    If we can parse the address data, this field contains the
                    first part of the street information.
                street_2:
                  type:
                    - string
                    - 'null'
                zip_code:
                  type:
                    - string
                    - 'null'
              description: The employee’s home address.
            bank_accounts:
              type:
                - array
                - 'null'
              items:
                type: object
                properties:
                  iban:
                    type:
                      - string
                      - 'null'
                    description: >-
                      The internationally unique IBAN identifying this account.
                      If we detect a valid IBAN from the account number and this
                      field would otherwise be empty, we will automatically
                      populate this field.
                  bic:
                    type:
                      - string
                      - 'null'
                    description: >-
                      The internationally unique BIC/SWIFT code identifying the
                      bank behind this account. If we detect a valid BIC from
                      the domestic bank routing number and this field would
                      otherwise be empty, we will automatically populate this
                      field.
                  account_number:
                    type:
                      - string
                      - 'null'
                    description: >-
                      The bank-specific account number. Some companies use the
                      account number field to put the IBAN here.
                  holder_name:
                    type:
                      - string
                      - 'null'
                    description: The name of the holder of this account.
                  bank_name:
                    type:
                      - string
                      - 'null'
                    description: The name of the bank behind this account.
                  domestic_bank_routing:
                    type:
                      - object
                      - 'null'
                    properties:
                      number:
                        type: string
                        description: >-
                          Bank routing number (e.g. DE Bankleitzahl, GB Sort
                          Code, US ABA routing number, AU BSB code). This field
                          is not formatted and therefore might contain
                          delimiters (eg. 01-23-45).
                      type:
                        type:
                          - string
                          - 'null'
                        enum:
                          - GB_SORT_CODE
                          - DE_BANKLEITZAHL
                          - US_ABA_ROUTING_TRANSIT_NUMBER
                          - CA_ROUTING_NUMBER
                          - AU_BSB_CODE
                          - FR_RIB
                        description: >-
                          Enum of the routing type, prefixed with the
                          iso-3166-1-alpha-2 banks origin country. If there is
                          uncertainty about the type, it will be set to null.
                    required:
                      - number
                      - type
              description: The employee’s bank accounts.
            date_of_birth:
              description: The employee’s date of birth.
              type:
                - string
                - 'null'
              format: date-time
              externalDocs:
                url: >-
                  https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
            start_date:
              description: The date the employee started working for the organization.
              type:
                - string
                - 'null'
              format: date-time
              externalDocs:
                url: >-
                  https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
            termination_date:
              description: The date when the employment ends. Can be in the past or future.
              type:
                - string
                - 'null'
              format: date-time
              externalDocs:
                url: >-
                  https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
            remote_created_at:
              description: The date and time the object was created in the remote system.
              type:
                - string
                - 'null'
              format: date-time
              externalDocs:
                url: >-
                  https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
            changed_at:
              description: >-
                The timestamp when this specific record was last modified. This
                field only updates when properties directly on this record
                change, NOT when related or nested models change. For filtering
                that considers nested data changes, use the `updated_after`
                parameter which will return records when either the record
                itself OR its related models have been updated.
              type: string
              format: date-time
              externalDocs:
                url: >-
                  https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
            remote_deleted_at:
              description: >-
                The date and time the object was deleted in the remote system.
                Objects are automatically marked as deleted when Kombo can't
                retrieve them from the remote system anymore. Kombo will also
                anonymize entries 14 days after they disappear.
              type:
                - string
                - 'null'
              format: date-time
              externalDocs:
                url: >-
                  https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
            custom_fields:
              type:
                - object
                - 'null'
              additionalProperties: true
              description: >-
                A key-value store of fields not covered by the schema. [Read
                more](/custom-fields)
            integration_fields:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                    description: The globally unique ID of this object.
                  key:
                    type: string
                    description: The key of the field in the remote system.
                  type:
                    type: string
                    enum:
                      - DEFAULT
                      - CUSTOM
                    description: |-
                      - `DEFAULT`: static fields in the remote system.
                      - `CUSTOM`: fields that are created/editable by the user.
                  value:
                    type: 'null'
                    description: The field's value.
                  label:
                    type:
                      - string
                      - 'null'
                    description: The label of the field. (not always available)
                required:
                  - id
                  - key
                  - type
                  - label
              description: >-
                An array of selected passthrough integration fields. [Read
                more](/integration-fields)
              examples:
                - - id: 5NVFhMpB9Ah6by44tzNjZLyE
                    key: firstName
                    type: DEFAULT
                    value: Frank
                    label: First Name
                  - id: 8nuajYpoRd5GnxEQaaWKUDYQ
                    key: customTshirtSize
                    type: CUSTOM
                    value: XL
                    label: T-Shirt Size
            remote_data:
              type:
                - object
                - 'null'
              additionalProperties: true
              description: >-
                Includes the data fetched from the remote system.

                Please be aware that including this in you scope config might
                violate other

                scopes that are set.


                Remote data always has the endpoint path that we got the data
                from as the

                top level key. For example, it could look like: `{ "/companies":
                { ... }}`


                This is not available on all plans. Reach out to Kombo if you
                need it.
          required:
            - id
            - remote_id
            - employee_number
            - first_name
            - last_name
            - nationality
            - display_full_name
            - job_title
            - mobile_phone_number
            - ssn
            - tax_id
            - weekly_hours
            - avatar
            - work_location_id
            - legal_entity_id
            - manager_id
            - date_of_birth
            - start_date
            - termination_date
            - remote_created_at
            - changed_at
            - remote_deleted_at
            - custom_fields
            - integration_fields
            - remote_data
          examples:
            - id: 26vafvWSRmbhNcxJYqjCzuJg
              remote_id: '32'
              employee_number: '3243422'
              first_name: John
              last_name: Doe
              nationality: French
              display_full_name: John Doe
              job_title: Integrations Team Lead
              work_email: john.doe@acme.com
              personal_email: john@doe.me
              mobile_phone_number: 801-555-4687
              ssn: 555-32-6395
              tax_id: 12 345 678 901
              gender: MALE
              ethnicity: BLACK_AFRICAN_AMERICAN
              marital_status: MARRIED
              employment_status: INACTIVE
              employment_type: FULL_TIME
              weekly_hours: 40
              avatar: https://resources.bamboohr.com/images/photo_person_150x150.png
              work_location_id: 7E2gyuv6TmvtByzBxW9Sxt53
              legal_entity_id: xB32bied320csBSsl3XWdlw33
              manager_id: 9pf2pxBB8VX8EQMC9aipW2Bo
              home_address:
                city: Berlin
                country: DE
                raw: |-
                  Sonnenallee 63
                  12045 Berlin
                  Germany
                state: Berlin
                street_1: Sonnenallee 63
                street_2: null
                zip_code: '12045'
              bank_accounts:
                - account_number: '1234567890'
                  bank_name: Commerzbank
                  bic: COBADEFFXXX
                  domestic_bank_routing:
                    number: '34567890'
                    type: DE_BANKLEITZAHL
                  holder_name: John Doe
                  iban: DE12345678901234567890
              date_of_birth: '1986-01-01T00:00:00.000Z'
              start_date: '2020-04-07T00:00:00.000Z'
              termination_date: '2022-05-20T00:00:00.000Z'
              remote_created_at: '2020-04-07T12:32:01.000Z'
              changed_at: '2022-08-07T14:01:29.196Z'
              remote_deleted_at: null
              custom_fields: {}
              integration_fields: []
              remote_data: null
        warnings:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: >-
            These are the interaction warnings that are shown in the dashboard.
            They are meant to provide debug information to you. We recommend
            logging them to the console.
      required:
        - status
        - data
        - warnings
  responses:
    ErrorResponseHRIS:
      description: The standard error response with the error codes for the HRIS use case.
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                enum:
                  - error
              error:
                type: object
                properties:
                  code:
                    type:
                      - string
                      - 'null'
                    enum:
                      - PLATFORM.RATE_LIMIT_EXCEEDED
                      - PLATFORM.CONCURRENCY_LIMIT_EXCEEDED
                      - PLATFORM.INTEGRATION_NOT_FOUND
                      - PLATFORM.INPUT_INVALID
                      - PLATFORM.UNKNOWN_ERROR
                      - PLATFORM.IP_NOT_WHITELISTED
                      - PLATFORM.AUTHENTICATION_INVALID
                      - PLATFORM.TASK_TIMED_OUT
                      - INTEGRATION.PERMISSION_MISSING
                      - INTEGRATION.AUTHENTICATION_INVALID
                      - INTEGRATION.QA_FAILED
                      - INTEGRATION.SETUP_SYNC_PENDING
                      - INTEGRATION.SETUP_INCOMPLETE
                      - INTEGRATION.INACTIVE
                      - INTEGRATION.MODEL_NOT_AVAILABLE
                      - INTEGRATION.MODEL_DISABLED
                      - INTEGRATION.ACTION_NOT_AVAILABLE
                      - INTEGRATION.ACTION_DISABLED
                      - REMOTE.SERVICE_UNAVAILABLE
                      - REMOTE.RATE_LIMIT_EXCEEDED
                      - REMOTE.INPUT_INVALID
                      - REMOTE.UNKNOWN_HTTP_ERROR
                      - HRIS.STAFFING_ENTITY_CLOSED
                      - HRIS.EMPLOYEE_ALREADY_EXISTS
                    example: HRIS.EMPLOYEE_ALREADY_EXISTS
                    description: >-
                      Some errors include an error code that can be used to
                      identify their cause. See the [Error Handling
                      Docs](https://docs.kombo.dev/guides/errors) for more
                      information. For your error handling logic please use the
                      error `code` instead of other properties (e.g. message,
                      http status code, ...).
                  title:
                    type:
                      - string
                      - 'null'
                    description: A static, human-readable label.
                  message:
                    type: string
                    description: >-
                      A dynamic, detailed description of what went wrong in this
                      specific instance.
                  log_url:
                    type:
                      - string
                      - 'null'
                    format: uri
                    description: >-
                      The log page in the Kombo UI lists every interaction with
                      full details. If you need assistance, share that link with
                      our support team.
                required:
                  - code
                  - title
                  - message
                  - log_url
                description: Error details with structured code for programmatic handling.
            required:
              - status
              - error
          examples:
            Error Response:
              description: >-
                When building error handling logic, always use the `code` field
                to identify specific error types programmatically. See the
                complete list of error codes in the
                [docs](https://docs.kombo.dev/guides/errors).
              value:
                status: error
                error:
                  code: INTEGRATION.MODEL_NOT_AVAILABLE
                  title: >-
                    This data model isn't supported for the selected
                    integration.
                  message: >-
                    The "employees" model is not yet available for Greenhouse.
                    Please reach out to Kombo if you need this functionality.
                  log_url: https://app.kombo.dev/my-prod/logs?interactionId=123456
            Minimal Error Response:
              description: >-
                The "message" is always required while other fields can also be
                `null`. See the [docs](https://docs.kombo.dev/guides/errors) for
                more information.
              value:
                status: error
                error:
                  code: null
                  title: null
                  message: The message is always in the response.
                  log_url: null
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      description: >-
        Create an API key on the [Secrets](https://app.kombo.dev/secrets) page
        in the Kombo dashboard.

````