> ## 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. # List every week of the client's own multi-week programme (reorder screen) > The "Reorder Weeks" screen: EVERY week of the client's own multi-week plan, each with its four count chips (days / workouts / activities / rest days) and an expandable day-by-day breakdown. A day lists its scheduled items by name — a workout by its plan-moment name, an activity by its own — plus the `type` so the row shows the right icon and can open the right screen (a workout carries its `planMomentId`). Lightweight on purpose: it returns item NAMES and counts, NOT the full `exercises[]` each workout holds — that is the per-week detail screen's job (`GET /app/v1/workout/client/library/template/{templateId}/week/{weekNumber}`) — so the whole plan's weeks load in one call. Only AUTHORED days are returned (`schedule.weeks[].days[]` is stored sparsely), a rest day included (`isRestDay: true`, no items). Multi-week only; pinned to the caller's own ASSIGNED, non-archived plan. Requires the workout_client_plans:read scope. This operation maps to /app/v1/workout/plans/client/template/:templateId/weeks 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}/plans/template/{templateId}/weeks 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}/plans/template/{templateId}/weeks: get: tags: - Workout summary: >- List every week of the client's own multi-week programme (reorder screen) description: >- The "Reorder Weeks" screen: EVERY week of the client's own multi-week plan, each with its four count chips (days / workouts / activities / rest days) and an expandable day-by-day breakdown. A day lists its scheduled items by name — a workout by its plan-moment name, an activity by its own — plus the `type` so the row shows the right icon and can open the right screen (a workout carries its `planMomentId`). Lightweight on purpose: it returns item NAMES and counts, NOT the full `exercises[]` each workout holds — that is the per-week detail screen's job (`GET /app/v1/workout/client/library/template/{templateId}/week/{weekNumber}`) — so the whole plan's weeks load in one call. Only AUTHORED days are returned (`schedule.weeks[].days[]` is stored sparsely), a rest day included (`isRestDay: true`, no items). Multi-week only; pinned to the caller's own ASSIGNED, non-archived plan. Requires the workout_client_plans:read scope. This operation maps to /app/v1/workout/plans/client/template/:templateId/weeks 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: >- publicWorkoutgetPublicV1WorkoutClientsClientIdPlansTemplateTemplateIdWeeks parameters: - in: path name: templateId required: true description: The client's own assigned multi-week calendar plan. 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: The plan's weeks with per-week counts and day breakdowns. content: application/json: schema: allOf: - $ref: '#/components/schemas/PublicApiSuccessResponse' - type: object properties: data: $ref: >- #/components/schemas/PublicWorkoutSourceGETAppV1WorkoutPlansClientTemplateTemplateIdWeeksResponse200 examples: success: summary: Successful response value: data: templateId: 67f1234567890abcdef1234 templateName: 12-week block scheduleMode: multi_week totalWeeks: 12 weeks: - weekNumber: 1 isSkipWeek: false summary: totalDays: 6 workouts: 5 activities: 7 restDays: 1 totalTimeMinutes: 240 days: - weekday: 1 isRestDay: false isSkipDay: false itemCount: 3 workoutCount: 2 activityCount: 1 items: - _id: 67f1234567890abcdef1234 type: workout order: 1 name: Peak Performance planMomentId: 67f1234567890abcdef1234 activityType: null targetDistanceMeters: null startTime: '' plannedDurationMinutes: 60 meta: requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83 rateLimit: limit: 10 remaining: 9 resetSeconds: 1 '400': description: >- `INVALID_TEMPLATE_ID`, or `WORKOUTPLAN_SCHEDULE_NOT_MULTI_WEEK` when the plan is recurring. x-errorCodes: - INVALID_TEMPLATE_ID - 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': description: Caller is not authorized to view this plan. 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: Plan 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}/plans/template/{templateId}/weeks" \ -H "Authorization: Bearer " components: schemas: PublicApiSuccessResponse: type: object additionalProperties: false required: - data - meta properties: data: type: object meta: $ref: '#/components/schemas/PublicApiMeta' PublicWorkoutSourceGETAppV1WorkoutPlansClientTemplateTemplateIdWeeksResponse200: type: object properties: templateId: type: string example: 67f1234567890abcdef1234 templateName: type: string example: 12-week block scheduleMode: type: string enum: - multi_week example: multi_week totalWeeks: type: integer example: 12 weeks: type: array items: type: object properties: weekNumber: type: integer example: 1 isSkipWeek: type: boolean example: false description: >- Whether the client skipped this whole week (it keeps its days and items). summary: type: object description: >- The header count chips. `totalDays` counts only the AUTHORED days (it is NOT `days.length`, which is always 7); `restDays` counts the authored rest days among them. properties: totalDays: type: integer example: 6 workouts: type: integer example: 5 activities: type: integer example: 7 restDays: type: integer example: 1 totalTimeMinutes: type: integer example: 240 days: type: array minItems: 7 maxItems: 7 description: >- ALWAYS the seven weekdays (1 = Monday … 7 = Sunday), ascending. A weekday that was never authored is an empty slot (`isRestDay: false`, `itemCount: 0`, `items: []`); an authored rest day has `isRestDay: true` and no items. items: type: object properties: weekday: type: integer example: 1 isRestDay: type: boolean example: false isSkipDay: type: boolean example: false description: >- Whether the client skipped this day (it keeps its items). Always `false` on an unauthored empty slot. itemCount: type: integer example: 3 workoutCount: type: integer example: 2 activityCount: type: integer example: 1 items: type: array items: type: object properties: _id: type: string example: 67f1234567890abcdef1234 type: type: string enum: - workout - activity example: workout order: type: integer example: 1 name: type: string example: Peak Performance planMomentId: allOf: - type: string example: 67f1234567890abcdef1234 nullable: true description: >- Workout only — open the day detail with it. `null` on an activity. activityType: type: string nullable: true example: null description: >- Activity only (drives the icon): `running` | `cycling` | `walking` | `padel` | `mobility` | `other`. `null` on a workout. targetDistanceMeters: type: integer nullable: true example: null startTime: type: string example: '' plannedDurationMinutes: type: integer nullable: true example: 60 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.