Get the training program
get_programReads- What it does
- Reads only. Changes nothing.
- Permission
- Workouts, read
workouts:read
What your assistant is told
The calling user's active training program: its days (workout templates, in rotation order) and nextTemplateId, the workout that's up next — the day after the last finished workout from this program. Null when the user has no program (they log freestyle or pick templates themselves). Pass clientHandle to read a coached client's program.
Each day also lists its slots — one per exercise, each with the gym, dumbbell and bodyweight version of it (alternatives) and anything the user has pinned for a particular PLACE (places). That is how one program is followed at a gym and at home: a place resolves to a version from its equipment, and update_workout_template_exercise with atPlace pins a different lift there. Planned sets are not here — get_workout_template has the full plan for one day.
Parameters
clientHandletext, optionalOptionalclient_handlefromlist_clientsto run this tool against a coached client's data instead of your own. Omit (or pass null) for your own data — the legacy default.