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

> Lists the indemnities of the instance. An indemnity restricted only to teams the caller cannot view the indemnities of is left out.

> [!WARNING]
>
> This endpoint is in preview: it may change without notice until it becomes part of a stable version.


## OpenAPI

````yaml preview post /api/balances/indemnities.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: Document
    description: Document
  - name: Expenses
    description: Expenses
  - name: Instance
    description: Instance
  - name: Schedule
    description: Schedule
  - name: Security
    description: Security
  - name: Timeclock
    description: Timeclock
paths:
  /api/balances/indemnities.list:
    post:
      tags:
        - Balances
      summary: List
      description: >-
        Lists the indemnities of the instance. An indemnity restricted only to
        teams the caller cannot view the indemnities of is left out.
      operationId: post_app_ui_api_balances_indemnities_indemnityquery_listindemnities
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListIndemnitiesQuery'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndemnityView'
components:
  schemas:
    ListIndemnitiesQuery:
      properties:
        ids:
          type: array
          items:
            $ref: '#/components/schemas/Snowflake'
        enabled:
          type: boolean
        validity_date_range:
          $ref: '#/components/schemas/LocalDateInterval'
          description: Keeps the indemnities applying over at least one day of the range.
      type: object
      additionalProperties: false
    IndemnityView:
      required:
        - id
        - label
        - description
        - enabled
        - validity_date_range
        - team_ids
        - exported
        - output_format
      properties:
        id:
          $ref: '#/components/schemas/Snowflake'
        label:
          $ref: '#/components/schemas/TranslatedString'
        description:
          oneOf:
            - $ref: '#/components/schemas/TranslatedString'
            - type: 'null'
        enabled:
          type: boolean
        validity_date_range:
          $ref: '#/components/schemas/LocalDateInterval'
          description: >-
            The period the indemnity applies over, an open end being written `-`
            (e.g. `2025-01-01/-`).
        team_ids:
          description: >-
            The teams the indemnity is restricted to, among those the caller can
            view the indemnities of. Null when it applies to every team.
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/Snowflake'
        exported:
          description: Included in the payroll export.
          type: boolean
        output_format:
          $ref: '#/components/schemas/OutputFormat'
          description: >-
            The unit of the indemnity values: the one of its counter, or hours
            for an indemnity based on a calculation that sets none.
      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
      additionalProperties: false
    OutputFormat:
      type: string
      example: days
      enum:
        - days
        - hours
        - units

````

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