> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.sesametime.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Shift Assignments in Planner

> Returns paginated list of active shift assignments (drafts) for a planner



## OpenAPI

````yaml GET /schedule/v1/planners/{plannerId}/shift-assignments
openapi: 3.0.0
info:
  description: ''
  version: 3.0.0
  title: Sesame Public API
servers:
  - url: https://api-{region}.sesametime.com
    variables:
      region:
        default: eu1
security: []
tags: []
paths:
  /schedule/v1/planners/{plannerId}/shift-assignments:
    get:
      tags:
        - Planners
      summary: List Shift Assignments in Planner
      description: >-
        Returns paginated list of active shift assignments (drafts) for a
        planner
      operationId: ListShiftAssignmentsInPlanner
      parameters:
        - in: path
          name: plannerId
          required: true
          description: The planner ID
          schema:
            type: string
            format: uuid
        - in: query
          name: from
          description: Filter by date greater than or equal (Y-m-d)
          schema:
            type: string
            format: date
            example: '2026-02-01'
        - in: query
          name: to
          description: Filter by date less than or equal (Y-m-d)
          schema:
            type: string
            format: date
            example: '2026-02-28'
        - in: query
          name: employeeId[in]
          description: Filter by employee IDs (comma-separated UUIDs)
          schema:
            type: string
        - in: query
          name: type
          description: Filter by assignment type. Omit to return both.
          schema:
            type: string
            enum:
              - shift
              - freeDay
        - name: page
          in: query
          description: Request a specific page
          schema:
            type: integer
            default: 1
        - in: query
          name: limit
          description: Items per page
          schema:
            type: integer
            default: 20
      responses:
        '200':
          description: Array of Objects
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: The shift assignment or free day ID
                        employeeId:
                          type: string
                          format: uuid
                          description: The employee ID
                        shiftId:
                          type: string
                          format: uuid
                          nullable: true
                          description: The shift ID (null for free days)
                        shiftName:
                          type: string
                          nullable: true
                          description: The shift name (null for free days)
                        date:
                          type: string
                          format: date
                          description: The assignment date
                          example: '2026-02-10'
                        createdAt:
                          type: string
                          format: date-time
                          description: Creation timestamp (ISO 8601)
                        updatedAt:
                          type: string
                          format: date-time
                          description: Last update timestamp (ISO 8601)
                        type:
                          type: string
                          enum:
                            - shift
                            - freeDay
                          description: >-
                            The assignment type: 'shift' for shift assignments,
                            'freeDay' for free days
                        comments:
                          type: string
                          nullable: true
                          description: Free day comments (null for shifts)
                        ranges:
                          type: array
                          nullable: true
                          description: Free day time ranges (null for shifts)
                          items:
                            type: object
                            properties:
                              from:
                                type: string
                                example: '09:00'
                              to:
                                type: string
                                example: '14:00'
                  meta:
                    type: object
                    properties:
                      currentPage:
                        type: integer
                        example: 1
                      lastPage:
                        type: integer
                        example: 1
                      total:
                        type: integer
                        example: 1
                      perPage:
                        type: integer
                        example: 1
      security:
        - Bearer: []
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````