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

> Retrieves absence details within a date range, optionally restricted to specific persons through `resource_ids`. `time_range` will have a value if the absence does not cover the whole day.



## OpenAPI

````yaml 26.06.25 post /api/schedule/absences.list
openapi: 3.1.0
info:
  title: tipee
  version: 26.06.25
servers: []
security:
  - basicAuth: []
tags:
  - name: Activity
    description: Activity
  - name: Balances
    description: Balances
  - name: Directory
    description: Directory
  - name: Schedule
    description: Schedule
  - name: Timeclock
    description: Timeclock
paths:
  /api/schedule/absences.list:
    post:
      tags:
        - Schedule
      summary: List
      description: >-
        Retrieves absence details within a date range, optionally restricted to
        specific persons through `resource_ids`. `time_range` will have a value
        if the absence does not cover the whole day.
      operationId: post_app_ui_api_schedule_schedulequery_listabsences
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAbsencesQuery'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AbsenceView'
components:
  schemas:
    ListAbsencesQuery:
      required:
        - date_range
      properties:
        resource_ids:
          description: >-
            When omitted, the only absences returned are those the current user
            is allowed to view.
          type: array
          items:
            $ref: '#/components/schemas/Snowflake'
        date_range:
          $ref: '#/components/schemas/LocalDateInterval'
      type: object
    AbsenceView:
      required:
        - id
        - absence_type
        - resource_id
        - remark
        - date
        - percentage
        - time_range
        - repetition_id
      properties:
        id:
          $ref: '#/components/schemas/Snowflake'
        absence_type:
          $ref: '#/components/schemas/AbsenceTypeSummary'
        resource_id:
          $ref: '#/components/schemas/Snowflake'
        remark:
          anyOf:
            - $ref: '#/components/schemas/Redacted'
            - type: string
            - type: 'null'
        date:
          $ref: '#/components/schemas/LocalDate'
        percentage:
          anyOf:
            - $ref: '#/components/schemas/Redacted'
            - $ref: '#/components/schemas/Percentage'
        time_range:
          oneOf:
            - $ref: '#/components/schemas/LocalDateTimeInterval'
            - type: 'null'
        repetition_id:
          type:
            - integer
            - 'null'
      type: object
    Snowflake:
      type: string
      format: snowflake
      example: '872815618512410358'
    LocalDateInterval:
      type: string
      format: local-date-interval
      example: 2019-11-11/2019-12-12
    AbsenceTypeSummary:
      required:
        - id
        - name
        - short_name
        - machine_name
        - color
      properties:
        id:
          anyOf:
            - $ref: '#/components/schemas/Redacted'
            - $ref: '#/components/schemas/Snowflake'
        name:
          anyOf:
            - $ref: '#/components/schemas/Redacted'
            - type: string
        short_name:
          anyOf:
            - $ref: '#/components/schemas/Redacted'
            - type: string
        machine_name:
          anyOf:
            - $ref: '#/components/schemas/Redacted'
            - type: string
        color:
          anyOf:
            - $ref: '#/components/schemas/Redacted'
            - type: string
      type: object
    Redacted:
      required:
        - redacted
      properties:
        redacted:
          type: string
          example: forbidden
          enum:
            - forbidden
            - confidential
      type: object
      x-tipee-bindgen-redacted: true
    LocalDate:
      type: string
      format: local-date
      example: '2019-11-11'
    Percentage:
      type: number
      format: percentage
      example: 100
    LocalDateTimeInterval:
      type: string
      format: local-date-time-interval
      example: 2019-11-11T12:34:56/2019-12-12T23:59:59

````