> ## 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 schedule templates (or the ones corresponding to the provided ids).



## OpenAPI

````yaml 25.09.01 post /api/schedule/schedule-templates.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/schedule-templates.list:
    post:
      tags:
        - Schedule
      summary: List
      description: >-
        Retrieves all schedule templates (or the ones corresponding to the
        provided ids).
      operationId: post_app_ui_api_schedule_scheduletemplatequery_listscheduletemplates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListScheduleTemplatesQuery250901'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ScheduleTemplateView250901'
components:
  schemas:
    ListScheduleTemplatesQuery250901:
      properties:
        ids:
          type: array
          items:
            $ref: '#/components/schemas/Snowflake'
        team_ids:
          description: >-
            If used, it will limit the returned schedule template list to those
            that are associated with the given team ids (ignoring provided ids
            that are not).
          type: array
          items:
            $ref: '#/components/schemas/Snowflake'
        date_range:
          $ref: '#/components/schemas/LocalDateInterval'
        is_on_call:
          type: boolean
        type_ids:
          description: >-
            If used, it will limit the returned schedule template list to those
            that match one of the given schedule template type ids.
          type: array
          items:
            $ref: '#/components/schemas/Snowflake'
      type: object
    ScheduleTemplateView250901:
      required:
        - id
        - name
        - description
        - team_id
        - type
        - color
        - hour_ranges
        - adjustment
        - tag_ids
        - break_time
        - validity
        - options
      properties:
        id:
          $ref: '#/components/schemas/Snowflake'
        name:
          $ref: '#/components/schemas/TranslatedString'
        description:
          oneOf:
            - $ref: '#/components/schemas/TranslatedString'
            - type: 'null'
        team_id:
          $ref: '#/components/schemas/Snowflake'
        type:
          $ref: '#/components/schemas/ScheduleTemplateTypeView'
        color:
          type: string
        hour_ranges:
          type: array
          items:
            $ref: '#/components/schemas/HourRange'
        adjustment:
          oneOf:
            - $ref: '#/components/schemas/AdjustmentView'
            - type: 'null'
        tag_ids:
          type: array
          items:
            $ref: '#/components/schemas/Snowflake'
        break_time:
          oneOf:
            - $ref: '#/components/schemas/BreakTimeView'
            - type: 'null'
        validity:
          oneOf:
            - $ref: '#/components/schemas/LocalDateInterval'
            - type: 'null'
        options:
          $ref: '#/components/schemas/OptionsView'
      type: object
    Snowflake:
      type: string
      format: snowflake
      example: '872815618512410358'
    LocalDateInterval:
      type: string
      format: local-date-interval
      example: 2019-11-11/2019-12-12
    TranslatedString:
      properties:
        fr:
          type: string
        en:
          type: string
        de:
          type: string
      type: object
      example:
        en: Hello
        fr: Bonjour
        de: Guten Tag
    ScheduleTemplateTypeView:
      required:
        - id
        - name
        - machine_name
        - display_mode
        - is_on_call
      properties:
        id:
          $ref: '#/components/schemas/Snowflake'
        name:
          $ref: '#/components/schemas/TranslatedString'
        machine_name:
          type: string
        display_mode:
          $ref: '#/components/schemas/ScheduleTemplateTypeDisplayMode'
        is_on_call:
          type: boolean
      type: object
    HourRange:
      required:
        - hour_range
        - auto_correct
        - paid_break
      properties:
        hour_range:
          $ref: '#/components/schemas/LocalTimeInterval'
        auto_correct:
          oneOf:
            - $ref: '#/components/schemas/Autocorrect'
            - type: 'null'
        paid_break:
          oneOf:
            - $ref: '#/components/schemas/ScheduleTemplatePaidBreakTime'
            - type: 'null'
      type: object
    AdjustmentView:
      required:
        - value
        - time
      properties:
        value:
          $ref: '#/components/schemas/Duration'
        time:
          oneOf:
            - $ref: '#/components/schemas/LocalTime'
            - type: 'null'
      type: object
    BreakTimeView:
      required:
        - min_duration
        - hour_range
      properties:
        min_duration:
          $ref: '#/components/schemas/Duration'
        hour_range:
          $ref: '#/components/schemas/LocalTimeInterval'
      type: object
    OptionsView:
      required:
        - counts_in_balances
        - timecheck_counted
        - employee_resident_ratio
        - auto_completable
      properties:
        counts_in_balances:
          type: boolean
        timecheck_counted:
          type: boolean
        employee_resident_ratio:
          type: boolean
        auto_completable:
          type: boolean
      type: object
    ScheduleTemplateTypeDisplayMode:
      type: string
      example: normal
      enum:
        - normal
        - hour
        - corner
    LocalTimeInterval:
      type: string
      format: local-time-interval
      example: 12:34:56/PT2H
    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
    ScheduleTemplatePaidBreakTime:
      required:
        - max_duration
        - hour_range
      properties:
        max_duration:
          $ref: '#/components/schemas/Duration'
        hour_range:
          oneOf:
            - $ref: '#/components/schemas/LocalTimeInterval'
            - type: 'null'
      type: object
    Duration:
      description: '[ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations)'
      type: string
      format: duration
      example: PT1H30M20S
    LocalTime:
      type: string
      format: local-time
      example: '12:34:56'

````