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

> Get timesheets

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

  <ul>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/personio/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/personio">Personio</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/workday/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/workday">Workday</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/successfactors/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/successfactors">SAP SuccessFactors</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/ukgprowfm/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/ukgprowfm">UKG Pro WFM</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/ukgready/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/ukgready">UKG Ready</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/bamboohr/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/bamboohr">BambooHR</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/oraclehcm/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/oraclehcm">Oracle HCM</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/paylocity/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/paylocity">Paylocity</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/paycom/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/paycom">Paycom</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/sandbox/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/sandbox">Kombo Sandbox</a></li>
  </ul>

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

Retrieve attendance data and timesheets from HRIS tools.

<Warning>**Open Beta Feature:** This endpoint is currently in beta. Please reach out to our support team if you need assistance with implementation.</Warning>

For a detailed explanation of the data model, validation rules, time zones, payable hours, approvals, and break patterns, see the [Time & Attendance guide](/hris/features/time-and-attendance).

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)`


## OpenAPI

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


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

        This feature is currently available for the following integrations:


        <ul>

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

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

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

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

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

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

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

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

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

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

        </ul>


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

        We're always happy to discuss extending our coverage.

        </Accordion>



        Retrieve attendance data and timesheets from HRIS tools.


        <Warning>**Open Beta Feature:** This endpoint is currently in beta.
        Please reach out to our support team if you need assistance with
        implementation.</Warning>


        For a detailed explanation of the data model, validation rules, time
        zones, payable hours, approvals, and break patterns, see the [Time &
        Attendance guide](/hris/features/time-and-attendance).


        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: GetHrisTimesheets
      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/GetHrisTimesheetsParameterCursor'
        - name: page_size
          in: query
          required: false
          description: The number of results to return per page. Maximum is 250.
          schema:
            $ref: '#/components/schemas/GetHrisTimesheetsParameterPageSize'
        - 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/GetHrisTimesheetsParameterUpdatedAfter'
        - 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/GetHrisTimesheetsParameterIncludeDeleted'
        - 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/GetHrisTimesheetsParameterIgnoreUnsupportedFilters
        - name: ids
          in: query
          required: false
          description: >-
            Filter by a comma-separated list of IDs such as
            `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`.
          schema:
            $ref: '#/components/schemas/GetHrisTimesheetsParameterIds'
        - name: remote_ids
          in: query
          required: false
          description: Filter by a comma-separated list of remote IDs.
          schema:
            $ref: '#/components/schemas/GetHrisTimesheetsParameterRemoteIds'
        - name: employee_id
          in: query
          required: false
          description: Returns timesheets for a specific employee.
          schema:
            $ref: '#/components/schemas/GetHrisTimesheetsParameterEmployeeId'
        - name: started_before
          in: query
          required: false
          description: Return timesheets whose start time is before the given timestamp.
          schema:
            $ref: '#/components/schemas/GetHrisTimesheetsParameterStartedBefore'
        - name: started_after
          in: query
          required: false
          description: >-
            Return timesheets whose start time is on or after the given
            timestamp.
          schema:
            $ref: '#/components/schemas/GetHrisTimesheetsParameterStartedAfter'
        - name: ended_before
          in: query
          required: false
          description: >-
            Return timesheets whose end time is on or before the given
            timestamp.
          schema:
            $ref: '#/components/schemas/GetHrisTimesheetsParameterEndedBefore'
        - name: ended_after
          in: query
          required: false
          description: Return timesheets whose end time is on or after the given timestamp.
          schema:
            $ref: '#/components/schemas/GetHrisTimesheetsParameterEndedAfter'
      responses:
        '200':
          description: GET /hris/timesheets Positive response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetHrisTimesheetsPositiveResponse'
              examples:
                example1:
                  value:
                    status: success
                    data:
                      next: >-
                        eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=
                      results:
                        - id: C1BB1C36-FE1D-4185-AAB8-0716D8FBA017
                          remote_id: '446655440000'
                          employee_id: 289AD550-8659-4305-92B2-6EAA006AAB17
                          started_at: '2025-04-16T09:02:00.000Z'
                          ended_at: '2025-04-16T16:59:00.000Z'
                          timezone: '-04:00'
                          payable_hours: 8
                          unpaid_break_minutes: 30
                          breaks:
                            - ended_at: '2025-04-16T12:30:00.000Z'
                              paid: false
                              started_at: '2025-04-16T12:00:00.000Z'
                          approval_status: APPROVED
                          approved_at: '2025-04-16T17:05:31.000Z'
                          comment: Sprint planning & code review
                          custom_fields: {}
                          integration_fields: []
                          changed_at: '2022-08-07T14:01:29.196Z'
                          remote_deleted_at: null
                          remote_data: {}
        default:
          $ref: '#/components/responses/ErrorResponseHRIS'
      x-codeSamples:
        - lang: python
          label: GetHrisTimesheets
          source: |-
            from kombo import Kombo


            with Kombo(
                integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28",
                api_key="<YOUR_BEARER_TOKEN_HERE>",
            ) as k_client:

                res = k_client.hris.get_timesheets(page_size=100, include_deleted=False, ignore_unsupported_filters=False)

                while res is not None:
                    # Handle items

                    res = res.next()
        - lang: typescript
          label: GetHrisTimesheets
          source: |-
            import { Kombo } from "@kombo-api/sdk";

            const kombo = new Kombo({
              integration_id: "workday:HWUTwvyx2wLoSUHphiWVrp28",
              api_key: "<YOUR_BEARER_TOKEN_HERE>",
            });

            async function run() {
              const result = await kombo.hris.getTimesheets({});

              for await (const page of result) {
                console.log(page);
              }
            }

            run();
        - lang: ruby
          label: GetHrisTimesheets
          source: >-
            require 'kombo'


            Models = ::Kombo::Models

            s = ::Kombo::Kombo.new(
              integration_id: 'workday:HWUTwvyx2wLoSUHphiWVrp28',
              security: Models::Shared::Security.new(
                api_key: '<YOUR_BEARER_TOKEN_HERE>'
              )
            )

            res = s.hris.get_timesheets(page_size: 100, include_deleted: false,
            ignore_unsupported_filters: false)


            unless res.get_hris_timesheets_positive_response.nil?
              # handle response
            end
components:
  schemas:
    GetHrisTimesheetsParameterCursor:
      type: string
      description: >-
        An optional cursor string used for pagination. This can be retrieved
        from the `next` property of the previous page response.
    GetHrisTimesheetsParameterPageSize:
      type: integer
      format: int64
      minimum: 1
      maximum: 250
      default: 100
      description: The number of results to return per page. Maximum is 250.
    GetHrisTimesheetsParameterUpdatedAfter:
      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
    GetHrisTimesheetsParameterIncludeDeleted:
      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.
    GetHrisTimesheetsParameterIgnoreUnsupportedFilters:
      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.
    GetHrisTimesheetsParameterIds:
      type: string
      description: >-
        Filter by a comma-separated list of IDs such as
        `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`.
    GetHrisTimesheetsParameterRemoteIds:
      type: string
      description: Filter by a comma-separated list of remote IDs.
    GetHrisTimesheetsParameterEmployeeId:
      type: string
      description: Returns timesheets for a specific employee.
    GetHrisTimesheetsParameterStartedBefore:
      description: Return timesheets whose start time is before the given timestamp.
      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
    GetHrisTimesheetsParameterStartedAfter:
      description: Return timesheets whose start time is on or after the given timestamp.
      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
    GetHrisTimesheetsParameterEndedBefore:
      description: Return timesheets whose end time is on or before the given timestamp.
      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
    GetHrisTimesheetsParameterEndedAfter:
      description: Return timesheets whose end time is on or after the given timestamp.
      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
    GetHrisTimesheetsPositiveResponse:
      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 timesheet
                      belongs. The ID can be used to retrieve the employee from
                      the `get employees` endpoint.
                  started_at:
                    description: Start time of the shift, converted into UTC time zone.
                    type:
                      - string
                      - 'null'
                    format: date-time
                    externalDocs:
                      url: >-
                        https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
                  ended_at:
                    description: End time of the shift, converted into UTC time zone.
                    type:
                      - string
                      - 'null'
                    format: date-time
                    externalDocs:
                      url: >-
                        https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
                  timezone:
                    type:
                      - string
                      - 'null'
                    pattern: ^[+-](?:0\d|1[0-4]):[0-5]\d$
                    description: >-
                      The ISO 8601 numeric UTC offset of the timesheet location
                      in the format ±HH:MM (e.g., "+02:00", "-05:30"). If null,
                      the original offset information was not available. You can
                      use this to display the right timezone for the timesheet
                      in the UI.
                  payable_hours:
                    type:
                      - number
                      - 'null'
                    format: double
                    minimum: -1.7976931348623157e+308
                    description: >-
                      Payable hours including grace periods - only if available
                      in the HRIS. Won't be calculated through Kombo.
                  unpaid_break_minutes:
                    type:
                      - number
                      - 'null'
                    format: double
                    minimum: -1.7976931348623157e+308
                    description: >-
                      Unpaid break in minutes - will be from the HRIS or
                      calculated by Kombo if we have concrete unpaid break
                      times.
                  breaks:
                    type:
                      - array
                      - 'null'
                    items:
                      type: object
                      properties:
                        ended_at:
                          anyOf:
                            - description: YYYY-MM-DDTHH:mm:ss.sssZ
                              type: string
                              format: date-time
                              externalDocs:
                                url: >-
                                  https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
                            - type: string
                              format: date-time
                              pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?Z$
                          description: End time of the break.
                        paid:
                          type: boolean
                          description: Whether the break is paid or unpaid.
                        started_at:
                          anyOf:
                            - description: YYYY-MM-DDTHH:mm:ss.sssZ
                              type: string
                              format: date-time
                              externalDocs:
                                url: >-
                                  https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
                            - type: string
                              format: date-time
                              pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?Z$
                          description: Start time of the break.
                      required:
                        - ended_at
                        - paid
                        - started_at
                    description: Concrete times of the breaks.
                  approval_status:
                    type:
                      - string
                      - 'null'
                    description: >-
                      Approval status of the shift. Can be PENDING, APPROVED,
                      REJECTED, or null.
                  approved_at:
                    description: The time when the shift was approved.
                    type:
                      - string
                      - 'null'
                    format: date-time
                    externalDocs:
                      url: >-
                        https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
                  comment:
                    type:
                      - string
                      - 'null'
                    description: Comment on the shift.
                  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
                  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
                  - employee_id
                  - started_at
                  - ended_at
                  - timezone
                  - payable_hours
                  - unpaid_break_minutes
                  - approval_status
                  - approved_at
                  - comment
                  - custom_fields
                  - integration_fields
                  - changed_at
                  - remote_deleted_at
                  - remote_data
                examples:
                  - id: C1BB1C36-FE1D-4185-AAB8-0716D8FBA017
                    remote_id: '446655440000'
                    employee_id: 289AD550-8659-4305-92B2-6EAA006AAB17
                    started_at: '2025-04-16T09:02:00.000Z'
                    ended_at: '2025-04-16T16:59:00.000Z'
                    timezone: '-04:00'
                    payable_hours: 8
                    unpaid_break_minutes: 30
                    breaks:
                      - ended_at: '2025-04-16T12:30:00.000Z'
                        paid: false
                        started_at: '2025-04-16T12:00:00.000Z'
                    approval_status: APPROVED
                    approved_at: '2025-04-16T17:05:31.000Z'
                    comment: Sprint planning & code review
                    custom_fields: {}
                    integration_fields: []
                    changed_at: '2022-08-07T14:01:29.196Z'
                    remote_deleted_at: null
                    remote_data: {}
          required:
            - next
            - results
          examples:
            - next: >-
                eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=
              results:
                - id: C1BB1C36-FE1D-4185-AAB8-0716D8FBA017
                  remote_id: '446655440000'
                  employee_id: 289AD550-8659-4305-92B2-6EAA006AAB17
                  started_at: '2025-04-16T09:02:00.000Z'
                  ended_at: '2025-04-16T16:59:00.000Z'
                  timezone: '-04:00'
                  payable_hours: 8
                  unpaid_break_minutes: 30
                  breaks:
                    - ended_at: '2025-04-16T12:30:00.000Z'
                      paid: false
                      started_at: '2025-04-16T12:00:00.000Z'
                  approval_status: APPROVED
                  approved_at: '2025-04-16T17:05:31.000Z'
                  comment: Sprint planning & code review
                  custom_fields: {}
                  integration_fields: []
                  changed_at: '2022-08-07T14:01:29.196Z'
                  remote_deleted_at: null
                  remote_data: {}
      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.

````