> ## 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 one week of a multi-week plan > Client-only. The screen reached by tapping a week card on the template detail. Returns the week's days in weekday order; each day carries its scheduled `items[]`, and a `type: "workout"` item carries the full `exercises[]` array in the SAME shape `GET .../template/{templateId}/day/{planMomentId}` returns — both are built by one shared helper — so the day sheet renders without a second call per workout. **Multi-week only.** A `recurring` plan has no weeks to open and is rejected with `WORKOUTPLAN_SCHEDULE_NOT_MULTI_WEEK`; render it from the template detail's `days` instead. Only AUTHORED days are returned. `schedule.weeks[].days[]` is stored sparsely, so a weekday with nothing on it has no entry at all. A REST day IS authored (`isRestDay: true`, no items) and is returned, because the screen renders it as its own card. Requires the workout_client_plans:read scope. This operation maps to /app/v1/workout/client/library/template/:templateId/week/:weekNumber 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}/week/{weekNumber} 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}/week/{weekNumber}: get: tags: - Workout summary: Get one week of a multi-week plan description: >- Client-only. The screen reached by tapping a week card on the template detail. Returns the week's days in weekday order; each day carries its scheduled `items[]`, and a `type: "workout"` item carries the full `exercises[]` array in the SAME shape `GET .../template/{templateId}/day/{planMomentId}` returns — both are built by one shared helper — so the day sheet renders without a second call per workout. **Multi-week only.** A `recurring` plan has no weeks to open and is rejected with `WORKOUTPLAN_SCHEDULE_NOT_MULTI_WEEK`; render it from the template detail's `days` instead. Only AUTHORED days are returned. `schedule.weeks[].days[]` is stored sparsely, so a weekday with nothing on it has no entry at all. A REST day IS authored (`isRestDay: true`, no items) and is returned, because the screen renders it as its own card. Requires the workout_client_plans:read scope. This operation maps to /app/v1/workout/client/library/template/:templateId/week/:weekNumber 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: >- publicWorkoutgetPublicV1WorkoutClientsClientIdLibraryTemplateTemplateIdWeekWeekNumber parameters: - in: path name: templateId required: true description: Workout template plan id. schema: type: string example: 67f1234567890abcdef1234 - in: path name: weekNumber required: true description: The 1-based week of the multi-week schedule. schema: type: integer minimum: 1 example: 1 - 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: Week detail with every day, item and exercise. content: application/json: schema: allOf: - $ref: '#/components/schemas/PublicApiSuccessResponse' - type: object properties: data: $ref: >- #/components/schemas/PublicWorkoutSourceGETAppV1WorkoutClientLibraryTemplateTemplateIdWeekWeekNumberResponse200 examples: success: summary: Successful response value: data: templateId: 67f1234567890abcdef1234 templateName: 4-Day Strength Block templateDescription: Progressive upper/lower split. isTemplateFavourite: false weekNumber: 1 isSkipWeek: false totalWeeks: 6 summary: weekNumber: 1 dayCount: 4 workoutCount: 5 activityCount: 7 restDayCount: 2 totalTimeMinutes: 150 totalTimeSeconds: 9000 days: - weekday: 4 isRestDay: false isSkipDay: false itemCount: 2 items: - _id: 67f1234567890abcdef1234 type: workout order: 1 startTime: '' plannedDurationMinutes: null estimatedDurationMinutes: 42 name: Dumbell Bench Press description: A classic compound movement. planMomentId: 67f1234567890abcdef1234 exerciseCount: 5 totalSets: 20 exercises: - _id: 67f1234567890abcdef1234 exerciseId: 67f1234567890abcdef1234 name: Barbell Squat description: A compound lower-body movement. thumbnail: >- https://cdn.example.com/exercises/barbell-squat.jpg primaryMuscle: Quadriceps secondaryMuscles: - Glutes - Hamstrings equipment: - Barbell - Rack category: Strength primaryCategory: Strength secondaryCategories: - Push type: reps sets: 4 minReps: 6 maxReps: 10 metric: '' rest: 90 intensity: Medium difficulty: Intermediate notes: '' groupId: '' rpe: 0 rpeEnabled: true rmPercentage: 0 tempo: '3010' order: 0 isFavourite: false activityType: null targetDistanceMeters: null meta: requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83 rateLimit: limit: 10 remaining: 9 resetSeconds: 1 '400': description: >- Template id is malformed (`INVALID_TEMPLATE_ID`), week number is not a positive whole number (`INVALID_WEEK_NUMBER`), company context is missing (`COMPANY_ID_REQUIRED`), or the plan is not multi-week (`WORKOUTPLAN_SCHEDULE_NOT_MULTI_WEEK`). 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`) or the plan has no such week (`WORKOUTPLAN_WEEK_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}/week/{weekNumber}" \ -H "Authorization: Bearer " components: schemas: PublicApiSuccessResponse: type: object additionalProperties: false required: - data - meta properties: data: type: object meta: $ref: '#/components/schemas/PublicApiMeta' PublicWorkoutSourceGETAppV1WorkoutClientLibraryTemplateTemplateIdWeekWeekNumberResponse200: type: object properties: templateId: type: string example: 67f1234567890abcdef1234 templateName: type: string example: 4-Day Strength Block templateDescription: type: string example: Progressive upper/lower split. isTemplateFavourite: type: boolean example: false weekNumber: type: integer example: 1 isSkipWeek: type: boolean example: false description: >- Whether the client skipped this whole week (it keeps its days and items). totalWeeks: type: integer example: 6 summary: type: object nullable: true description: >- The same card this week shows in the template detail's `weeks[]`, repeated here for the screen header. properties: weekNumber: type: integer example: 1 dayCount: type: integer example: 4 workoutCount: type: integer example: 5 activityCount: type: integer example: 7 restDayCount: type: integer example: 2 totalTimeMinutes: type: integer example: 150 totalTimeSeconds: type: integer example: 9000 days: type: array description: Authored days only, ascending by `weekday`. items: type: object properties: weekday: type: integer minimum: 1 maximum: 7 example: 4 description: 1 = Monday … 7 = Sunday. isRestDay: type: boolean example: false isSkipDay: type: boolean example: false description: >- Whether the client skipped this day (it keeps its items). Never `true` on a rest day. itemCount: type: integer example: 2 items: type: array description: Ascending by `order`. items: type: object properties: _id: type: string example: 67f1234567890abcdef1234 type: type: string enum: - workout - activity example: workout order: type: integer example: 1 startTime: type: string example: '' plannedDurationMinutes: type: integer nullable: true example: null description: >- The coach's own entry, echoed raw. `null` when none was set. estimatedDurationMinutes: type: integer example: 42 description: >- `plannedDurationMinutes` when set; otherwise a workout is estimated from its exercises and an activity reports 0. Same rule the week summary totals use. name: type: string example: Dumbell Bench Press description: >- A workout's name comes from the plan moment it points at; an activity carries its own. description: type: string example: A classic compound movement. planMomentId: allOf: - type: string example: 67f1234567890abcdef1234 nullable: true description: >- Workout items only (`null` on an activity). Takes the day-detail endpoint, so the full day sheet can still be opened from here. exerciseCount: type: integer example: 5 totalSets: type: integer example: 20 exercises: type: array description: >- Workout items only; always `[]` on an activity, and `[]` on a workout whose plan moment was archived or deleted. items: type: object properties: _id: type: string example: 67f1234567890abcdef1234 exerciseId: allOf: - type: string example: 67f1234567890abcdef1234 nullable: true description: >- `null` when the row references no valid exercise id. name: type: string example: Barbell Squat description: type: string example: A compound lower-body movement. thumbnail: type: string example: >- https://cdn.example.com/exercises/barbell-squat.jpg primaryMuscle: type: string example: Quadriceps secondaryMuscles: type: array items: type: string example: - Glutes - Hamstrings equipment: type: array items: type: string example: - Barbell - Rack category: type: string example: Strength description: >- Alias of `primaryCategory`, kept for older clients. primaryCategory: type: string example: Strength secondaryCategories: type: array items: type: string example: - Push type: type: string enum: - reps - time - distance - bodyweight - assisted_bodyweight example: reps description: Which metric family this exercise is tracked in. sets: type: integer example: 4 minReps: type: integer example: 6 maxReps: type: integer example: 10 metric: type: string example: '' description: Used for time/distance-based exercises. rest: type: integer example: 90 description: Rest in seconds. intensity: type: string example: Medium description: >- From the exercise CATALOG, not the plan prescription — same as searchExercises / getExerciseDetail. difficulty: type: string example: Intermediate description: From the exercise catalog, as with `intensity`. notes: type: string example: '' groupId: type: string example: '' description: >- Superset group identifier. Empty string if not in a superset. rpe: type: number example: 0 rpeEnabled: type: boolean example: true description: >- The per-exercise RPE flag stored on the plan. It has no default, so the key is ABSENT from the response on an exercise where it was never set — treat a missing value as unset rather than as `false`. rmPercentage: type: number example: 0 tempo: type: string example: '3010' order: type: integer example: 0 isFavourite: type: boolean example: false activityType: type: string nullable: true example: null description: Activity items only; `null` on a workout. targetDistanceMeters: type: integer nullable: true example: null description: Activity items only; `null` on a workout. 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.