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

> List the occurrences of special days (bank holidays and other days marked in the schedule) over a period.

<Warning>This endpoint is in preview: it may change without notice until it becomes part of a stable version.</Warning>


## OpenAPI

````yaml preview post /api/schedule/special-days.list
openapi: 3.1.0
info:
  title: tipee
  version: preview
servers: []
security:
  - basicAuth: []
tags:
  - name: Activity
    description: Activity
  - name: Balances
    description: Balances
  - name: Directory
    description: Directory
  - name: Schedule
    description: Schedule
  - name: Security
    description: Security
  - name: Timeclock
    description: Timeclock
paths:
  /api/schedule/special-days.list:
    post:
      tags:
        - Schedule
      summary: List
      description: >-
        List the occurrences of special days (bank holidays and other days
        marked in the schedule) over a period.
      operationId: post_app_ui_api_schedule_specialdayquery_listspecialdays
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListSpecialDaysQuery'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SpecialDayView'
components:
  schemas:
    ListSpecialDaysQuery:
      properties:
        date_range:
          $ref: '#/components/schemas/LocalDateInterval'
          description: >-
            When the range spans more than 10 years and part of it extends
            outside the planning period (2005 to 10 years after the current
            year), the part in question is left out.
        team_ids:
          description: >-
            Also returns the special days defined on the ancestors of these
            teams, as they apply to them.
          type: array
          items:
            $ref: '#/components/schemas/Snowflake'
        type_ids:
          type: array
          items:
            $ref: '#/components/schemas/Snowflake'
      type: object
    SpecialDayView:
      required:
        - id
        - date
        - name
        - validity_date_range
        - type_id
        - team_ids
        - skipped
      properties:
        id:
          $ref: '#/components/schemas/Snowflake'
        date:
          $ref: '#/components/schemas/LocalDate'
        name:
          $ref: '#/components/schemas/TranslatedString'
        validity_date_range:
          $ref: '#/components/schemas/LocalDateInterval'
        type_id:
          $ref: '#/components/schemas/Snowflake'
        team_ids:
          description: >-
            Every team the special day is defined on. A day defined on the whole
            instance carries the instance team.
          type: array
          items:
            $ref: '#/components/schemas/Snowflake'
        skipped:
          description: >-
            An official bank holiday that is only observed in some years and
            does not apply in this one.
          type: boolean
      type: object
    LocalDateInterval:
      type: string
      format: local-date-interval
      example: 2019-11-11/2019-12-12
    Snowflake:
      type: string
      format: snowflake
      example: '872815618512410358'
    LocalDate:
      type: string
      format: local-date
      example: '2019-11-11'
    TranslatedString:
      properties:
        fr:
          type: string
        en:
          type: string
        de:
          type: string
      type: object
      example:
        en: Hello
        fr: Bonjour
        de: Guten Tag

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.