> ## 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 workout template detail

> Client-only. Returns the full workout template including all days (planMoments) and their exercises. Each exercise entry is enriched with data from the Exercise collection and includes `isFavourite` for the requesting client. Days are ordered by their `order` field; only non-deleted days and exercises are included.

`weeks[]` carries one summary card per week and is populated ONLY when `scheduleMode` is `multi_week`; a `recurring` plan returns an empty array and is rendered from `days` instead. The field is always present, so a client can branch on `scheduleMode` or simply on `weeks.length`.

Requires the workout_client_plans:read scope. This operation maps to /app/v1/workout/client/library/template/:templateId and retains its Workout V2 permission, feature-flag, and resource-scope checks.

The clientId path parameter identifies the client represented by the request context.



## OpenAPI

````yaml /openapi/public-v1.json get /public/v1/workout/clients/{clientId}/library/template/{templateId}
openapi: 3.1.0
info:
  title: FITsociety Public API v1
  version: 1.0.0
  description: >-
    Developer Public API endpoints under `/public/v1`. This reference is
    filtered to OAuth/Bearer Public API resources and excludes provider callback
    receivers, storefront routes, public widgets, wishlist routes, and
    access-device validation endpoints.
  contact:
    name: FITsociety Engineering
servers:
  - url: https://api.fitsociety.io
    description: Production
security: []
tags:
  - name: Workout
    description: >-
      Workout V2 libraries, programmes, client plans, calendars, sessions,
      groups, settings and progress. AI operations are excluded.
  - name: OAuth
    description: Public API OAuth endpoints for server-to-server client credentials.
  - name: Health
    description: Public API token health checks.
  - name: Platform
    description: >-
      Inspect Public API client context, capabilities, scopes, and redacted
      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 with
      guarded finance writes.
  - name: Credits
    description: >-
      Read company-wide and client-scoped credit allocations, mutations, and
      guarded credit adjustments.
  - 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.
paths:
  /public/v1/workout/clients/{clientId}/library/template/{templateId}:
    get:
      tags:
        - Workout
      summary: Get workout template detail
      description: >-
        Client-only. Returns the full workout template including all days
        (planMoments) and their exercises. Each exercise entry is enriched with
        data from the Exercise collection and includes `isFavourite` for the
        requesting client. Days are ordered by their `order` field; only
        non-deleted days and exercises are included.


        `weeks[]` carries one summary card per week and is populated ONLY when
        `scheduleMode` is `multi_week`; a `recurring` plan returns an empty
        array and is rendered from `days` instead. The field is always present,
        so a client can branch on `scheduleMode` or simply on `weeks.length`.


        Requires the workout_client_plans:read scope. This operation maps to
        /app/v1/workout/client/library/template/:templateId and retains its
        Workout V2 permission, feature-flag, and resource-scope checks.


        The clientId path parameter identifies the client represented by the
        request context.
      operationId: publicWorkoutgetPublicV1WorkoutClientsClientIdLibraryTemplateTemplateId
      parameters:
        - in: path
          name: templateId
          required: true
          description: Workout template plan id.
          schema:
            type: string
            example: 67f1234567890abcdef1234
        - 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: Full template detail with days and exercises.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PublicApiSuccessResponse'
                  - type: object
                    properties:
                      data:
                        $ref: >-
                          #/components/schemas/PublicWorkoutSourceGETAppV1WorkoutClientLibraryTemplateTemplateIdResponse200
              examples:
                success:
                  summary: Successful response
                  value:
                    data:
                      _id: 67f1234567890abcdef1234
                      name: 4-Day Strength Block
                      description: Progressive upper/lower split.
                      media:
                        - type: image
                          url: https://cdn.example.com/exercises/bench-press.jpg
                          platform: null
                          videoId: null
                          thumbnail: null
                          duration: null
                          width: 1280
                          height: 720
                      difficulty: Intermediate
                      intensity: High
                      category: Strength
                      goal: Strength
                      duration:
                        startDate: '2026-04-15'
                        endDate: '2026-06-15'
                        hasEndDate: true
                      scheduleMode: multi_week
                      days:
                        - _id: 67f1234567890abcdef1234
                          name: Day 1 – Lower Body
                          description: ''
                          order: 0
                          exercises:
                            - _id: 67f1234567890abcdef1234
                              exerciseId: 67f1234567890abcdef1234
                              exerciseName: Barbell Squat
                              thumbnail: >-
                                https://cdn.example.com/exercises/barbell-squat.jpg
                              primaryMuscle: Quadriceps
                              equipment:
                                - Barbell
                                - Rack
                              sets: 4
                              minReps: 6
                              maxReps: 10
                              rest: 90
                              intensity: High
                              difficulty: Intermediate
                              notes: ''
                              isFavourite: false
                          exerciseCount: 5
                      weeks:
                        - weekNumber: 1
                          dayCount: 4
                          workoutCount: 5
                          activityCount: 7
                          restDayCount: 2
                          totalTimeMinutes: 150
                          totalTimeSeconds: 9000
                      totalDays: 4
                      totalExercises: 20
                      isTemplateFavourite: false
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '400':
          description: >-
            Template id is malformed (`INVALID_TEMPLATE_ID`) or company context
            is missing (`COMPANY_ID_REQUIRED`).
          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':
          $ref: '#/components/schemas/ErrorResponse'
          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:
                          - required:scope
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '404':
          description: Template was not found (`TEMPLATE_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':
          $ref: '#/components/schemas/ErrorResponse'
        '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}/library/template/{templateId}"
            \
              -H "Authorization: Bearer <access_token>"
components:
  schemas:
    PublicApiSuccessResponse:
      type: object
      additionalProperties: false
      required:
        - data
        - meta
      properties:
        data:
          type: object
        meta:
          $ref: '#/components/schemas/PublicApiMeta'
    PublicWorkoutSourceGETAppV1WorkoutClientLibraryTemplateTemplateIdResponse200:
      type: object
      properties:
        _id:
          type: string
          example: 67f1234567890abcdef1234
        name:
          type: string
          example: 4-Day Strength Block
        description:
          type: string
          example: Progressive upper/lower split.
        media:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                  - image
                  - video
                example: image
              url:
                type: string
                example: https://cdn.example.com/exercises/bench-press.jpg
              platform:
                type: string
                example: null
                nullable: true
              videoId:
                type: string
                example: null
                nullable: true
              thumbnail:
                type: string
                example: null
                nullable: true
              duration:
                type: number
                nullable: true
                example: null
              width:
                type: integer
                nullable: true
                example: 1280
              height:
                type: integer
                nullable: true
                example: 720
          description: >-
            Images followed by videos, each tagged with `type: image` or `type:
            video`.
        difficulty:
          type: string
          example: Intermediate
        intensity:
          type: string
          example: High
        category:
          type: string
          example: Strength
        goal:
          type: string
          example: Strength
        duration:
          type: object
          properties:
            startDate:
              type: string
              example: '2026-04-15'
            endDate:
              type: string
              example: '2026-06-15'
            hasEndDate:
              type: boolean
              example: true
        scheduleMode:
          type: string
          enum:
            - recurring
            - multi_week
          example: multi_week
          description: >-
            Which kind of programme this is, telling the client whether to
            render `days` (recurring) or `weeks` (multi-week). Defaults to
            `recurring` when the plan never stored a mode.
        days:
          type: array
          items:
            type: object
            properties:
              _id:
                type: string
                example: 67f1234567890abcdef1234
              name:
                type: string
                example: Day 1 – Lower Body
              description:
                type: string
                example: ''
              order:
                type: integer
                example: 0
              exercises:
                type: array
                items:
                  type: object
                  properties:
                    _id:
                      type: string
                      example: 67f1234567890abcdef1234
                    exerciseId:
                      type: string
                      example: 67f1234567890abcdef1234
                    exerciseName:
                      type: string
                      example: Barbell Squat
                    thumbnail:
                      type: string
                      example: https://cdn.example.com/exercises/barbell-squat.jpg
                    primaryMuscle:
                      type: string
                      example: Quadriceps
                    equipment:
                      type: array
                      items:
                        type: string
                      example:
                        - Barbell
                        - Rack
                    sets:
                      type: integer
                      example: 4
                    minReps:
                      type: integer
                      example: 6
                    maxReps:
                      type: integer
                      example: 10
                    rest:
                      type: integer
                      example: 90
                      description: Rest in seconds.
                    intensity:
                      type: string
                      example: High
                    difficulty:
                      type: string
                      example: Intermediate
                    notes:
                      type: string
                      example: ''
                    isFavourite:
                      type: boolean
                      example: false
              exerciseCount:
                type: integer
                example: 5
        weeks:
          type: array
          description: >-
            One summary card per week, ascending by `weekNumber`. Empty unless
            `scheduleMode` is `multi_week`. `activityCount` and `restDayCount`
            can only be non-zero on the `calendar_week` layout; the sequence
            layout has neither, and reports them as 0.
          items:
            type: object
            properties:
              weekNumber:
                type: integer
                example: 1
              dayCount:
                type: integer
                example: 4
                description: >-
                  Days of this week that hold at least one workout or activity.
                  Rest days carry no items and are reported by `restDayCount`
                  instead, so they are NOT counted here.
              workoutCount:
                type: integer
                example: 5
                description: '`type: workout` items across every day of the week.'
              activityCount:
                type: integer
                example: 7
                description: '`type: activity` items across every day of the week.'
              restDayCount:
                type: integer
                example: 2
                description: Days flagged `isRestDay` in this week.
              totalTimeMinutes:
                type: integer
                example: 150
                description: >-
                  Estimated total time for the week, for the 'Total Time' line.
                  Each item contributes its coach-entered
                  `plannedDurationMinutes` when set; a workout without one is
                  estimated from its plan moment's exercises (supersets and
                  inter-exercise transitions included), and an activity without
                  one contributes nothing.
              totalTimeSeconds:
                type: integer
                example: 9000
                description: The same estimate before rounding to minutes.
        totalDays:
          type: integer
          example: 4
        totalExercises:
          type: integer
          example: 20
        isTemplateFavourite:
          type: boolean
          example: false
    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'
    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.