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

# List transition tracker entries

> The session must have schools assigned. Results are restricted to those schools; an optional school_id narrows this scope and must be assigned to the session. Student transition date, destination room, days until transition, and alert information.



## OpenAPI

````yaml /openapi.yaml get /transition_tracker
openapi: 3.1.0
info:
  title: Primula Tracker API V3
  version: 3.0.0
  description: >-
    Reference for the 66 operations registered under `/primula/api/v3` in the V3
    release baseline.


    ## Authentication

    Create a session with `POST /sessions`, then send `Authorization: Bearer
    <access_token>` on protected operations. Tokens must remain associated with
    a valid server-side session. The returned refresh token has no refresh
    endpoint in V3. Session company and school restrictions are documented per
    operation; company_id is not inferred from the token.


    ## Responses and errors

    Collections generally return bare JSON arrays and items return bare JSON
    objects. Report objects, nested maps, and update summaries are explicitly
    described below. List metadata travels in response headers rather than an
    envelope. Empty lists written by collection helpers are `[]`; fields backed
    by nullable values may be `null`, and omitted properties are distinguished
    from null properties in schemas. Handlers generally return `{ "error":
    "message" }`; authentication middleware and activity proxy errors use plain
    text. Unsupported methods on a registered path return 405 with Allow after
    any applicable authentication checks.


    ## Pagination and projections

    Only operations documenting page/per_page support pagination. Defaults are
    page=1 and per_page=100. Values exceeding the documented effective cap are
    clamped, not rejected. X-Total-Count describes the full matching set. Link
    contains applicable navigation links and is omitted for a single page.
    Aggregates use limit (default 50, effective cap 200) instead of pagination
    and send X-Truncated only when rows were omitted. The fields parameter,
    where available, selects the exact response properties; unsupported fields
    return 400.


    ## Query encoding

    Multi-value parameters documented as arrays accept repeated keys or
    comma-separated values. Prefer repeated keys for long UUID lists. Except for
    the two activity proxy operations, query parsing drops the entire query
    string above 8192 bytes and truncates each decoded query value to 128 bytes.
    Parameter combinations and interpretation differ by resource and
    representation; consult each operation. Unknown parameters are rejected only
    where explicitly documented.


    ## Dates and writes

    Calendar dates use YYYY-MM-DD, monthly periods use YYYY-MM, and timestamp
    formats are described in the corresponding schema. Defaults such as today
    depend on the server clock. PATCH operations change only the documented
    properties and reject unknown body properties. Clearing values,
    authorization, and partial-write behavior vary by resource and are described
    per operation.


    Examples use synthetic identifiers and placeholder tokens. Replace the
    server host before using an interactive API client.
servers:
  - url: https://{host}/primula/api/v3
    description: V3 API deployment. Replace the placeholder hostname.
    variables:
      host:
        default: api.example.com
security:
  - bearerAuth: []
tags:
  - name: sessions
    description: Sessions.
  - name: schools
    description: Schools.
  - name: companies
    description: Companies.
  - name: rooms
    description: Rooms.
  - name: users
    description: Users.
  - name: gusto_companies
    description: Gusto companies.
  - name: gusto_employees
    description: Gusto employees.
  - name: gusto_contractors
    description: Gusto contractors.
  - name: gusto_payrolls
    description: Gusto payrolls.
  - name: procare_staff
    description: Procare staff.
  - name: efficiency_ratios
    description: Efficiency ratios.
  - name: enrollment_tracker
    description: Enrollment tracker.
  - name: classroom_attendance
    description: Classroom attendance.
  - name: absences
    description: Absences.
  - name: billing_attendance_audits
    description: Billing attendance audits.
  - name: data_refresh
    description: Data refresh.
  - name: waitlist
    description: Waitlist.
  - name: sibling_discounts
    description: Sibling discounts.
  - name: new_start_tracker
    description: New start tracker.
  - name: withdrawal_tracker
    description: Withdrawal tracker.
  - name: transition_tracker
    description: Transition tracker.
  - name: enrollments
    description: Enrollments.
  - name: pre_registration_fallout
    description: Pre registration fallout.
  - name: procare_messages
    description: Procare messages.
  - name: activities_summary
    description: Activities summary.
  - name: activity_details
    description: Activity details.
  - name: leads
    description: Leads.
  - name: students
    description: Students.
  - name: payments
    description: Payments.
  - name: family_balances
    description: Family balances.
  - name: attendances
    description: Attendances.
  - name: billing_plans
    description: Billing plans.
  - name: spaces
    description: Spaces.
paths:
  /transition_tracker:
    get:
      tags:
        - transition_tracker
      summary: List transition tracker entries
      description: >-
        The session must have schools assigned. Results are restricted to those
        schools; an optional school_id narrows this scope and must be assigned
        to the session. Student transition date, destination room, days until
        transition, and alert information.
      operationId: GetTransitionTrackerV3
      parameters:
        - $ref: '#/components/parameters/CompanyId'
        - name: school_id
          in: query
          required: false
          description: >-
            School UUID. Must be assigned to the authenticated session. Omit to
            use the operation's documented company/session scope.
          schema:
            type: string
            format: uuid
          example: 22222222-2222-4222-8222-222222222222
        - name: ems_student_status
          in: query
          required: false
          description: Optional onboarding status, matched case-insensitively.
          schema:
            type: string
            enum:
              - Enrolled
              - Registration Pending
              - Confirmed Start Date
              - Waitlist
              - Missing Information
              - Withdrawn
              - Unknown
              - Empty
        - name: has_alerts
          in: query
          required: false
          description: >-
            Return only entries with alerts when true; false leaves all entries
            eligible. Accepts true/1 and false/0, case-insensitive.
          schema:
            type: boolean
            default: false
        - name: sort_by
          in: query
          required: false
          description: Sort by a supported column with an _asc or _desc suffix.
          schema:
            type: string
            enum:
              - name_asc
              - name_desc
              - school_name_asc
              - school_name_desc
              - status_asc
              - status_desc
              - onboarding_status_asc
              - onboarding_status_desc
              - room_asc
              - room_desc
              - room_program_asc
              - room_program_desc
              - dob_asc
              - dob_desc
              - admission_date_asc
              - admission_date_desc
              - transition_date_asc
              - transition_date_desc
              - transition_room_asc
              - transition_room_desc
              - days_to_transition_date_asc
              - days_to_transition_date_desc
              - withdrawal_date_asc
              - withdrawal_date_desc
            default: days_to_transition_date_asc
        - name: page
          in: query
          required: false
          description: 'One-based page number. '
          schema:
            type: integer
            minimum: 1
            default: 1
          example: 1
        - name: per_page
          in: query
          required: false
          description: 'Items per page; values greater than 500 are clamped to 500. '
          schema:
            type: integer
            minimum: 1
            default: 100
          example: 100
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TransitionStudent'
              example: []
          headers:
            X-Total-Count:
              $ref: '#/components/headers/TotalCount'
            Link:
              $ref: '#/components/headers/Link'
            X-Has-Alerts:
              $ref: '#/components/headers/HasAlerts'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '405':
          $ref: '#/components/responses/405'
        '500':
          $ref: '#/components/responses/500'
components:
  parameters:
    CompanyId:
      name: company_id
      in: query
      required: true
      description: >-
        Company UUID. Must equal the authenticated session company when that
        session has a company assigned; the equality check is skipped for
        sessions without one.
      schema:
        type: string
        format: uuid
      example: 11111111-1111-4111-8111-111111111111
  schemas:
    TransitionStudent:
      type: object
      properties:
        student_id:
          type: string
          description: Student id.
        student_name:
          type: string
        school_id:
          type: string
          description: School id.
        school_name:
          type: string
        procare_student_status:
          type: string
        ems_student_status:
          type: string
        room_id:
          type: string
          description: Room id.
        room_name:
          type: string
        room_program:
          type: string
        room_changed_at:
          type: string
        dob:
          type: string
        admission_date:
          type: string
        enrollment_id:
          type: string
          description: Enrollment id.
        transition_date:
          type: string
        transition_date_2:
          type: string
        withdrawal_date:
          type: string
        transition_room_id:
          type: string
          description: Transition room id.
        transition_room_name:
          type: string
        transition_room_program:
          type: string
        days_to_transition_date:
          type: integer
        billing_plan:
          type: string
        transition_alert:
          type: string
        transition_alert_1_clear_user_id:
          type: string
          description: Transition alert 1 clear user id.
        transition_alert_2_clear_user_id:
          type: string
          description: Transition alert 2 clear user id.
        change_room_in_procare:
          type: string
        inconsistent_dates:
          type: boolean
        transition_date_is_past_date:
          type: boolean
        review_transition_date:
          type: boolean
        ems_status_missing_info:
          type: boolean
        transition_date_auto_assigned:
          type: boolean
        transition_room_earlier:
          type: boolean
        missing_transition_room:
          type: boolean
        missing_active_plan:
          type: boolean
        start_date_close_no_plan:
          type: boolean
        current_room_is_transition_room:
          type: boolean
        alerts:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/Alert'
      required:
        - student_id
        - student_name
        - school_id
        - school_name
        - procare_student_status
        - ems_student_status
        - room_id
        - room_name
        - room_program
        - room_changed_at
        - dob
        - admission_date
        - enrollment_id
        - transition_date
        - transition_date_2
        - withdrawal_date
        - transition_room_id
        - transition_room_name
        - transition_room_program
        - days_to_transition_date
        - billing_plan
        - transition_alert
        - transition_alert_1_clear_user_id
        - transition_alert_2_clear_user_id
        - change_room_in_procare
        - inconsistent_dates
        - transition_date_is_past_date
        - review_transition_date
        - ems_status_missing_info
        - transition_date_auto_assigned
        - transition_room_earlier
        - missing_transition_room
        - missing_active_plan
        - start_date_close_no_plan
        - current_room_is_transition_room
        - alerts
      description: Transition Student.
    Alert:
      type: object
      properties:
        id:
          type: string
        level:
          type: integer
        description:
          type: string
      required:
        - id
        - level
        - description
      description: Alert.
    Error:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error message.
      required:
        - error
      description: Error.
  headers:
    TotalCount:
      description: >-
        Total matching rows before pagination, or matching groups before the
        aggregate limit. For unpaginated arrays, the number of returned rows.
      schema:
        type: integer
        minimum: 0
      example: 125
    Link:
      description: >-
        Pagination links using rel="next", "last", "prev", and "first". Only
        applicable links are sent; absent when all results fit on one page.
        Links preserve the original query parameters.
      schema:
        type: string
      example: >-
        </primula/api/v3/students?company_id=11111111-1111-4111-8111-111111111111&page=2>;
        rel="next"
    HasAlerts:
      description: >-
        Present with value true when the underlying collection reports alerts.
        Computed for the collection before pagination; absent otherwise.
      schema:
        type: boolean
      example: true
  responses:
    '400':
      description: Invalid or missing parameters or request body.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Invalid or missing parameters or request body.
    '401':
      description: >-
        Missing or invalid Bearer token, or an absent, invalid or expired
        server-side session. The authentication middleware returns plain text
        with a trailing newline.
      content:
        text/plain:
          schema:
            type: string
          examples:
            missing:
              value: |
                missing authorization header
            invalid:
              value: |
                Unauthorized
            expired:
              value: |
                Session expired
    '403':
      description: The authenticated session is not allowed to perform this operation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: >-
              The authenticated session is not allowed to perform this
              operation.
    '405':
      description: The path exists but does not support this HTTP method.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: The path exists but does not support this HTTP method.
      headers:
        Allow:
          description: Comma-separated HTTP methods accepted by this path.
          schema:
            type: string
    '500':
      description: The operation could not be completed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: The operation could not be completed.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Access token issued by POST /sessions and associated with a valid
        server-side session.

````

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