> ## 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 absences > Retrieve all absences. 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: GetHrisAbsences 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/GetHrisAbsencesParameterCursor' - name: page_size in: query required: false description: The number of results to return per page. Maximum is 250. schema: $ref: '#/components/schemas/GetHrisAbsencesParameterPageSize' - 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 | | --- | --- | --- | | `type` | 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/GetHrisAbsencesParameterUpdatedAfter' - 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/GetHrisAbsencesParameterIncludeDeleted' - 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/GetHrisAbsencesParameterIgnoreUnsupportedFilters - name: ids in: query required: false description: >- Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. schema: $ref: '#/components/schemas/GetHrisAbsencesParameterIds' - name: remote_ids in: query required: false description: Filter by a comma-separated list of remote IDs. schema: $ref: '#/components/schemas/GetHrisAbsencesParameterRemoteIds' - name: date_from in: query required: false description: >- Filter for all the absences that either start _or_ haven't ended yet on/after this day. If you imagine a calendar displaying absences, this defines the left-most visible day. This is a plain date (i.e., `yyyy-MM-dd`), all time information is discarded. schema: $ref: '#/components/schemas/GetHrisAbsencesParameterDateFrom' - name: date_until in: query required: false description: >- Filter for absences that start on or before this day (but might continue after). If you imagine a calendar displaying absences, this defines the right-most visible day. This is a plain date (i.e., `yyyy-MM-dd`), all time information is discarded. schema: $ref: '#/components/schemas/GetHrisAbsencesParameterDateUntil' - name: type_ids in: query required: false description: Filter by a comma-separated list of absence type IDs. schema: $ref: '#/components/schemas/GetHrisAbsencesParameterTypeIds' - name: employee_id in: query required: false description: Filter by a specific employee using their ID. schema: $ref: '#/components/schemas/GetHrisAbsencesParameterEmployeeId' - name: time_from in: query required: false description: >- **(⚠️ Deprecated - Use the `date_from` filter instead.)** Filter for absences that either start after or start before and end after a certain time. schema: $ref: '#/components/schemas/GetHrisAbsencesParameterTimeFrom' deprecated: true - name: time_until in: query required: false description: >- **(⚠️ Deprecated - Use the `date_until` filter instead.)** Filter for absences that start before a certain time. schema: $ref: '#/components/schemas/GetHrisAbsencesParameterTimeUntil' deprecated: true responses: '200': description: GET /hris/absences Positive response content: application/json: schema: $ref: '#/components/schemas/GetHrisAbsencesPositiveResponse' examples: example1: value: status: success data: next: >- eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0= results: - id: 22st2Ji8XpncEYEak8mvQgQF remote_id: '1348' employee_id: JDdUy9kiH5APaGizFrgNmQjM approver_id: AgXEispYPP1BbToHpqnqcpxy start_date: '2022-08-04' end_date: '2022-08-05' start_half_day: true end_half_day: false start_time: '13:15:00' end_time: '17:00:00' amount: 2 unit: DAYS status: APPROVED employee_note: Visiting my family. type_id: xzZoKssDaMZAd62kxayzzQvD remote_created_at: '2022-08-07T14:01:29.196Z' remote_updated_at: '2022-08-07T14:01:29.196Z' changed_at: '2022-08-07T14:01:29.196Z' remote_deleted_at: '2022-08-07T14:01:29.196Z' remote_data: null type: id: xzZoKssDaMZAd62kxayzzQvD remote_id: '91' name: Vacation unit: DAYS half_days_supported: true exact_times_supported: false remote_data: null changed_at: '2022-08-07T14:01:29.196Z' remote_deleted_at: null default: $ref: '#/components/responses/ErrorResponseHRIS' x-codeSamples: - lang: python label: GetHrisAbsences source: |- from kombo import Kombo with Kombo( integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28", api_key="", ) as k_client: res = k_client.hris.get_absences(page_size=100, include_deleted=False, ignore_unsupported_filters=False) while res is not None: # Handle items res = res.next() - lang: typescript label: GetHrisAbsences 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.getAbsences({}); for await (const page of result) { console.log(page); } } run(); - lang: ruby label: GetHrisAbsences 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_absences(page_size: 100, include_deleted: false, ignore_unsupported_filters: false) unless res.get_hris_absences_positive_response.nil? # handle response end components: schemas: GetHrisAbsencesParameterCursor: type: string description: >- An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. GetHrisAbsencesParameterPageSize: type: integer format: int64 minimum: 1 maximum: 250 default: 100 description: The number of results to return per page. Maximum is 250. GetHrisAbsencesParameterUpdatedAfter: 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 | | --- | --- | --- | | `type` | 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 GetHrisAbsencesParameterIncludeDeleted: 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. GetHrisAbsencesParameterIgnoreUnsupportedFilters: 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. GetHrisAbsencesParameterIds: type: string description: >- Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. GetHrisAbsencesParameterRemoteIds: type: string description: Filter by a comma-separated list of remote IDs. GetHrisAbsencesParameterDateFrom: description: >- Filter for all the absences that either start _or_ haven't ended yet on/after this day. If you imagine a calendar displaying absences, this defines the left-most visible day. 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 GetHrisAbsencesParameterDateUntil: description: >- Filter for absences that start on or before this day (but might continue after). If you imagine a calendar displaying absences, this defines the right-most visible day. 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 GetHrisAbsencesParameterTypeIds: type: string description: Filter by a comma-separated list of absence type IDs. GetHrisAbsencesParameterEmployeeId: type: string description: Filter by a specific employee using their ID. GetHrisAbsencesParameterTimeFrom: description: >- **(⚠️ Deprecated - Use the `date_from` filter instead.)** Filter for absences that either start after or start before and end after a certain time. 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 deprecated: true GetHrisAbsencesParameterTimeUntil: description: >- **(⚠️ Deprecated - Use the `date_until` filter instead.)** Filter for absences that start before a certain time. 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 deprecated: true GetHrisAbsencesPositiveResponse: 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 employee to which the absence belongs to. The ID can be used to retrieve the employee from the `get employees` endpoint. approver_id: type: - string - 'null' description: >- **(⚠️ Deprecated - We won't increase coverage for this feature)** The Kombo ID of the employee who is responsible for approving this absence. deprecated: true start_date: description: The date this absence starts in the `yyyy-MM-dd` format. type: 'null' end_date: description: The date this absence ends in the `yyyy-MM-dd` format. type: 'null' start_half_day: type: - boolean - 'null' description: >- `true` if the absence starts in the middle of the day, `false` if not, and `null` if the absence type doesn't support half-day absences. For multi-day absences, this only applies to the first day of the absence. end_half_day: type: - boolean - 'null' description: >- `true` if the absence ends in the middle of the day, `false` if not, and `null` if the absence type doesn't support half-day absences. For multi-day absences, this only applies to the last day of the absence. start_time: description: >- The time at which this absence starts. Follows the format `HH:mm:ss` (e.g., `14:45:15`). type: 'null' end_time: description: >- The time at which this absence ends. Follows the format `HH:mm:ss` (e.g., `14:45:15`). type: 'null' amount: type: - number - 'null' format: double minimum: -1.7976931348623157e+308 description: The amount of time this absence takes. unit: type: - string - 'null' enum: - HOURS - DAYS description: >- The unit of time for this absence. Can be `HOURS` or `DAYS`. status: anyOf: - type: string enum: - REQUESTED - APPROVED - DECLINED - CANCELLED - DELETED - type: string description: >- If we can't find a clear mapping: The original string passed through. - type: 'null' description: >- The absence’s current status. In rare cases where we can’t find a clear mapping, the original string is passed through. employee_note: type: - string - 'null' description: A note the employee has added to this absence. type_id: type: - string - 'null' description: The Kombo absence type ID of this absence. 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 remote_updated_at: description: >- A timestamp retrieved from the remote system, describing when the resource was last updated. 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. type: 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 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 absence’s name. unit: type: - string - 'null' enum: - HOURS - DAYS description: The time-unit of the absence. half_days_supported: type: - boolean - 'null' description: >- Whether the integration supports half-day absences (represented through `start_half_day` and `end_half_day`) for this absence type. exact_times_supported: type: - boolean - 'null' description: >- `true` if the system supports exact times (absences with a `start_time` and an `end_time`) for this absence, `false` if not. 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. 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 required: - id - remote_id - name - unit - half_days_supported - exact_times_supported - remote_data - changed_at - remote_deleted_at examples: - id: xzZoKssDaMZAd62kxayzzQvD remote_id: '91' name: Vacation unit: DAYS half_days_supported: true exact_times_supported: false remote_data: null changed_at: '2022-08-07T14:01:29.196Z' remote_deleted_at: null required: - id - remote_id - employee_id - approver_id - start_date - end_date - start_half_day - end_half_day - start_time - end_time - amount - unit - employee_note - type_id - remote_created_at - remote_updated_at - changed_at - remote_deleted_at - remote_data - type required: - next - results examples: - next: >- eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0= results: - id: 22st2Ji8XpncEYEak8mvQgQF remote_id: '1348' employee_id: JDdUy9kiH5APaGizFrgNmQjM approver_id: AgXEispYPP1BbToHpqnqcpxy start_date: '2022-08-04' end_date: '2022-08-05' start_half_day: true end_half_day: false start_time: '13:15:00' end_time: '17:00:00' amount: 2 unit: DAYS status: APPROVED employee_note: Visiting my family. type_id: xzZoKssDaMZAd62kxayzzQvD remote_created_at: '2022-08-07T14:01:29.196Z' remote_updated_at: '2022-08-07T14:01:29.196Z' changed_at: '2022-08-07T14:01:29.196Z' remote_deleted_at: '2022-08-07T14:01:29.196Z' remote_data: null type: id: xzZoKssDaMZAd62kxayzzQvD remote_id: '91' name: Vacation unit: DAYS half_days_supported: true exact_times_supported: false remote_data: null changed_at: '2022-08-07T14:01:29.196Z' remote_deleted_at: 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. ````