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

> Retrieve all details of duty schedules for specific individuals during a given period. You will only see the on-call schedules of individuals whose schedules you are allowed to view.



## OpenAPI

````yaml 26.06.25 post /api/schedule/on-calls.list
openapi: 3.1.0
info:
  title: tipee
  version: 26.06.25
servers: []
security:
  - basicAuth: []
tags:
  - name: Activity
    description: Activity
  - name: Balances
    description: Balances
  - name: Directory
    description: Directory
  - name: Schedule
    description: Schedule
  - name: Timeclock
    description: Timeclock
paths:
  /api/schedule/on-calls.list:
    post:
      tags:
        - Schedule
      summary: List
      description: >-
        Retrieve all details of duty schedules for specific individuals during a
        given period. You will only see the on-call schedules of individuals
        whose schedules you are allowed to view.
      operationId: post_app_ui_api_schedule_schedulequery_listoncall
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListOnCallsQuery'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OnCallView'
components:
  schemas:
    ListOnCallsQuery:
      required:
        - date_range
      properties:
        resource_ids:
          type: array
          items:
            $ref: '#/components/schemas/Snowflake'
        date_range:
          $ref: '#/components/schemas/LocalDateInterval'
        team_ids:
          type: array
          items:
            $ref: '#/components/schemas/Snowflake'
      type: object
    OnCallView:
      required:
        - id
        - resource_id
        - team_id
        - time_range
        - schedule_template
        - remark
      properties:
        id:
          $ref: '#/components/schemas/Snowflake'
        resource_id:
          $ref: '#/components/schemas/Snowflake'
        team_id:
          $ref: '#/components/schemas/Snowflake'
        time_range:
          $ref: '#/components/schemas/LocalDateTimeInterval'
        schedule_template:
          oneOf:
            - $ref: '#/components/schemas/ScheduleTemplateSummary'
            - type: 'null'
        remark:
          type:
            - string
            - 'null'
      type: object
    Snowflake:
      type: string
      format: snowflake
      example: '872815618512410358'
    LocalDateInterval:
      type: string
      format: local-date-interval
      example: 2019-11-11/2019-12-12
    LocalDateTimeInterval:
      type: string
      format: local-date-time-interval
      example: 2019-11-11T12:34:56/2019-12-12T23:59:59
    ScheduleTemplateSummary:
      required:
        - id
        - name
        - description
        - color
      properties:
        id:
          $ref: '#/components/schemas/Snowflake'
        name:
          type: string
        description:
          type:
            - string
            - 'null'
        color:
          type: string
      type: object

````