> ## 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 employments > Retrieve all employments. 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. 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: GetHrisEmployments 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/GetHrisEmploymentsParameterCursor' - name: page_size in: query required: false description: The number of results to return per page. Maximum is 250. schema: $ref: '#/components/schemas/GetHrisEmploymentsParameterPageSize' - 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, only changes to the returned record itself are considered. schema: $ref: '#/components/schemas/GetHrisEmploymentsParameterUpdatedAfter' - 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/GetHrisEmploymentsParameterIncludeDeleted' - 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/GetHrisEmploymentsParameterIgnoreUnsupportedFilters - name: ids in: query required: false description: >- Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. schema: $ref: '#/components/schemas/GetHrisEmploymentsParameterIds' - name: remote_ids in: query required: false description: Filter by a comma-separated list of remote IDs. schema: $ref: '#/components/schemas/GetHrisEmploymentsParameterRemoteIds' responses: '200': description: GET /hris/employments Positive response content: application/json: schema: $ref: '#/components/schemas/GetHrisEmploymentsPositiveResponse' examples: example1: value: status: success data: next: >- eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0= results: - 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: [] default: $ref: '#/components/responses/ErrorResponseHRIS' x-codeSamples: - lang: python label: GetHrisEmployments source: |- from kombo import Kombo with Kombo( integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28", api_key="", ) as k_client: res = k_client.hris.get_employments(page_size=100, include_deleted=False, ignore_unsupported_filters=False) while res is not None: # Handle items res = res.next() - lang: typescript label: GetHrisEmployments 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.getEmployments({}); for await (const page of result) { console.log(page); } } run(); - lang: ruby label: GetHrisEmployments 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_employments(page_size: 100, include_deleted: false, ignore_unsupported_filters: false) unless res.get_hris_employments_positive_response.nil? # handle response end components: schemas: GetHrisEmploymentsParameterCursor: type: string description: >- An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. GetHrisEmploymentsParameterPageSize: type: integer format: int64 minimum: 1 maximum: 250 default: 100 description: The number of results to return per page. Maximum is 250. GetHrisEmploymentsParameterUpdatedAfter: 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, only changes to the returned record itself are considered. 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 GetHrisEmploymentsParameterIncludeDeleted: 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. GetHrisEmploymentsParameterIgnoreUnsupportedFilters: 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. GetHrisEmploymentsParameterIds: type: string description: >- Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. GetHrisEmploymentsParameterRemoteIds: type: string description: Filter by a comma-separated list of remote IDs. GetHrisEmploymentsPositiveResponse: 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 - '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: [] required: - next - results examples: - next: >- eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0= results: - 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: [] 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. ````