> ## 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 special day types (for example bank holiday).

<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-day-types.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-day-types.list:
    post:
      tags:
        - Schedule
      summary: List
      description: List the special day types (for example bank holiday).
      operationId: post_app_ui_api_schedule_specialdayquery_listspecialdaytypes
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListSpecialDayTypesQuery'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SpecialDayTypeView'
components:
  schemas:
    ListSpecialDayTypesQuery:
      properties:
        enabled:
          description: >-
            If left undefined, disabled types are listed too, as existing
            special days may still carry them.
          type: boolean
      type: object
    SpecialDayTypeView:
      required:
        - id
        - label
        - enabled
        - is_bank_holiday_type
      properties:
        id:
          $ref: '#/components/schemas/Snowflake'
        label:
          $ref: '#/components/schemas/TranslatedString'
        enabled:
          type: boolean
        is_bank_holiday_type:
          description: >-
            The bank holiday type is the only one whose days may be official
            bank holidays, and the only one balances take into account.
          type: boolean
      type: object
    Snowflake:
      type: string
      format: snowflake
      example: '872815618512410358'
    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.