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

# Get the day workout-execution screen

> Returns a workout day identified by the assigned plan templateId and planMomentId. Selects an active in_progress or paused session, otherwise the latest completed session. Stopped and cancelled attempts are excluded. Without an eligible session, session is null and resumeState is create. resumeState is create, start, continue, or completed; requiresResumePrompt is true only for continue. Existing confirmationToken and confirmationTokenExpiresAt can be returned with requiresConfirmation; submit the token with resumeAction: continue or restart to the session-start endpoint. day.progress includes completed sessions. Exercises are grouped as standalone exercise entries or supersets with members in data. Per-set prescriptions prefill only before logging; later responses use the saved rows and preserve deleted sets. hasHistory includes eligible completed-session sets, while previous excludes the displayed session. Per-set hints use repsPlaceholderCoach, weightPlaceholderCoach, timeSecondsPlaceholderCoach, distanceMetersPlaceholderCoach, rpePlaceholderCoach, and restSecondsPlaceholderCoach, plus the corresponding fields without the Coach suffix. Coach prescriptions take precedence; client hints are used only when no coach value exists. Untracked metrics, extra sets, and missing prescriptions return null for the coach hint. Weight hints and targetWeight use targetSnapshot.todayTarget unless a newer prescription applies. Hints never count toward totals, volume, personal records, or completion. To record a hint, submit its numeric value with completed: true; a rep range must be replaced with a numeric value because completed ranges are interpreted as their minimum. An uncompleted set uses null metrics and completed: false.

Requires the `workout_client_plans:read` scope and the corresponding Workout features and permissions.

The clientId path parameter identifies a client in the company bound to the Public API token.



## OpenAPI

````yaml /openapi/public-v1.json get /public/v1/workout/clients/{clientId}/plans/template/{templateId}/day/{planMomentId}/workout
openapi: 3.1.0
info:
  title: FITsociety Public API v1
  version: 1.0.0
  description: >-
    Integrate with FITsociety through `/public/v1`. Use OAuth client credentials
    to obtain a Bearer access token, then call the endpoints available to the
    authenticated company and granted scopes.
  contact:
    name: FITsociety Engineering
servers:
  - url: https://api.fitsociety.io
    description: Production
security: []
tags:
  - name: Health
    description: Public API token health checks.
  - name: OAuth
    description: Public API OAuth endpoints for server-to-server client credentials.
  - name: Platform
    description: Inspect Public API client context, capabilities, scopes, and audit logs.
  - name: Company Catalog
    description: Read and manage company profile metadata and locations.
  - name: Clients
    description: >-
      Create and manage clients through the Public API using Bearer access
      tokens.
  - name: Coaches
    description: Retrieve coaches for the authenticated company via integrations.
  - name: Calendar Events
    description: Read Public API calendar events.
  - name: Calendar Templates
    description: >-
      Read and manage event types and event templates used by calendar
      availability and bookings.
  - name: Calendar Extensions
    description: >-
      Read recurring bookings, booking requests, calendar tasks, and
      availability closure metadata.
  - name: Availability
    description: Read bookable availability slots and signed availability tokens.
  - name: Availability Management
    description: >-
      Manage coach and location availability templates used to derive bookable
      slots.
  - name: Bookings
    description: Read and manage Public API bookings.
  - name: Finance
    description: >-
      Read invoices, transactions, products, subscriptions, and memberships, and
      manage finance actions.
  - name: Credits
    description: >-
      Read company-wide and client-scoped credit allocations and mutations, and
      adjust credits.
  - name: Exports
    description: >-
      Create and monitor asynchronous company exports through Public API Bearer
      endpoints.
  - name: Webhooks
    description: >-
      Manage outbound webhook subscriptions and inspect delivery attempts
      through Public API Bearer endpoints.
  - name: Measurements
    description: Read and write client measurement entries.
  - name: Progress Photos
    description: Read client progress photo metadata and short-lived signed media URLs.
  - name: Forms
    description: Read, create, update, and archive company form templates.
  - name: Intakes
    description: Assign intake forms and read client intake assignments and submissions.
  - name: Check-ups
    description: >-
      Schedule and cancel client check-ups and read their status and
      submissions.
  - name: Documents
    description: >-
      Read client document and folder metadata, register external document
      links, update metadata, and archive documents from Public API listings.
      Binary upload, permanent deletion, and company-wide document management
      are not exposed.
  - name: Habits
    description: Read habits and habit entries.
  - name: Goals
    description: Read client goal summaries.
  - name: Conversations
    description: >-
      Read and manage direct and group chat conversations through the Public
      API.
  - name: Reports
    description: Read aggregate attendance, revenue, and retention summaries.
  - name: Workout
    description: >-
      Workout libraries, programmes, client plans, calendars, sessions, groups,
      settings and progress. AI operations are excluded.
paths:
  /public/v1/workout/clients/{clientId}/plans/template/{templateId}/day/{planMomentId}/workout:
    get:
      tags:
        - Workout
      summary: Get the day workout-execution screen
      description: >-
        Returns a workout day identified by the assigned plan templateId and
        planMomentId. Selects an active in_progress or paused session, otherwise
        the latest completed session. Stopped and cancelled attempts are
        excluded. Without an eligible session, session is null and resumeState
        is create. resumeState is create, start, continue, or completed;
        requiresResumePrompt is true only for continue. Existing
        confirmationToken and confirmationTokenExpiresAt can be returned with
        requiresConfirmation; submit the token with resumeAction: continue or
        restart to the session-start endpoint. day.progress includes completed
        sessions. Exercises are grouped as standalone exercise entries or
        supersets with members in data. Per-set prescriptions prefill only
        before logging; later responses use the saved rows and preserve deleted
        sets. hasHistory includes eligible completed-session sets, while
        previous excludes the displayed session. Per-set hints use
        repsPlaceholderCoach, weightPlaceholderCoach,
        timeSecondsPlaceholderCoach, distanceMetersPlaceholderCoach,
        rpePlaceholderCoach, and restSecondsPlaceholderCoach, plus the
        corresponding fields without the Coach suffix. Coach prescriptions take
        precedence; client hints are used only when no coach value exists.
        Untracked metrics, extra sets, and missing prescriptions return null for
        the coach hint. Weight hints and targetWeight use
        targetSnapshot.todayTarget unless a newer prescription applies. Hints
        never count toward totals, volume, personal records, or completion. To
        record a hint, submit its numeric value with completed: true; a rep
        range must be replaced with a numeric value because completed ranges are
        interpreted as their minimum. An uncompleted set uses null metrics and
        completed: false.


        Requires the `workout_client_plans:read` scope and the corresponding
        Workout features and permissions.


        The clientId path parameter identifies a client in the company bound to
        the Public API token.
      operationId: >-
        publicWorkoutgetPublicV1WorkoutClientsClientIdPlansTemplateTemplateIdDayPlanMomentIdWorkout
      parameters:
        - in: path
          name: templateId
          required: true
          description: Assigned workout plan id.
          schema:
            type: string
            example: 67f1234567890abcdef1234
        - in: path
          name: planMomentId
          required: true
          description: Plan moment (day) id.
          schema:
            type: string
            example: 67f1234567890abcdef1234
        - in: query
          name: clientId
          required: false
          schema:
            type: string
            example: 67f1234567890abcdef1234
          description: Identifies a client in the company bound to the Public API token.
        - in: query
          name: programmeScheduleItemId
          required: false
          schema:
            type: string
            example: 67f1234567890abcdef1234
          description: >-
            Calendar schedule item id. Must be supplied together with
            `plannedDate`; omit both for legacy plan-moment behavior.
        - in: query
          name: plannedDate
          required: false
          schema:
            type: string
            format: date
            pattern: ^\d{4}-\d{2}-\d{2}$
            example: '2026-09-08'
          description: >-
            Exact company-local occurrence date. Must be supplied together with
            `programmeScheduleItemId`.
        - name: clientId
          in: path
          required: true
          schema:
            type: string
            pattern: ^[a-fA-F0-9]{24}$
          description: Client in the company bound to the Public API token.
      responses:
        '200':
          description: Day workout-execution payload.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PublicApiSuccessResponse'
                  - type: object
                    properties:
                      data:
                        $ref: >-
                          #/components/schemas/PublicWorkoutSourceGETAppV1WorkoutPlansClientTemplateTemplateIdDayPlanMomentIdWorkoutResponse200
              examples:
                success:
                  summary: Successful response
                  value:
                    data:
                      plan:
                        _id: 67f1234567890abcdef1234
                        name: Weekly Strength Program
                        description: Progressive overload.
                        thumbnail: https://cdn.example.com/workouts/cover.jpg
                        difficulty: Intermediate
                        intensity: High
                        category: Strength
                        goal: Strength
                      day:
                        planMomentId: 67f1234567890abcdef1234
                        name: Day 1 – Upper Body
                        description: ''
                        dayOrder: 1
                        scoring:
                          scoringType: forTime
                          descriptionOnly: true
                          acceptsManualResult: true
                          targetValue: null
                          timeDomain:
                            windowSeconds: null
                            timeCapSeconds: 900
                            rounds: 3
                            intervalSeconds: null
                            intervalCount: null
                            workSeconds: null
                            restSeconds: null
                          scoreValidation:
                            timeCapSeconds: 900
                            maxReps: null
                            expectedIntervals: null
                          result:
                            roundsCompleted: 5
                            repsPerRound: 30
                            extraReps: 12
                            totalReps: 162
                            intervalReps:
                              - 12
                              - 11
                              - 10
                            elapsedSeconds: 742
                            finishedBeforeCap: true
                            timeCapSeconds: 900
                            maxLoadKg: 120
                        progress:
                          total: 6
                          completed: 2
                          progressPercentage: 33
                          isCompleted: false
                      stats:
                        durationMinutes: 0
                        exerciseCount: 0
                        expectedDurationMinutes: 110
                      exercises:
                        - type: exercise
                          planExerciseId: 67f1234567890abcdef1234
                          exerciseId: 67f1234567890abcdef1234
                          name: Dumbbell Bench Press
                          thumbnail: https://cdn.example.com/exercises/bench.jpg
                          media:
                            - type: image
                              url: https://cdn.example.com/ex/bench.jpg
                              platform: null
                              videoId: null
                              thumbnail: null
                              duration: null
                              width: 1080
                              height: 720
                          primaryMuscle: Chest
                          secondaryMuscles:
                            - Triceps
                          equipment:
                            - Dumbbell
                          groupId: ''
                          order: 0
                          isFavourite: false
                          hasHistory: false
                          targets:
                            type: reps
                            sets: 4
                            reps: 8–12
                            rest: 60
                            rpe: 8
                            rmPercentage: 0
                            tempo: ''
                            notes: Keep elbows tucked.
                          previousBestSet: 12 × 24kg
                          performanceId: 67f1234567890abcdef1234
                          isCompleted: false
                          clientNotes: ''
                          clientRestSeconds: null
                          notes: ''
                          sets:
                            - setNumber: 1
                              setType: 'N'
                              displayNumber: 1
                              displayLabel: '1'
                              previous: 12 × 22kg
                              reps: 10
                              weight: 22
                              timeSeconds: null
                              distanceMeters: null
                              rpe: null
                              completed: false
                          exerciseCount: 2
                          rounds: 4
                          data:
                            - id: 67f1234567890abcdef1234
                              name: Barbell Bench Press
                              primaryMuscle: Chest
                              secondaryMuscles:
                                - Chest
                              primaryJoint: Shoulder
                              equipment:
                                - Dumbbells
                              difficulty: Intermediate
                              intensity: Above Average
                              visibility: Company
                              tags:
                                - string
                              thumbnail: >-
                                https://cdn.example.com/exercises/bench-thumb.jpg
                      session:
                        id: 67f1234567890abcdef1234
                        status: in_progress
                        startedAt: '2026-04-12T10:00:00.000Z'
                        programmeScheduleItemId: 67f1234567890abcdef1234
                        plannedDate: '2026-09-08'
                      resumeState: create
                      requiresResumePrompt: false
                      requiresConfirmation: false
                      confirmationToken: null
                      confirmationTokenExpiresAt: null
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '400':
          description: >-
            Malformed template id (`INVALID_TEMPLATE_ID`), malformed day id
            (`INVALID_PLAN_ID`), company context missing
            (`COMPANY_ID_REQUIRED`), invalid client id (`INVALID_CLIENT_ID`),
            incomplete occurrence linkage
            (`PROGRAMME_OCCURRENCE_LINKAGE_INCOMPLETE`), invalid assigned-plan
            lifecycle (`PROGRAMME_ASSIGNED_PLAN_REQUIRED`), or an occurrence
            that does not exactly match the workout item, date, and assignment
            duration (`PROGRAMME_WORKOUT_OCCURRENCE_INVALID`).
          x-errorCodes:
            - INVALID_TEMPLATE_ID
            - INVALID_PLAN_ID
            - COMPANY_ID_REQUIRED
            - INVALID_CLIENT_ID
            - PROGRAMME_OCCURRENCE_LINKAGE_INCOMPLETE
            - PROGRAMME_ASSIGNED_PLAN_REQUIRED
            - PROGRAMME_WORKOUT_OCCURRENCE_INVALID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                invalidRequest:
                  summary: Invalid request
                  value:
                    error:
                      code: 400
                      key: request.invalid
                      message: The request is invalid.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '401':
          $ref: '#/components/schemas/ErrorResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                missingBearer:
                  summary: Missing Bearer token
                  value:
                    error:
                      code: 401
                      key: auth.missing_bearer
                      message: Authorization Bearer token is required.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
                invalidToken:
                  summary: Invalid or expired token
                  value:
                    error:
                      code: 401
                      key: auth.invalid_token
                      message: The access token is invalid or expired.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
                invalidClient:
                  summary: Inactive or revoked client
                  value:
                    error:
                      code: 401
                      key: auth.invalid_client
                      message: The Public API client is inactive or revoked.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '403':
          description: >-
            Flexible programme or linked occurrence execution is disabled for
            the active company (`WORKOUT_V2_PROGRAMME_CALENDAR_DISABLED`),
            except an active same-company occurrence session that is being
            resumed.
          x-errorCodes:
            - WORKOUT_V2_PROGRAMME_CALENDAR_DISABLED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                insufficientScopes:
                  summary: Missing required scope
                  value:
                    error:
                      code: 403
                      key: scopes.insufficient
                      message: The access token does not include the required scope.
                      details:
                        requiredScopes:
                          - workout_client_plans:read
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '404':
          description: >-
            Plan not found (`TEMPLATE_NOT_FOUND`) or the day was not found
            (`PLANMOMENT_NOT_FOUND`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                notFound:
                  summary: Resource not found
                  value:
                    error:
                      code: 404
                      key: resource.not_found
                      message: The requested Public API resource was not found.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '409':
          description: >-
            The requested occurrence belongs to a programme week that is not
            available yet (`PROGRAMME_WEEK_NOT_AVAILABLE`).
          x-errorCodes:
            - PROGRAMME_WEEK_NOT_AVAILABLE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                idempotencyConflict:
                  summary: Idempotency-Key conflict
                  value:
                    error:
                      code: 409
                      key: idempotency.conflict
                      message: >-
                        Idempotency-Key was already used with a different
                        request.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
                idempotencyInProgress:
                  summary: Idempotency-Key in progress
                  value:
                    error:
                      code: 409
                      key: idempotency.in_progress
                      message: >-
                        Idempotency-Key is already processing for this Public
                        API client.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '422':
          $ref: '#/components/schemas/ErrorResponse'
        '429':
          $ref: '#/components/schemas/ErrorResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                rateLimitExceeded:
                  summary: Rate limit exceeded
                  value:
                    error:
                      code: 429
                      key: rate_limit.exceeded
                      message: Too many Public API requests. Retry later.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 0
                        resetSeconds: 1
                        retryAfterSeconds: 1
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                serverInternalError:
                  summary: Unexpected server error
                  value:
                    error:
                      code: 500
                      key: server.internal_error
                      message: An unexpected Public API server error occurred.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
      security:
        - PublicBearerAuth: []
      x-codeSamples:
        - lang: cURL
          label: cURL
          source: >-
            curl -X GET
            "https://api.fitsociety.io/public/v1/workout/clients/{clientId}/plans/template/{templateId}/day/{planMomentId}/workout"
            \
              -H "Authorization: Bearer <access_token>"
components:
  schemas:
    PublicApiSuccessResponse:
      type: object
      additionalProperties: false
      required:
        - data
        - meta
      properties:
        data:
          type: object
        meta:
          $ref: '#/components/schemas/PublicApiMeta'
    PublicWorkoutSourceGETAppV1WorkoutPlansClientTemplateTemplateIdDayPlanMomentIdWorkoutResponse200:
      type: object
      properties:
        plan:
          type: object
          properties:
            _id:
              type: string
              example: 67f1234567890abcdef1234
            name:
              type: string
              example: Weekly Strength Program
            description:
              type: string
              example: Progressive overload.
            thumbnail:
              type: string
              example: https://cdn.example.com/workouts/cover.jpg
            difficulty:
              type: string
              example: Intermediate
            intensity:
              type: string
              example: High
            category:
              type: string
              example: Strength
            goal:
              type: string
              example: Strength
        day:
          type: object
          properties:
            planMomentId:
              type: string
              example: 67f1234567890abcdef1234
            name:
              type: string
              example: Day 1 – Upper Body
            description:
              type: string
              example: ''
            dayOrder:
              type: integer
              example: 1
            scoring:
              type: object
              nullable: true
              description: >-
                Scoring of a plan day. Null for an ordinary standard day.
                `acceptsManualResult` is true only for exercise-free scored days
                (`descriptionOnly`), which take a `wodResult` on PATCH
                /public/v1/workout/performance/sessions/{sessionId}/complete.
                `result` is the saved score of the selected session, or null.
              properties:
                scoringType:
                  type: string
                  enum:
                    - standard
                    - forTime
                    - amrap
                    - emom
                    - tabata
                    - maxLoad
                  example: forTime
                descriptionOnly:
                  type: boolean
                  example: true
                acceptsManualResult:
                  type: boolean
                  example: true
                targetValue:
                  type: number
                  nullable: true
                  example: null
                timeDomain:
                  type: object
                  nullable: true
                  description: >-
                    Clock prescription, same contract as a WOD `timeDomain`.
                    Allowed fields depend on `scoringType`: amrap →
                    windowSeconds (required); forTime → timeCapSeconds, rounds
                    (defaults to 1); emom → intervalSeconds, intervalCount (both
                    required); tabata → workSeconds, restSeconds, intervalCount
                    (all required); standard/maxLoad → none.
                  properties:
                    windowSeconds:
                      type: integer
                      nullable: true
                      minimum: 1
                      example: null
                    timeCapSeconds:
                      type: integer
                      nullable: true
                      minimum: 1
                      example: 900
                    rounds:
                      type: integer
                      nullable: true
                      minimum: 1
                      example: 3
                    intervalSeconds:
                      type: integer
                      nullable: true
                      minimum: 1
                      example: null
                    intervalCount:
                      type: integer
                      nullable: true
                      minimum: 1
                      example: null
                    workSeconds:
                      type: integer
                      nullable: true
                      minimum: 1
                      example: null
                    restSeconds:
                      type: integer
                      nullable: true
                      minimum: 0
                      example: null
                scoreValidation:
                  type: object
                  nullable: true
                  description: >-
                    Optional result caps. timeCapSeconds and expectedIntervals
                    are derived from `timeDomain` when one is set.
                  properties:
                    timeCapSeconds:
                      type: integer
                      nullable: true
                      minimum: 1
                      example: 900
                    maxReps:
                      type: integer
                      nullable: true
                      minimum: 1
                      example: null
                    expectedIntervals:
                      type: integer
                      nullable: true
                      minimum: 1
                      example: null
                result:
                  allOf:
                    - type: object
                      description: >-
                        Type-specific manual score, the same shape as the WOD
                        `wodResult`. Only the fields of the day's scoringType
                        are accepted: amrap → roundsCompleted, repsPerRound,
                        extraReps, totalReps (total = rounds × repsPerRound +
                        extraReps, extraReps < repsPerRound); forTime →
                        elapsedSeconds, finishedBeforeCap, totalReps (reps
                        required when not finished before the cap); emom/tabata
                        → intervalReps, totalReps (sum of intervals; count must
                        match intervalCount when set); maxLoad → maxLoadKg. The
                        stored copy of a forTime result also carries
                        timeCapSeconds.
                      properties:
                        roundsCompleted:
                          type: integer
                          minimum: 0
                          example: 5
                        repsPerRound:
                          type: integer
                          minimum: 1
                          example: 30
                        extraReps:
                          type: integer
                          minimum: 0
                          example: 12
                        totalReps:
                          type: integer
                          minimum: 0
                          example: 162
                        intervalReps:
                          type: array
                          items:
                            type: integer
                            minimum: 0
                          example:
                            - 12
                            - 11
                            - 10
                        elapsedSeconds:
                          type: number
                          minimum: 0
                          example: 742
                        finishedBeforeCap:
                          type: boolean
                          example: true
                        timeCapSeconds:
                          type: integer
                          nullable: true
                          readOnly: true
                          example: 900
                        maxLoadKg:
                          type: number
                          minimum: 0
                          example: 120
                  nullable: true
            progress:
              type: object
              description: >-
                Recurring sequence days show the selected active attempt and
                return to zero after completion, preserving history. Permanent
                completion applies to multi-week/calendar programmes: any
                non-deleted completed session for the exact plan and moment
                makes it 100%, including a zero-exercise day. Performances are
                never unioned across attempts.
              properties:
                total:
                  type: integer
                  example: 6
                completed:
                  type: integer
                  example: 2
                progressPercentage:
                  type: integer
                  example: 33
                isCompleted:
                  type: boolean
                  example: false
        stats:
          type: object
          properties:
            durationMinutes:
              type: integer
              example: 0
              description: >-
                Actual session duration (live elapsed for an active session); 0
                with no session.
            exerciseCount:
              type: integer
              example: 0
              description: Exercises logged in the current session.
            expectedDurationMinutes:
              type: integer
              example: 110
              description: Estimated from the plan-day prescription; 0 for freestyle.
        exercises:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                  - exercise
                  - superset
                example: exercise
              planExerciseId:
                type: string
                example: 67f1234567890abcdef1234
                nullable: true
                description: Null for freestyle / superset wrappers.
              exerciseId:
                type: string
                example: 67f1234567890abcdef1234
                nullable: true
              name:
                type: string
                example: Dumbbell Bench Press
              thumbnail:
                type: string
                example: https://cdn.example.com/exercises/bench.jpg
                description: >-
                  Card thumbnail, same rule as the client exercise list: the
                  first image, else the first hosted video's thumbnail, else the
                  first external video URL (YouTube/TikTok), else an empty
                  string. Empty on a superset block.
              media:
                type: array
                description: >-
                  Combined ordered media (images first, then videos) — same
                  shape as the exercise history response. Empty for superset
                  wrappers.
                items:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - image
                        - video
                        - link
                      example: image
                    url:
                      type: string
                      example: https://cdn.example.com/ex/bench.jpg
                    platform:
                      type:
                        - string
                        - 'null'
                      example: null
                    videoId:
                      type:
                        - string
                        - 'null'
                      example: null
                    thumbnail:
                      type:
                        - string
                        - 'null'
                      example: null
                    duration:
                      type:
                        - number
                        - 'null'
                      example: null
                    width:
                      type:
                        - number
                        - 'null'
                      example: 1080
                    height:
                      type:
                        - number
                        - 'null'
                      example: 720
              primaryMuscle:
                type: string
                example: Chest
              secondaryMuscles:
                type: array
                items:
                  type: string
                example:
                  - Triceps
              equipment:
                type: array
                items:
                  type: string
                example:
                  - Dumbbell
              groupId:
                type: string
                example: ''
                description: Superset group id (empty when standalone).
              order:
                type: integer
                example: 0
              isFavourite:
                type: boolean
                example: false
              hasHistory:
                type: boolean
                example: false
                description: >-
                  Whether this exercise has viewable completed-session history
                  (same basis as the exercise history response). Exercise items
                  only; omitted from superset wrappers.
              targets:
                type: object
                nullable: true
                description: >-
                  Plan-prescribed targets. `null` for freestyle and superset
                  wrappers.
                properties:
                  type:
                    type: string
                    example: reps
                  sets:
                    type: integer
                    example: 4
                  reps:
                    type: string
                    example: 8–12
                  rest:
                    type: integer
                    example: 60
                    description: Prescribed rest seconds.
                  rpe:
                    type: number
                    example: 8
                  rmPercentage:
                    type: number
                    example: 0
                  tempo:
                    type: string
                    example: ''
                  notes:
                    type: string
                    example: Keep elbows tucked.
                    description: Coach's prescribed note for this exercise.
              previousBestSet:
                type: string
                nullable: true
                example: 12 × 24kg
              performanceId:
                type: string
                example: 67f1234567890abcdef1234
                nullable: true
                description: Current-session performance id; null if not started.
              isCompleted:
                type: boolean
                example: false
              clientNotes:
                type: string
                example: ''
                description: Client's own note for this exercise (this session).
              clientRestSeconds:
                type:
                  - number
                  - 'null'
                example: null
                description: >-
                  Client's own exercise-level rest this session (does NOT fall
                  back to targets.rest).
              notes:
                type: string
                example: ''
                description: Superset-wrapper note (always empty for exercise items).
              sets:
                type: array
                items:
                  type: object
                  properties:
                    setNumber:
                      type: integer
                      example: 1
                    setType:
                      type: string
                      enum:
                        - 'N'
                        - W
                        - D
                        - F
                      example: 'N'
                    displayNumber:
                      type: integer
                      nullable: true
                      example: 1
                      description: >-
                        Sequential number for normal sets only. Warm-up, drop
                        set, and failure sets return null.
                    displayLabel:
                      type: string
                      example: '1'
                      description: >-
                        Display label: normal sets use their sequential number;
                        other set types use W, D, or F.
                    previous:
                      type: string
                      nullable: true
                      example: 12 × 22kg
                      description: >-
                        Same-index set from the last performance of this
                        exercise (`reps × weightkg`, `30s`, `100m`), or null.
                    reps:
                      type: integer
                      nullable: true
                      example: 10
                    weight:
                      type: number
                      nullable: true
                      example: 22
                    timeSeconds:
                      type: number
                      nullable: true
                      example: null
                    distanceMeters:
                      type: number
                      nullable: true
                      example: null
                    rpe:
                      type: number
                      nullable: true
                      example: null
                    completed:
                      type: boolean
                      example: false
              exerciseCount:
                type: integer
                example: 2
                description: Superset wrappers only.
              rounds:
                type: integer
                example: 4
                description: Superset wrappers only.
              data:
                type: array
                description: >-
                  Empty for a standalone exercise; the member exercise items for
                  a `type: "superset"` block.
                items:
                  $ref: >-
                    #/components/schemas/PublicWorkoutSourceWorkoutGroupedExerciseItem
        session:
          type: object
          nullable: true
          description: >-
            The current/navigation session, or null. Recurring sequence days
            select only the newest active attempt and return null after
            completion. Multi-week/calendar programmes fall back to the latest
            completed attempt. Stopped/cancelled attempts are excluded from
            current/resumable selection.
          properties:
            id:
              type: string
              example: 67f1234567890abcdef1234
            status:
              type: string
              enum:
                - in_progress
                - paused
                - completed
              example: in_progress
            startedAt:
              type: string
              format: date-time
              example: '2026-04-12T10:00:00.000Z'
              nullable: true
            programmeScheduleItemId:
              oneOf:
                - type: string
                  example: 67f1234567890abcdef1234
                - type: 'null'
            plannedDate:
              type: string
              format: date
              pattern: ^\d{4}-\d{2}-\d{2}$
              example: '2026-09-08'
        resumeState:
          type: string
          enum:
            - create
            - start
            - continue
            - completed
          example: create
        requiresResumePrompt:
          type: boolean
          example: false
        requiresConfirmation:
          type: boolean
          example: false
        confirmationToken:
          type: string
          example: null
          nullable: true
        confirmationTokenExpiresAt:
          type: string
          format: date-time
          example: null
          nullable: true
    PublicApiError:
      type: object
      additionalProperties: false
      required:
        - error
        - meta
      properties:
        error:
          type: object
          additionalProperties: false
          required:
            - code
            - key
            - message
          properties:
            code:
              type: integer
              example: 401
            key:
              type: string
              example: auth.invalid_token
            message:
              type: string
              example: The access token is invalid.
            details:
              type: object
              additionalProperties: true
        meta:
          $ref: '#/components/schemas/PublicApiMeta'
    ErrorResponse:
      allOf:
        - $ref: '#/components/schemas/StandardResponse'
        - example:
            status: 401
            error: true
            message: MISSING_AUTH
    PublicApiMeta:
      type: object
      additionalProperties: false
      required:
        - requestId
      properties:
        requestId:
          type: string
          description: Stable request correlation id. Mirrors `X-Request-Id` when supplied.
          example: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
        rateLimit:
          $ref: '#/components/schemas/PublicApiRateLimitMeta'
    PublicWorkoutSourceWorkoutGroupedExerciseItem:
      type: object
      properties:
        id:
          type: string
          example: 67f1234567890abcdef1234
        name:
          type: string
          example: Barbell Bench Press
        primaryMuscle:
          type: string
          enum:
            - Chest
            - Back
            - Lats
            - Traps
            - Shoulders
            - Biceps
            - Triceps
            - Forearms
            - Core
            - Abs
            - Obliques
            - Glutes
            - Quads
            - Hamstrings
            - Calves
            - Adductors
            - Abductors
            - Hip Flexors
            - Full Body
            - Cardio / Conditioning
            - Neck
            - Lower Back
          example: Chest
        secondaryMuscles:
          type: array
          items:
            type: string
            enum:
              - Chest
              - Back
              - Lats
              - Traps
              - Shoulders
              - Biceps
              - Triceps
              - Forearms
              - Core
              - Abs
              - Obliques
              - Glutes
              - Quads
              - Hamstrings
              - Calves
              - Adductors
              - Abductors
              - Hip Flexors
              - Full Body
              - Cardio / Conditioning
              - Neck
              - Lower Back
        primaryJoint:
          type: string
          enum:
            - ''
            - Ankle
            - Combination
            - Core
            - Elbow
            - Fingers
            - Hip
            - Knee
            - Neck
            - Shoulder
            - Spine
            - Wrist
          example: Shoulder
        equipment:
          type: array
          items:
            type: string
            enum:
              - Dumbbells
              - AdjustableDumbbells
              - Kettlebell
              - AdjustableKettlebell
              - CompetitionKettlebell
              - Medicineball
              - SlamBall
              - WallBall
              - Weightplate
              - BumperPlates
              - FractionalPlates
              - LoadableDumbbellHandle
              - Sandbag
              - StrongmanSandbag
              - Bulgarianbag
              - Aquabag
              - Aquaball
              - Hydrovest
              - MagneticBell
              - Macebell
              - SteelClub
              - IndianClub
              - Barbell
              - OlympicBarbell
              - TechniqueBar
              - EZBar
              - TrapBar
              - SafetySquatBar
              - SwissBar
              - CamberedBar
              - AxleBar
              - Landmine
              - Bench
              - FlatBench
              - AdjustableBench
              - InclineBench
              - DeclineBench
              - SealRowBench
              - HipThrustBench
              - BenchPressRack
              - SquatRack
              - SquatStand
              - PowerRack
              - WallMountedRack
              - HalfRack
              - SmithMachine
              - Monolift
              - JammerArms
              - BarbellJack
              - WeightTree
              - PlateStorage
              - DeadliftPlatform
              - Rig
              - StrengthMachinesPlateloaded
              - StrengthMachinesWeightstack
              - StrengthMachinesPneumatic
              - MultiGym
              - LegPressMachine
              - VerticalLegPressMachine
              - LeverageSquatMachine
              - LinearHackSquatMachine
              - BeltSquatMachine
              - PendulumSquatMachine
              - VSquatMachine
              - HackSquatMachine
              - LegExtensionMachine
              - LegCurlMachine
              - SeatedLegCurlMachine
              - LyingLegCurlMachine
              - StandingLegCurlMachine
              - StandingCalfRaiseMachine
              - SeatedCalfRaiseMachine
              - CalfPressMachine
              - HipThrustMachine
              - GluteDriveMachine
              - GluteKickbackMachine
              - HipExtensionMachine
              - HipAbductionMachine
              - HipAdductionMachine
              - ChestPressMachine
              - VerticalChestPressMachine
              - InclineChestPressMachine
              - DeclineChestPressMachine
              - IsoLateralChestPressMachine
              - IsoLateralInclinePressMachine
              - ShoulderPressMachine
              - IsoLateralShoulderPressMachine
              - MultiPressMachine
              - LateralRaiseMachine
              - RearDeltMachine
              - PecDeckMachine
              - PulloverMachine
              - LatPulldownMachine
              - IsoLateralLatPulldownMachine
              - AssistedPullupMachine
              - AssistedDipMachine
              - SeatedDipMachine
              - SeatedRowMachine
              - LowRowMachine
              - HighRowMachine
              - IsoLateralRowMachine
              - ChestSupportedRowMachine
              - TBarRowMachine
              - BicepsCurlMachine
              - PreacherCurlMachine
              - TricepsExtensionMachine
              - AbCrunchMachine
              - AbCoasterMachine
              - RotaryTorsoMachine
              - BackExtensionMachine
              - SeatedBackExtensionMachine
              - HyperextensionBench
              - ReverseHyper
              - GHD
              - Kinesis
              - Pulley
              - CableMachine
              - CableStation
              - CableColumn
              - CableCrossover
              - DualAdjustablePulley
              - SingleCableTower
              - FunctionalTrainer
              - TotalGymGTS
              - Gymstick
              - ViPR
              - RipTrainer
              - Battlerope
              - ProwlerSled
              - FarmersHandles
              - Yoke
              - Tire
              - Sledgehammer
              - TorqueTank
              - SledTrack
              - WallBallTarget
              - AgilityPoles
              - MiniHurdles
              - SprintParachute
              - PullUpBar
              - Parallelbars
              - DipBars
              - Equalizer
              - Suspensiontrainer
              - SuspensionSlingTrainer
              - GymnasticRings
              - MonkeyBars
              - PegBoard
              - RopeClimb
              - Wall
              - StallBars
              - DoorPullUpBar
              - PushUpHandles
              - AbStraps
              - Boxstep
              - SoftPlyoBox
              - Hurdle
              - Speedladder
              - Parallettes
              - NordicBench
              - SissySquatBench
              - Cardio
              - Treadmill
              - CurvedTreadmill
              - AirRunner
              - AssaultRunner
              - StationaryBike
              - UprightBike
              - RecumbentBike
              - BikeErg
              - SpinBike
              - AirBike
              - Rower
              - WaterRower
              - FanRower
              - ArmErgometer
              - SkiErg
              - Elliptical
              - ArcTrainer
              - NuStep
              - StairClimber
              - StepMill
              - JacobsLadder
              - VersaClimber
              - Bosu
              - Balanceball
              - Exerciseball
              - PilatesTennisball
              - PilatesRing
              - YogaMat
              - YogaBlock
              - YogaWheel
              - StretchStrap
              - MobilityStick
              - MassageBall
              - PeanutMassageBall
              - Airpad
              - Balanceboard
              - BalancePad
              - WobbleBoard
              - Glidedisc
              - Foamroller
              - Elasticbands
              - TherapyBand
              - Resistanceband
              - MiniBand
              - PullUpAssistBand
              - Powertube
              - AnkleWeights
              - SlantBoard
              - Vibrationtraining
              - CableRope
              - StraightBarAttachment
              - CurlBarAttachment
              - LatBarAttachment
              - TricepsBarAttachment
              - RowHandle
              - DHandle
              - DoubleDHandle
              - AnkleCuff
              - CableCuff
              - LandmineHandle
              - MagGripAttachment
              - DipBelt
              - AbWheel
              - WristRoller
              - FatGrip
              - Chain
              - DoorAnchor
              - JumpRope
              - SpeedRope
              - WeightedJumpRope
              - SledHarness
              - LiftingStraps
              - LiftingHooks
              - WristWraps
              - WeightliftingBelt
              - Clubbel
              - Stick
              - Bodybow
              - BuddySystem
              - Multinet
              - Flowin
              - Aerialhoop
              - Dancingpole
              - Trapeze
              - HulaHoop
              - Trampoline
              - XCO
              - PilatesReformer
              - PilatesChair
              - PilatesCadillac
              - PilatesBarrel
              - PilatesSpringboard
              - BalanceBeam
              - TreatmentTable
              - RehabTable
              - SlideBoard
        difficulty:
          type: string
          enum:
            - ''
            - Beginner
            - Intermediate
            - Advanced
          example: Intermediate
        intensity:
          type: string
          enum:
            - ''
            - Beginner
            - Below Average
            - Average
            - Above Average
            - High Intensity
          example: Above Average
        visibility:
          type: string
          enum:
            - Everyone
            - Company
            - Fitsociety
          example: Company
        tags:
          type: array
          items:
            type: string
        thumbnail:
          type:
            - string
            - 'null'
          format: uri
          example: https://cdn.example.com/exercises/bench-thumb.jpg
    StandardResponse:
      type: object
      properties:
        status:
          type: integer
          example: 200
        error:
          type: boolean
          example: false
        message:
          type: string
          example: SUCCESS
      required:
        - status
        - error
        - message
    PublicApiRateLimitMeta:
      type: object
      additionalProperties: false
      properties:
        limit:
          type: integer
          example: 10
        remaining:
          type: integer
          example: 9
        resetSeconds:
          type: integer
          description: Seconds until the current rate limit window resets.
          example: 1
        retryAfterSeconds:
          type: integer
          description: Present when the request was rate limited.
          example: 1
  securitySchemes:
    PublicBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Opaque
      description: >-
        Public API access token issued by `/public/v1/oauth/token`. Example:
        `Authorization: Bearer fspt_...`. Each resource request rechecks the
        token company's current provider access. Disabling access blocks
        existing tokens with `403 auth.provider_unavailable`.

````

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