> ## Documentation Index
> Fetch the complete documentation index at: https://api.tipee.ch/llms.txt
> Use this file to discover all available pages before exploring further.

# List timechecks

> Retrieves all timecheck details (or the ones corresponding to the provided ids).<br />Several filters can be used to narrow down the search.



## OpenAPI

````yaml 25.09.01 post /api/timeclock/timechecks.list
openapi: 3.1.0
info:
  title: tipee
  version: 25.09.01
servers: []
security:
  - basicAuth: []
tags:
  - name: Directory
    description: Directory
  - name: Schedule
    description: Schedule
  - name: Timeclock
    description: Timeclock
paths:
  /api/timeclock/timechecks.list:
    post:
      tags:
        - Timeclock
      summary: List timechecks
      description: >-
        Retrieves all timecheck details (or the ones corresponding to the
        provided ids).<br />Several filters can be used to narrow down the
        search.
      operationId: post_app_ui_api_timeclock_timeclockquery_listtimechecks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListTimechecksQuery250901'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TimecheckView250901'
components:
  schemas:
    ListTimechecksQuery250901:
      properties:
        filters:
          type: array
          items:
            $ref: '#/components/schemas/ListTimechecksQuery250901Filter'
      type: object
    TimecheckView250901:
      required:
        - id
        - resource_id
        - duration
        - time_range
        - expected_time_range
        - type
        - color
        - device
        - proposal
        - validation
        - is_adjusted
        - matched_schedule_ids
        - tags_comment
        - tags
      properties:
        id:
          $ref: '#/components/schemas/Snowflake'
        resource_id:
          $ref: '#/components/schemas/Snowflake'
        duration:
          oneOf:
            - $ref: '#/components/schemas/Duration'
            - type: 'null'
        time_range:
          $ref: '#/components/schemas/LocalDateTimeInterval'
        expected_time_range:
          $ref: '#/components/schemas/LocalDateTimeInterval'
        type:
          $ref: '#/components/schemas/TimecheckType'
        color:
          type: string
        device:
          $ref: '#/components/schemas/TimecheckDeviceView'
        proposal:
          oneOf:
            - $ref: '#/components/schemas/TimecheckTimeView'
            - type: 'null'
        validation:
          oneOf:
            - $ref: '#/components/schemas/TimecheckTimeView'
            - type: 'null'
        is_adjusted:
          type: boolean
        matched_schedule_ids:
          type: array
          items:
            $ref: '#/components/schemas/Snowflake'
        tags_comment:
          type:
            - string
            - 'null'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/TimecheckTagView250901'
      type: object
    ListTimechecksQuery250901Filter:
      discriminator:
        propertyName: key
      oneOf:
        - required:
            - key
            - value
          properties:
            key:
              type: string
              example: timecheck.ids
              enum:
                - timecheck.ids
            value:
              type: array
              items:
                $ref: '#/components/schemas/Snowflake'
          type: object
        - required:
            - key
            - value
          properties:
            key:
              type: string
              example: timecheck.resources
              enum:
                - timecheck.resources
            value:
              type: array
              items:
                $ref: '#/components/schemas/Snowflake'
          type: object
        - required:
            - key
            - value
          properties:
            key:
              type: string
              example: timecheck.date_range
              enum:
                - timecheck.date_range
            value:
              $ref: '#/components/schemas/LocalDateInterval'
          type: object
        - required:
            - key
            - value
          properties:
            key:
              type: string
              example: timecheck.datetime_range
              enum:
                - timecheck.datetime_range
            value:
              $ref: '#/components/schemas/LocalDateTimeInterval'
          type: object
        - required:
            - key
            - value
          properties:
            key:
              type: string
              example: timecheck.open
              enum:
                - timecheck.open
            value:
              type: boolean
          type: object
        - required:
            - key
            - value
          properties:
            key:
              type: string
              example: or
              enum:
                - or
            value:
              type: array
              items:
                $ref: '#/components/schemas/ListTimechecksQuery250901Filter'
          type: object
        - required:
            - key
            - value
          properties:
            key:
              type: string
              example: and
              enum:
                - and
            value:
              type: array
              items:
                $ref: '#/components/schemas/ListTimechecksQuery250901Filter'
          type: object
    Snowflake:
      type: string
      format: snowflake
      example: '872815618512410358'
    Duration:
      description: '[ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations)'
      type: string
      format: duration
      example: PT1H30M20S
    LocalDateTimeInterval:
      type: string
      format: local-date-time-interval
      example: 2019-11-11T12:34:56/2019-12-12T23:59:59
    TimecheckType:
      type: string
      example: device
      enum:
        - device
        - adjusted
        - proposal
        - validation
    TimecheckDeviceView:
      required:
        - in
        - out
      properties:
        in:
          oneOf:
            - $ref: '#/components/schemas/DeviceClockView'
            - type: 'null'
        out:
          oneOf:
            - $ref: '#/components/schemas/DeviceClockView'
            - type: 'null'
      type: object
    TimecheckTimeView:
      required:
        - resource_id
        - in
        - out
        - received_at
        - comment
      properties:
        resource_id:
          oneOf:
            - $ref: '#/components/schemas/Snowflake'
            - type: 'null'
        in:
          oneOf:
            - $ref: '#/components/schemas/LocalDateTime'
            - type: 'null'
        out:
          oneOf:
            - $ref: '#/components/schemas/LocalDateTime'
            - type: 'null'
        received_at:
          oneOf:
            - $ref: '#/components/schemas/Instant'
            - type: 'null'
        comment:
          type:
            - string
            - 'null'
          default: null
      type: object
    TimecheckTagView250901:
      required:
        - id
        - added_at
        - added_by
        - removed_at
        - removed_by
      properties:
        id:
          $ref: '#/components/schemas/Snowflake'
        added_at:
          $ref: '#/components/schemas/LocalDateTime'
        added_by:
          oneOf:
            - $ref: '#/components/schemas/Snowflake'
            - type: 'null'
        removed_at:
          oneOf:
            - $ref: '#/components/schemas/LocalDateTime'
            - type: 'null'
        removed_by:
          oneOf:
            - $ref: '#/components/schemas/Snowflake'
            - type: 'null'
      type: object
    LocalDateInterval:
      type: string
      format: local-date-interval
      example: 2019-11-11/2019-12-12
    DeviceClockView:
      required:
        - time
        - name
        - beacon_name
        - autocorrection
        - autocorrection_source
        - geolocation
        - received_at
      properties:
        time:
          $ref: '#/components/schemas/LocalDateTime'
        name:
          type:
            - string
            - 'null'
        beacon_name:
          type:
            - string
            - 'null'
        autocorrection:
          oneOf:
            - $ref: '#/components/schemas/LocalDateTime'
            - type: 'null'
        autocorrection_source:
          type:
            - string
            - 'null'
        geolocation:
          oneOf:
            - $ref: '#/components/schemas/Geolocation'
            - type: 'null'
        received_at:
          oneOf:
            - $ref: '#/components/schemas/Instant'
            - type: 'null'
      type: object
    LocalDateTime:
      type: string
      format: local-date-time
      example: '2019-11-11T12:34:56'
    Instant:
      type: string
      format: zoned-date-time
      example: '2025-10-30T10:40:22.01367Z'
    Geolocation:
      required:
        - latitude
        - longitude
        - accuracy
      properties:
        latitude:
          type:
            - number
            - 'null'
          format: float
          default: null
        longitude:
          type:
            - number
            - 'null'
          format: float
          default: null
        accuracy:
          type:
            - number
            - 'null'
          format: float
          default: null
      type: object

````