> ## 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 all schedules (or the ones corresponding to the provided `ids`) within a date range.



## OpenAPI

````yaml 25.09.01 post /api/schedule/schedules.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/schedule/schedules.list:
    post:
      tags:
        - Schedule
      summary: List
      description: >-
        Retrieves all schedules (or the ones corresponding to the provided
        `ids`) within a date range.
      operationId: post_app_ui_api_schedule_schedulequery_listschedules
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListSchedulesQuery250901'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ScheduleView250901'
components:
  schemas:
    ListSchedulesQuery250901:
      required:
        - date_range
      properties:
        ids:
          type: array
          items:
            $ref: '#/components/schemas/Snowflake'
        resource_ids:
          description: >-
            If used with `ids` filter, it will limit the returned schedules to
            those that are associated with the given resource ids (ignoring
            schedule ids that are not).
          type: array
          items:
            $ref: '#/components/schemas/Snowflake'
        date_range:
          $ref: '#/components/schemas/LocalDateInterval'
      type: object
    ScheduleView250901:
      required:
        - id
        - resource_id
        - team_id
        - time_ranges
        - schedule_template
        - remark
        - modified
        - adjustment
        - break_time
        - options
      properties:
        id:
          $ref: '#/components/schemas/Snowflake'
        resource_id:
          $ref: '#/components/schemas/Snowflake'
        team_id:
          $ref: '#/components/schemas/Snowflake'
        time_ranges:
          type: array
          items:
            $ref: '#/components/schemas/TimeRange'
        schedule_template:
          oneOf:
            - $ref: '#/components/schemas/ScheduleTemplateSummary'
            - type: 'null'
        remark:
          type: string
        modified:
          type: boolean
        adjustment:
          oneOf:
            - $ref: '#/components/schemas/ScheduleAdjustment'
            - type: 'null'
        break_time:
          oneOf:
            - $ref: '#/components/schemas/ScheduleBreakTime'
            - type: 'null'
        options:
          $ref: '#/components/schemas/OptionsView250901'
      type: object
    Snowflake:
      type: string
      format: snowflake
      example: '872815618512410358'
    LocalDateInterval:
      type: string
      format: local-date-interval
      example: 2019-11-11/2019-12-12
    TimeRange:
      required:
        - time_range
        - auto_correct
        - paid_break
      properties:
        time_range:
          $ref: '#/components/schemas/LocalDateTimeInterval'
        auto_correct:
          oneOf:
            - $ref: '#/components/schemas/Autocorrect'
            - type: 'null'
        paid_break:
          oneOf:
            - $ref: '#/components/schemas/SchedulePaidBreakTime'
            - type: 'null'
      type: object
    ScheduleTemplateSummary:
      required:
        - id
        - name
        - description
        - color
      properties:
        id:
          $ref: '#/components/schemas/Snowflake'
        name:
          type: string
        description:
          type:
            - string
            - 'null'
        color:
          type: string
      type: object
    ScheduleAdjustment:
      required:
        - value
        - time
      properties:
        value:
          $ref: '#/components/schemas/Duration'
        time:
          oneOf:
            - $ref: '#/components/schemas/LocalDateTime'
            - type: 'null'
      type: object
    ScheduleBreakTime:
      required:
        - min_duration
        - time_range
      properties:
        min_duration:
          $ref: '#/components/schemas/Duration'
        time_range:
          $ref: '#/components/schemas/LocalDateTimeInterval'
      type: object
    OptionsView250901:
      required:
        - employee_resident_ratio
        - text_color
        - special_hours
      properties:
        employee_resident_ratio:
          type: boolean
        text_color:
          type:
            - string
            - 'null'
        special_hours:
          oneOf:
            - $ref: '#/components/schemas/LocalDateTimeInterval'
            - type: 'null'
      type: object
    LocalDateTimeInterval:
      type: string
      format: local-date-time-interval
      example: 2019-11-11T12:34:56/2019-12-12T23:59:59
    Autocorrect:
      required:
        - before_start
        - after_start
        - before_end
        - after_end
      properties:
        before_start:
          oneOf:
            - $ref: '#/components/schemas/Duration'
            - type: 'null'
        after_start:
          oneOf:
            - $ref: '#/components/schemas/Duration'
            - type: 'null'
        before_end:
          oneOf:
            - $ref: '#/components/schemas/Duration'
            - type: 'null'
        after_end:
          oneOf:
            - $ref: '#/components/schemas/Duration'
            - type: 'null'
      type: object
    SchedulePaidBreakTime:
      required:
        - max_duration
        - time_range
      properties:
        max_duration:
          $ref: '#/components/schemas/Duration'
        time_range:
          oneOf:
            - $ref: '#/components/schemas/LocalDateTimeInterval'
            - type: 'null'
      type: object
    Duration:
      description: '[ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations)'
      type: string
      format: duration
      example: PT1H30M20S
    LocalDateTime:
      type: string
      format: local-date-time
      example: '2019-11-11T12:34:56'

````