Skip to main content
The workout company module exposes non-WOD training data and workflows. Client-specific tools verify the active company-client relationship and enforce the applicable training and performance history windows.

Read tools

list_workout_plans

Lists company-owned, non-WOD training plan templates. Optional filters are search, status, language, page, and limit.

get_workout_plan

Returns a template or accessible assigned plan with visible day summaries. Requires planId; language is optional. activityCount tells how many scheduled activities the plan has; they are not days, so read them with list_workout_plan_activities.

list_workout_plan_activities

Lists the scheduled activities (running, cycling, swimming, …) of a calendar template or accessible assigned plan, ordered by week, weekday, and order. Requires planId; optional weekNumber, language, page, and limit.

get_workout_plan_day

Returns one visible plan day with ordered exercise targets and setup fields. Requires planId and planMomentId; language is optional.

search_workout_exercises

Searches system, FITsociety, and company-owned exercises visible to the active company. Filters include search, primaryMuscle, equipment, difficulty, visibility, language, page, and limit.

get_workout_exercise

Returns one visible exercise. Requires exerciseId; language is optional.

list_client_workout_plans

Lists current non-WOD plans assigned to an accessible client. Requires clientId; optional fields are status, language, page, and limit.

list_workout_sessions

Lists an accessible client’s sessions with optional status and date filters. Requires clientId; optional fields are status, dateFrom, dateTo, page, and limit. A date range cannot exceed 366 days.

get_workout_session

Returns one session and its bounded ordered performance records. Requires clientId and sessionId.

get_workout_machine_preset

Returns effective setup fields using coach, company, and system precedence. Requires exerciseId.

get_workout_equipment_profile

Returns the company’s gym profile or an accessible client’s home profile. Requires ownerType (company or client); use clientId for a client owner.

list_video_library

Lists the company’s published video-library videos, newest first. Optional search (title), language, page, and limit. Use videoLibraryId with upsert_workout_plan_activity. Requires the cardio builder feature.

Write tools

All write tools require explicit grant approval and params._meta.idempotencyKey. See Connection & Protocol for the durable replay contract.

create_workout_plan_template Write

Creates a company-owned training plan template. Required fields are name, description, and category; optional fields include goal, periodizationType, difficulty, intensity, status, default exercise settings, template dates, aiGenerated, and language.

update_workout_plan_template Write

Updates metadata, default exercise settings, dates, or status on a company training template. Requires templatePlanId.

archive_workout_plan_template Write

Archives a company training template by setting its status to Inactive. Requires templatePlanId.

duplicate_workout_plan_template Write

Copies an existing company training template into a new company-owned draft. Requires sourceTemplatePlanId; optional name, description, status, and aiGenerated can override copied metadata.

upsert_workout_plan_day Write

Creates a new template day or updates an existing one without changing its exercise list. Requires templatePlanId; use planMomentId to update an existing day. Optional fields include name, description, dayOrder, date, scoringType, targetValue, and language. templatePlanId can also be a client’s assigned plan from list_client_workout_plans. Then only that client’s copy changes, and the coach needs access to that client. This also applies to set_workout_plan_day_exercises, upsert_workout_plan_activity, and remove_workout_plan_activity.

set_workout_plan_day_exercises Write

Replaces the full exercise list of one template or assigned-plan day. Requires templatePlanId, planMomentId, and exercises. Passing an empty array clears the day. Each exercise must use a visible library exerciseId; omit setupFields to use the resolved coach, company, or system setup preset.

upsert_workout_plan_activity Write

Creates or updates a scheduled activity on a multi-week (calendar) template. Requires templatePlanId. Omit activityId to create; activityType, name, and weekday are then required and weekNumber defaults to 1. With activityId, omitted fields keep their value and a new weekNumber/weekday moves the activity. Optional fields: description, startTime (HH:mm), plannedDurationMinutes, targetDistanceMeters, videoLibraryId (from list_video_library; requires the cardio builder feature, null removes the link), and language. Use a scheduled activity for cardio without a suitable exercise-library match or for a circuit planned as one session. Choose the matching sport or use other for a circuit or unlisted sport. Put the session instructions in description and its total time in plannedDurationMinutes. With the cardio builder disabled, omit both cardio and videoLibraryId.

remove_workout_plan_activity Write

Removes one scheduled activity from a multi-week template. Requires templatePlanId and activityId. Workout days are not affected.

create_workout_exercise Write

Creates a company-owned exercise in the training library. Required fields are name, description, primaryCategory, and primaryMuscle; optional fields include secondary categories, secondary muscles, primary joint, equipment, tags, difficulty, intensity, default type, and language.

update_workout_exercise Write

Updates a company-owned training library exercise. Global exercises are read-only through this tool. Requires exerciseId.

archive_workout_exercise Write

Archives a company-owned training library exercise only when it is not referenced by active training plans or logged performance. Requires exerciseId.

assign_workout_plan Write

Assigns all visible days, or a selected planMomentIds subset, from a company template. Requires clientId and templatePlanId; optional fields include startDate, endDate, hasEndDate, and language. When an end date is used, the assignment range may cover at most 366 days. On a new assignment of a calendar (multi-week) template, startDate is also week 1 of the programme; without it the programme starts today. Set hideUntilStartDate: true together with startDate to keep the assigned copy hidden and unavailable to the client until midnight on that date in the company timezone. This includes client calendars, direct plan links, workouts, activities and client AI tools. The coach can still inspect the assignment. The default is false; existing assignments retain immediate availability. Plan summaries return clientAvailableFrom as a UTC timestamp, or null when there is no scheduled release. Different release dates create independent blocks from the same template. A matching active assignment with the same release date can be reused. This option does not change a manually paused plan’s status. Future assignments do not send an immediate assignment notification; no delayed notification is scheduled by this option. The assignment API accepts the same flag with scheduleStartDate on POST /public/v1/workout/plans/assign, /assign-multiple and /assign-multiple-plans. Supply the usual write scope and idempotency key.

start_workout_session Write

Starts or resumes a plan-day session, or starts a freestyle session. Requires clientId; planId, planMomentId, and language are optional.

log_workout_performance Write

Upserts sets for one exercise in an active session. Requires clientId, sessionId, exerciseId, and sets; optional fields include performance and plan-exercise IDs, notes, rest, completion, setup values, and RPE display state.

complete_workout_session Write

Completes a session and awards eligible XP. Requires clientId and sessionId; notes is optional. An exact retry with the same idempotency key does not award duplicate XP.

update_workout_machine_preset Write

Merges up to eight setup-field edits into a company- or coach-scoped preset. Requires exerciseId, scope, and setupFields.

update_workout_equipment_profile Write

Replaces selected equipment for the company gym or an accessible client’s home. Requires ownerType and selectedItems; use clientId for a client owner. For a client owner, selectedItems: [] clears the home selection and returns selectionSource: "empty". Company gym selections keep their company source.

update_client_workout_plan_status Write

Activate, deactivate, archive or remove one training plan assigned to a client. Inactive hides that assigned copy from the client; Archived moves it to the client’s archived plans (like Archive in the coach app); Removed unassigns it (soft delete, like deleting it in the coach app) to undo a wrong assign_workout_plan. The company template, other clients and logged sessions are unaffected. Use the assigned planId from list_client_workout_plans, not the sourceTemplateId.
  • Type: Write (requires userConfirmed: true and the write-tool grant)
  • Input Fields:
    • clientId (string, required)
    • planId (string, required)
    • status (string: Active, Inactive, Archived, Removed, required)
    • language (string: en, nl, fr, de, es, optional)
    • idempotencyKey (string, optional)

Natural Language Examples

  • “Create a draft strength template for this client’s next four weeks.”
  • “Add a lower-body day and set squats, split squats, and leg curl targets.”
  • “Assign the strength foundation plan to client 64b64c0f2f5f4c0012345678 from 2026-09-01 through 2026-12-31.”
  • “Log 3 sets of 10 squats at 80 kg for today’s session.”

JSON-RPC Call Example