> ## 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. # Get employees > Retrieve all employees. This feature is currently available for the following integrations:

You'd like to see this feature for another integration? Please reach out! We're always happy to discuss extending our coverage. Not interested in most fields? You can use our [our Scopes feature](/scopes) to customize what data points are synced. Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)` operationId: GetHrisEmployees 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 - name: cursor in: query required: false description: >- An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. schema: $ref: '#/components/schemas/GetHrisEmployeesParameterCursor' - name: page_size in: query required: false description: The number of results to return per page. Maximum is 250. schema: $ref: '#/components/schemas/GetHrisEmployeesParameterPageSize' - name: updated_after in: query required: false description: >- Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged. If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden. For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior). For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. | Path | Added/Removed | Linked Record | | --- | --- | --- | | `employments` | ✓ Yes | ✓ Yes | | `time_off_balances` | ✓ Yes | ✓ Yes | | `manager` | n/a | ✓ Yes | | `group_memberships` | ✓ Yes | ✗ No | | `legal_entity` | n/a | ✓ Yes | | `work_location` | n/a | ✓ Yes | _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ schema: $ref: '#/components/schemas/GetHrisEmployeesParameterUpdatedAfter' - name: include_deleted in: query required: false description: >- By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. schema: $ref: '#/components/schemas/GetHrisEmployeesParameterIncludeDeleted' - name: ignore_unsupported_filters in: query required: false description: >- When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. schema: $ref: >- #/components/schemas/GetHrisEmployeesParameterIgnoreUnsupportedFilters - name: ids in: query required: false description: >- Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. schema: $ref: '#/components/schemas/GetHrisEmployeesParameterIds' - name: remote_ids in: query required: false description: Filter by a comma-separated list of remote IDs. schema: $ref: '#/components/schemas/GetHrisEmployeesParameterRemoteIds' - name: employment_status in: query required: false description: >- **(⚠️ Deprecated - Use the `employment_statuses` filter instead.)** Filter by the `employment_status` field. schema: $ref: '#/components/schemas/GetHrisEmployeesParameterEmploymentStatus' deprecated: true - name: employment_statuses in: query required: false description: >- Filter by a comma-separated list of `ACTIVE`, `PENDING`, `INACTIVE`, `LEAVE` * `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`: a full-time employee is no longer employed, or, for a contract worker when their contract runs out * `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) Leave this blank to get results matching all values. schema: $ref: '#/components/schemas/GetHrisEmployeesParameterEmploymentStatuses' - name: group_ids in: query required: false description: >- Filter by a comma-separated list of group IDs. We will only return employees that are members of _any_ of the groups. schema: $ref: '#/components/schemas/GetHrisEmployeesParameterGroupIds' - name: legal_entity_ids in: query required: false description: >- Filter by a comma-separated list of legal entity IDs. We will only return employees that are members of _any_ of the legal entities. schema: $ref: '#/components/schemas/GetHrisEmployeesParameterLegalEntityIds' - name: work_location_ids in: query required: false description: >- Filter by a comma-separated list of work location IDs. We will only return employees who are at _any_ of the work locations. schema: $ref: '#/components/schemas/GetHrisEmployeesParameterWorkLocationIds' - name: work_emails in: query required: false description: >- Filter by a comma-separated list of work emails. We will only return employees who have _any_ of the work emails. The format of the emails is case-insensitive. schema: $ref: '#/components/schemas/GetHrisEmployeesParameterWorkEmails' - name: personal_emails in: query required: false description: >- Filter by a comma-separated list of personal emails. We will only return employees who have _any_ of the personal emails. The format of the emails is case-insensitive. schema: $ref: '#/components/schemas/GetHrisEmployeesParameterPersonalEmails' - name: custom_fields in: query required: false description: >- A JSON string with a single key-value pair like {"fieldKey":"fieldValue"} to filter employees by a specific custom field value. Note that the value must be a string, number, boolean or null and the key must be a valid custom field key. Custom fields with a value of type array or object are not supported. schema: $ref: '#/components/schemas/GetHrisEmployeesParameterCustomFields' responses: '200': description: GET /hris/employees Positive response content: application/json: schema: $ref: '#/components/schemas/GetHrisEmployeesPositiveResponse' examples: example1: value: status: success data: next: >- eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0= results: - 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 employments: - id: 12vpXR7BeqYNWDShXRgsonnm remote_id: '859' employee_id: 26vafvWSRmbhNcxJYqjCzuJg job_title: Social Media Marketer pay_rate: 85000 pay_period: YEAR pay_frequency: SEMIMONTHLY employment_type: FULL_TIME pay_currency: EUR effective_date: '2021-01-30T00:00:00.000Z' changed_at: '2022-08-07T14:01:29.196Z' remote_deleted_at: null remote_data: null custom_fields: {} integration_fields: [] time_off_balances: - id: FuyRuk5NqP3qTcThED3ymTuE remote_id: '124123' employee_id: 2Up4ZCvq1bFVzmzXG6EWzV3j type_id: BQJaBxRCiqN46G27VTegvkEr balance: 14 balance_unit: DAYS changed_at: '2022-08-07T14:01:29.196Z' remote_deleted_at: null used: 3 used_unit: DAYS remote_data: null manager: first_name: John last_name: Doe display_full_name: John Doe id: 26vafvWSRmbhNcxJYqjCzuJg employee_number: '3243422' work_email: john.doe@acme.com remote_id: '32' employment_status: INACTIVE termination_date: '2022-05-20T00:00:00.000Z' groups: - id: 4B9bKBpX5tnwjiG93TAqF7ci remote_id: '49' name: Customer Success type: TEAM legal_entity: id: 4B9bKBpX5tnwjiG93TAqF7ci remote_id: '49' name: ACME Inc. address: city: Berlin country: DE raw: |- Sonnenallee 63 12045 Berlin, Berlin Germany state: Berlin street_1: Sonnenallee 63 street_2: null zip_code: '12045' teams: - id: 4B9bKBpX5tnwjiG93TAqF7ci remote_id: '49' name: Customer Success type: TEAM work_location: id: 22st2Ji8XpncEYEak8mvQgQF remote_id: '1348' name: Kombo HQ address: city: Berlin country: DE raw: |- Sonnenallee 63 12045 Berlin, Berlin Germany state: Berlin street_1: Sonnenallee 63 street_2: null zip_code: '12045' type: OFFICE changed_at: '2022-08-07T14:01:29.196Z' remote_deleted_at: '2022-08-07T14:01:29.196Z' remote_data: null default: $ref: '#/components/responses/ErrorResponseHRIS' x-codeSamples: - lang: python label: GetHrisEmployees source: |- from kombo import Kombo with Kombo( integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28", api_key="", ) as k_client: res = k_client.hris.get_employees(page_size=100, include_deleted=False, ignore_unsupported_filters=False) while res is not None: # Handle items res = res.next() - lang: typescript label: GetHrisEmployees source: |- import { Kombo } from "@kombo-api/sdk"; const kombo = new Kombo({ integration_id: "workday:HWUTwvyx2wLoSUHphiWVrp28", api_key: "", }); async function run() { const result = await kombo.hris.getEmployees({}); for await (const page of result) { console.log(page); } } run(); - lang: ruby label: GetHrisEmployees source: >- require 'kombo' Models = ::Kombo::Models s = ::Kombo::Kombo.new( integration_id: 'workday:HWUTwvyx2wLoSUHphiWVrp28', security: Models::Shared::Security.new( api_key: '' ) ) res = s.hris.get_employees(page_size: 100, include_deleted: false, ignore_unsupported_filters: false) unless res.get_hris_employees_positive_response.nil? # handle response end components: schemas: GetHrisEmployeesParameterCursor: type: string description: >- An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. GetHrisEmployeesParameterPageSize: type: integer format: int64 minimum: 1 maximum: 250 default: 100 description: The number of results to return per page. Maximum is 250. GetHrisEmployeesParameterUpdatedAfter: description: >- Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged. If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden. For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior). For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. | Path | Added/Removed | Linked Record | | --- | --- | --- | | `employments` | ✓ Yes | ✓ Yes | | `time_off_balances` | ✓ Yes | ✓ Yes | | `manager` | n/a | ✓ Yes | | `group_memberships` | ✓ Yes | ✗ No | | `legal_entity` | n/a | ✓ Yes | | `work_location` | n/a | ✓ Yes | _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ 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 GetHrisEmployeesParameterIncludeDeleted: type: string enum: - 'true' - 'false' default: 'false' description: >- By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. GetHrisEmployeesParameterIgnoreUnsupportedFilters: type: string enum: - 'true' - 'false' default: 'false' description: >- When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. GetHrisEmployeesParameterIds: type: string description: >- Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. GetHrisEmployeesParameterRemoteIds: type: string description: Filter by a comma-separated list of remote IDs. GetHrisEmployeesParameterEmploymentStatus: type: string enum: - ACTIVE - PENDING - INACTIVE - LEAVE description: >- **(⚠️ Deprecated - Use the `employment_statuses` filter instead.)** Filter by the `employment_status` field. deprecated: true GetHrisEmployeesParameterEmploymentStatuses: type: string description: >- Filter by a comma-separated list of `ACTIVE`, `PENDING`, `INACTIVE`, `LEAVE` * `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`: a full-time employee is no longer employed, or, for a contract worker when their contract runs out * `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) Leave this blank to get results matching all values. GetHrisEmployeesParameterGroupIds: type: string description: >- Filter by a comma-separated list of group IDs. We will only return employees that are members of _any_ of the groups. GetHrisEmployeesParameterLegalEntityIds: type: string description: >- Filter by a comma-separated list of legal entity IDs. We will only return employees that are members of _any_ of the legal entities. GetHrisEmployeesParameterWorkLocationIds: type: string description: >- Filter by a comma-separated list of work location IDs. We will only return employees who are at _any_ of the work locations. GetHrisEmployeesParameterWorkEmails: type: string description: >- Filter by a comma-separated list of work emails. We will only return employees who have _any_ of the work emails. The format of the emails is case-insensitive. GetHrisEmployeesParameterPersonalEmails: type: string description: >- Filter by a comma-separated list of personal emails. We will only return employees who have _any_ of the personal emails. The format of the emails is case-insensitive. GetHrisEmployeesParameterCustomFields: type: string description: >- A JSON string with a single key-value pair like {"fieldKey":"fieldValue"} to filter employees by a specific custom field value. Note that the value must be a string, number, boolean or null and the key must be a valid custom field key. Custom fields with a value of type array or object are not supported. GetHrisEmployeesPositiveResponse: type: object properties: status: type: string const: success data: type: object properties: next: type: - string - 'null' description: >- Cursor string that can be passed to the `cursor` query parameter to get the next page. If this is `null`, then there are no more pages. results: type: array items: 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. employments: type: array items: 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 - 'null' 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_id: type: string description: >- The Kombo ID of the employment’s employee. The ID can be used to retrieve the employee from the `get employees` endpoint. job_title: type: - string - 'null' description: >- This field can contain historic job titles. Please use the `job_title` field on the employee for the active job title of an employee. pay_rate: type: - number - 'null' format: double minimum: -1.7976931348623157e+308 description: The monetary amount paid to an employee. pay_period: anyOf: - type: string enum: - HOUR - DAY - WEEK - TWO_WEEKS - HALF_MONTH - MONTH - TWO_MONTHS - QUARTER - HALF_YEAR - YEAR - type: string description: >- If we can't find a clear mapping: The original string passed through. - type: 'null' description: >- The time interval which the `pay_rate` is describing. A `pay_rate` value of `12000` with a `pay_period` of `YEAR` would indicate that the employee receives 12000 over the course of a year. In rare cases where we can’t find a clear mapping, the original string is passed through. pay_frequency: anyOf: - type: string enum: - DAILY - WEEKLY - BIWEEKLY - MONTHLY - SEMIMONTHLY - QUARTERLY - SEMIANNUALLY - ANNUALLY - PRO_RATA - type: string description: >- If we can't find a clear mapping: The original string passed through. - type: 'null' description: >- The time interval at which the employee receives payment. A `pay_rate` of `12000`, with a `pay_period` of `YEAR`, and a `pay_frequency` of `MONTHLY` would indicate that the employee is paid 1000 every month. 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. pay_currency: type: - string - 'null' description: >- The currency that the employee is paid in. Usually returned in [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html). effective_date: description: The date of when the employment started. 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 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. 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 required: - id - remote_id - employee_id - job_title - pay_rate - pay_currency - effective_date - changed_at - remote_deleted_at - remote_data - custom_fields - integration_fields examples: - id: 12vpXR7BeqYNWDShXRgsonnm remote_id: '859' employee_id: 26vafvWSRmbhNcxJYqjCzuJg job_title: Social Media Marketer pay_rate: 85000 pay_period: YEAR pay_frequency: SEMIMONTHLY employment_type: FULL_TIME pay_currency: EUR effective_date: '2021-01-30T00:00:00.000Z' changed_at: '2022-08-07T14:01:29.196Z' remote_deleted_at: null remote_data: null custom_fields: {} integration_fields: [] time_off_balances: type: array items: 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 - 'null' 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_id: type: string description: >- The Kombo ID of the employee to which the balance belongs to. The ID can be used to retrieve the employee from the `get employees` endpoint. type_id: type: string balance: type: - number - 'null' format: double minimum: -1.7976931348623157e+308 description: The amount of time available to the employee. balance_unit: type: - string - 'null' enum: - HOURS - DAYS description: The time-unit of the balance. 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 used: type: - number - 'null' format: double minimum: -1.7976931348623157e+308 description: The amount of time used by the employee. used_unit: type: - string - 'null' enum: - HOURS - DAYS description: The time-unit of the used time. 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_id - type_id - balance - balance_unit - changed_at - remote_deleted_at - used - used_unit - remote_data examples: - id: FuyRuk5NqP3qTcThED3ymTuE remote_id: '124123' employee_id: 2Up4ZCvq1bFVzmzXG6EWzV3j type_id: BQJaBxRCiqN46G27VTegvkEr balance: 14 balance_unit: DAYS changed_at: '2022-08-07T14:01:29.196Z' remote_deleted_at: null used: 3 used_unit: DAYS remote_data: null manager: type: - object - 'null' properties: first_name: type: - string - 'null' description: The employee’s first name. last_name: type: - string - 'null' description: The employee’s last name. 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`. 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. employee_number: type: - string - 'null' description: The employee’s organization-internal employee number. 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`. 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. 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. 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 required: - first_name - last_name - display_full_name - id - employee_number - remote_id - termination_date examples: - first_name: John last_name: Doe display_full_name: John Doe id: 26vafvWSRmbhNcxJYqjCzuJg employee_number: '3243422' work_email: john.doe@acme.com remote_id: '32' employment_status: INACTIVE termination_date: '2022-05-20T00:00:00.000Z' groups: type: array items: 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. name: type: - string - 'null' description: The name of the group. type: type: - string - 'null' enum: - DEPARTMENT - TEAM - COST_CENTER description: Type of the group. required: - id - remote_id - name - type examples: - id: 4B9bKBpX5tnwjiG93TAqF7ci remote_id: '49' name: Customer Success type: TEAM legal_entity: type: - object - 'null' 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 - 'null' 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. name: type: - string - 'null' description: The legal entity’s name. 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 legal entity’s address. required: - id - remote_id - name examples: - id: 4B9bKBpX5tnwjiG93TAqF7ci remote_id: '49' name: ACME Inc. address: city: Berlin country: DE raw: |- Sonnenallee 63 12045 Berlin, Berlin Germany state: Berlin street_1: Sonnenallee 63 street_2: null zip_code: '12045' teams: type: array items: 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. name: type: - string - 'null' description: The name of the group. type: type: - string - 'null' enum: - DEPARTMENT - TEAM - COST_CENTER description: Type of the group. required: - id - remote_id - name - type examples: - id: 4B9bKBpX5tnwjiG93TAqF7ci remote_id: '49' name: Customer Success type: TEAM description: >- **(⚠️ Deprecated - Please use `groups` instead. It includes the same data and the naming is less confusing.)** Maintained field for backwards compatibility. deprecated: true work_location: type: - object - 'null' 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 - 'null' 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. name: type: - string - 'null' description: The work location’s name 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 work location’s address type: type: - string - 'null' description: The work location’s type. A freeform string. 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 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 - name - type - changed_at - remote_deleted_at - remote_data examples: - id: 22st2Ji8XpncEYEak8mvQgQF remote_id: '1348' name: Kombo HQ address: city: Berlin country: DE raw: |- Sonnenallee 63 12045 Berlin, Berlin Germany state: Berlin street_1: Sonnenallee 63 street_2: null zip_code: '12045' type: OFFICE changed_at: '2022-08-07T14:01:29.196Z' remote_deleted_at: '2022-08-07T14:01:29.196Z' remote_data: null 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 - employments - time_off_balances - manager - groups - legal_entity - teams - work_location required: - next - results examples: - next: >- eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0= results: - 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 employments: - id: 12vpXR7BeqYNWDShXRgsonnm remote_id: '859' employee_id: 26vafvWSRmbhNcxJYqjCzuJg job_title: Social Media Marketer pay_rate: 85000 pay_period: YEAR pay_frequency: SEMIMONTHLY employment_type: FULL_TIME pay_currency: EUR effective_date: '2021-01-30T00:00:00.000Z' changed_at: '2022-08-07T14:01:29.196Z' remote_deleted_at: null remote_data: null custom_fields: {} integration_fields: [] time_off_balances: - id: FuyRuk5NqP3qTcThED3ymTuE remote_id: '124123' employee_id: 2Up4ZCvq1bFVzmzXG6EWzV3j type_id: BQJaBxRCiqN46G27VTegvkEr balance: 14 balance_unit: DAYS changed_at: '2022-08-07T14:01:29.196Z' remote_deleted_at: null used: 3 used_unit: DAYS remote_data: null manager: first_name: John last_name: Doe display_full_name: John Doe id: 26vafvWSRmbhNcxJYqjCzuJg employee_number: '3243422' work_email: john.doe@acme.com remote_id: '32' employment_status: INACTIVE termination_date: '2022-05-20T00:00:00.000Z' groups: - id: 4B9bKBpX5tnwjiG93TAqF7ci remote_id: '49' name: Customer Success type: TEAM legal_entity: id: 4B9bKBpX5tnwjiG93TAqF7ci remote_id: '49' name: ACME Inc. address: city: Berlin country: DE raw: |- Sonnenallee 63 12045 Berlin, Berlin Germany state: Berlin street_1: Sonnenallee 63 street_2: null zip_code: '12045' teams: - id: 4B9bKBpX5tnwjiG93TAqF7ci remote_id: '49' name: Customer Success type: TEAM work_location: id: 22st2Ji8XpncEYEak8mvQgQF remote_id: '1348' name: Kombo HQ address: city: Berlin country: DE raw: |- Sonnenallee 63 12045 Berlin, Berlin Germany state: Berlin street_1: Sonnenallee 63 street_2: null zip_code: '12045' type: OFFICE changed_at: '2022-08-07T14:01:29.196Z' remote_deleted_at: '2022-08-07T14:01:29.196Z' remote_data: null required: - status - data 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. ````