> ## 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 v2 plan moment detail

> Requires the workout_plans:read scope. This operation maps to /app/v1/workout/plans/moments/:planId/:planMomentId and retains its Workout V2 permission, feature-flag, and resource-scope checks.

The clientId path parameter is resolved inside the company bound to the Public API token when present.



## OpenAPI

````yaml /openapi/public-v1.json get /public/v1/workout/plans/moments/{planId}/{planMomentId}
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/plans/moments/{planId}/{planMomentId}:
    get:
      tags:
        - Workout
      summary: Get workout v2 plan moment detail
      description: >-
        Requires the workout_plans:read scope. This operation maps to
        /app/v1/workout/plans/moments/:planId/:planMomentId and retains its
        Workout V2 permission, feature-flag, and resource-scope checks.


        The clientId path parameter is resolved inside the company bound to the
        Public API token when present.
      operationId: publicWorkoutgetPublicV1WorkoutPlansMomentsPlanIdPlanMomentId
      parameters:
        - in: path
          name: planId
          required: true
          description: Workout plan id.
          schema:
            type: string
            example: 67f1234567890abcdef1234
        - in: path
          name: planMomentId
          required: true
          description: Embedded workout plan-moment id.
          schema:
            type: string
            example: 67f1234567890abcdef1234
      responses:
        '200':
          description: Localized plan-moment detail.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PublicApiSuccessResponse'
                  - type: object
                    properties:
                      data:
                        $ref: >-
                          #/components/schemas/PublicWorkoutSourceGETAppV1WorkoutPlansMomentsPlanIdPlanMomentIdResponse200
              examples:
                success:
                  summary: Successful response
                  value:
                    data:
                      name: Day 1
                      description: Upper body push.
                      dayOrder: 1
                      order: 0
                      weekNumber: 1
                      sessionOrder: 1
                      date: '2026-04-15'
                      exercises:
                        - _id: 67f1234567890abcdef1234
                          exerciseId: 67f1234567890abcdef1234
                          type: reps
                          minReps: 6
                          maxReps: 8
                          notes: Pause 1 second on the chest.
                          sets: 4
                          metric: kg
                          rest: 120
                          intensity: High
                          difficulty: Intermediate
                          groupId: super-a
                          rpe: 8
                          rmPercentage: 75
                          tempo: '3010'
                          perSetTrackingEnabled: true
                          rpeEnabled: false
                          showSetRpe: true
                          setsData:
                            - setNumber: 1
                              setType: 'N'
                              metric: '12'
                              repetition: 8-12
                              weight: 60
                              rest: 90
                              rpe: 7.5
                              duration: 45
                              distance: 250
                          setupSettingsEnabled: true
                          setupFields:
                            - key: seat
                              label: Seat
                              type: text
                              unit: ''
                              options:
                                - '1'
                                - '2'
                                - '3'
                                - '4'
                              order: 1
                              required: false
                              enabled: true
                              defaultValue: 3
                          order: 0
                          isDeleted: false
                          deletedAt: null
                          createdAt: '2026-04-12T10:00:00.000Z'
                          updatedAt: '2026-04-12T10:00:00.000Z'
                      isDeleted: false
                      deletedAt: '2026-07-14T10:00:00.000Z'
                      createdAt: '2026-04-12T10:00:00.000Z'
                      updatedAt: '2026-04-12T10:00:00.000Z'
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '400':
          description: A path id is invalid or the caller cannot view the plan.
          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: Workout plan or plan moment was 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/plans/moments/{planId}/{planMomentId}"
            \
              -H "Authorization: Bearer <access_token>"
components:
  schemas:
    PublicApiSuccessResponse:
      type: object
      additionalProperties: false
      required:
        - data
        - meta
      properties:
        data:
          type: object
        meta:
          $ref: '#/components/schemas/PublicApiMeta'
    PublicWorkoutSourceGETAppV1WorkoutPlansMomentsPlanIdPlanMomentIdResponse200:
      type: object
      properties:
        name:
          type: string
          example: Day 1
        description:
          type: string
          example: Upper body push.
        dayOrder:
          type: number
          example: 1
        order:
          type: number
          example: 0
        weekNumber:
          type: integer
          minimum: 1
          example: 1
        sessionOrder:
          type: integer
          minimum: 1
          example: 1
        date:
          type: string
          example: '2026-04-15'
        exercises:
          type: array
          items:
            type: object
            properties:
              _id:
                type: string
                example: 67f1234567890abcdef1234
              exerciseId:
                type: string
                example: 67f1234567890abcdef1234
              type:
                type: string
                enum:
                  - reps
                  - time
                  - distance
                example: reps
              minReps:
                type: number
                example: 6
              maxReps:
                type: number
                example: 8
              notes:
                type: string
                example: Pause 1 second on the chest.
              sets:
                type: number
                example: 4
              metric:
                type: string
                example: kg
              rest:
                type: number
                example: 120
              intensity:
                type: string
                enum:
                  - Low
                  - Medium
                  - High
                example: High
              difficulty:
                type: string
                enum:
                  - Beginner
                  - Intermediate
                  - Advanced
                example: Intermediate
              groupId:
                type: string
                example: super-a
              rpe:
                type: number
                example: 8
              rmPercentage:
                type: number
                example: 75
              tempo:
                type: string
                example: '3010'
              perSetTrackingEnabled:
                type: boolean
                example: true
              rpeEnabled:
                type: boolean
                example: false
                description: >-
                  Master RPE switch for this plan exercise. False hides current
                  targets and inputs without clearing prescriptions or recorded
                  history. Missing legacy values retain RPE when an exercise
                  target or per-set preference exists. Independent from
                  showSetRpe.
              showSetRpe:
                type: boolean
                example: true
                description: >-
                  Stored per-set RPE preference. Live input is visible only when
                  RPE is enabled; authoring retains this preference while
                  rpeEnabled is false.
              setsData:
                type: array
                items:
                  type: object
                  properties:
                    setNumber:
                      type: integer
                      minimum: 1
                      example: 1
                    setType:
                      type: string
                      enum:
                        - 'N'
                        - W
                        - D
                        - F
                      example: 'N'
                      description: >-
                        Planned set type: N normal, W warm-up, D drop set, F to
                        failure.
                    metric:
                      type: string
                      example: '12'
                    repetition:
                      type: string
                      example: 8-12
                    weight:
                      type: number
                      example: 60
                    rest:
                      type: number
                      example: 90
                    rpe:
                      type:
                        - number
                        - 'null'
                      minimum: 0
                      maximum: 10
                      example: 7.5
                      description: >-
                        Optional target RPE for this set. It does not inherit
                        the exercise-level RPE value.
                    duration:
                      type: number
                      example: 45
                    distance:
                      type: number
                      example: 250
              setupSettingsEnabled:
                type: boolean
                example: true
                description: >-
                  Enables the exercise-level machine or equipment setup settings
                  block.
              setupFields:
                type: array
                maxItems: 8
                items:
                  type: object
                  required:
                    - key
                    - label
                  properties:
                    key:
                      type: string
                      example: seat
                    label:
                      type: string
                      example: Seat
                    type:
                      type: string
                      enum:
                        - text
                        - number
                        - select
                      example: text
                    unit:
                      type: string
                      example: ''
                    options:
                      type: array
                      items:
                        type: string
                      example:
                        - '1'
                        - '2'
                        - '3'
                        - '4'
                    order:
                      type: number
                      example: 1
                    required:
                      type: boolean
                      example: false
                    enabled:
                      type: boolean
                      example: true
                    defaultValue:
                      oneOf:
                        - type: string
                        - type: number
                      example: 3
              order:
                type: number
                example: 0
              isDeleted:
                type: boolean
                example: false
              deletedAt:
                type:
                  - string
                  - 'null'
                format: date-time
                example: null
              createdAt:
                type: string
                format: date-time
                example: '2026-04-12T10:00:00.000Z'
              updatedAt:
                type: string
                format: date-time
                example: '2026-04-12T10:00:00.000Z'
        isDeleted:
          type: boolean
          example: false
        deletedAt:
          type: string
          format: date-time
          nullable: true
        createdAt:
          type: string
          format: date-time
          example: '2026-04-12T10:00:00.000Z'
        updatedAt:
          type: string
          format: date-time
          example: '2026-04-12T10:00:00.000Z'
    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.