Onyx Coach

Soft-deletes one of the trainer's own notes on a client.

delete_client_note

Soft-deletes an exercise from the trainer's library. Templates and workouts that already reference it keep working; the exercise just stops appearing in the library.

delete_exercise

Soft-deletes a single workout from a general-library workout plan.

delete_plan_workout

Soft-deletes a single workout from a client's plan template.

delete_plan_template_workout

Soft-deletes a workout plan from the trainer's general library.

delete_workout_plan

Soft-deletes a plan template from a client's library and deactivates any active plans the client started from it.

delete_workout_plan_template

Soft-deletes a workout template from a client's library. It disappears from the client's app; workouts the client already completed from it are unaffected.

delete_workout_template

Duplicates a workout within a general-library workout plan, optionally onto a different week/day (0-based). Returns the copy with its new id.

duplicate_plan_workout

Duplicates a workout within a client's plan template, optionally onto a different week/day (0-based). Returns the copy with its new id.

duplicate_plan_template_workout

Returns one coached client: the relationship record (status, timestamps) plus their name and profile picture. Client ids come from list_clients.

get_client

Returns the client's onboarding answers: gender, year born, goal, limiting factor, preferred training days, years of experience, workout location (gym or home), focus areas, height in cm and weight in kg. Read it before programming for a client so the plan fits their goal, experience and schedule. `item` is null when the client never completed onboarding (for example a managed client without the app).

get_client_onboarding_data

Returns the client's device-reported IANA time zone (`item.timeZone`) and clock preferences, so scheduled times can be expressed in their local time. `item` is null when the client never reported one.

get_client_timezone

Returns a client's completed workouts, newest first. Each entry contains the performed exercises with their sets (reps/weight/time/…) and start/end timestamps (unix seconds). Page backwards by passing the oldest `start` you have as `before`.

get_client_workout_history

Returns the full exercise document from either library: complete description, translations, demo video links and default settings. Use it when a search or list summary is not enough, for example before editing one of the trainer exercises.

get_exercise

Returns a single completed workout of a client by id — the performed exercises with their sets (reps/weight/time/…), start/end timestamps (unix seconds) and the client's feedback (rating, note). Use it when the workout id is already known (e.g. from the current page); otherwise page with get_client_workout_history.

get_client_workout

Lists the trainer's own private notes on a client, with text, pinned flag and timestamps. Notes are never visible to the client, and other trainers' notes are never returned.

list_client_notes

Lists the plan instances a client is actually running (assigned/started plans with per-workout instance ids and progress). For the trainer's reusable plan library use list_workout_plans; for the client's assignable templates use list_workout_plan_templates.

list_client_workout_plans

Lists the coached clients of the signed-in trainer with their client id, name, profile picture and relationship status. Use the returned client id for every client-scoped tool. Optionally filter by status (e.g. "active").

list_clients

Lists the trainer's exercise blocks: reusable named groups of exercises (a warm-up, a core finisher, a mobility routine) with their prescribed sets. Copy a block's entries into the `exerciseList` of a workout to reuse it.

list_exercise_blocks

Browses the OnyxCoach official exercise library, curated exercises every trainer can reference in templates and plan workouts by id exactly like their own. Slim, pageable view (id, name, measurement type, equipment, focus areas, truncated description) with `total` matches and `nextOffset` for the next page. `search` matches the beginnings of words in the name or any translated name; combine it with the focus area, equipment and measurement filters. When you know which exercise you need, use search_exercises instead.

list_official_exercises

Lists a client's calendar of scheduled events — planned workouts, rest days and check-in markers — with their `status` (scheduled/started/completed). `scheduledFor` is a wall-clock string in the client's local time, "YYYY-MM-DD" or "YYYY-MM-DDTHH:mm"; bound the range with `from`/`to` ("YYYY-MM-DD", inclusive). Exercise entries are returned in compact form.

list_scheduled_events

Browses the trainer's own exercise library (not the official one) as a slim, pageable list: id, name, measurement type, equipment, focus areas and a truncated description. `search` matches the beginnings of words in the name or any translated name; combine it with the focus area, equipment and measurement filters. Page with `offset` and the returned `nextOffset`. When you know which exercise you need, use search_exercises instead.

list_exercises

Lists the workout-plan templates in a client's library — multi-week programs that can be assigned to the client with assign_workout_plan. Pass includeWorkouts to also return each template's workouts (exercise entries in compact form).

list_workout_plan_templates

Lists the trainer's general workout-plan library (multi-week programs). Pass includeWorkouts to also return each plan's workouts (day/week entries with exercise lists in compact form).

list_workout_plans

Lists the workout templates in a client's library — reusable named workouts (exercise lists with prescribed sets) the client can start any time. Exercise entries are returned in compact form (id, name, type, sets, note, superset).

list_workout_templates

Removes one scheduled workout occurrence (by `instanceId` from list_client_workout_plans) from a client's active plan instance. Returns the updated plan.

remove_workout_from_plan

Finds exercises by meaning and by name across the OnyxCoach official library (thousands of curated exercises) and the trainer's own library. Understands abbreviations ("RDL"), synonyms and any language, and matches translated exercise names. Returns a ranked list (score 1 is the best hit) with each exercise id, source (official or trainer), measurement type, equipment and focus areas. Use this whenever you need an exercise id for a workout; use the list tools only to browse by filter. Search once per exercise you need, with a specific query.

search_exercises

Updates a note's `text` and/or `pinned` flag. Only notes created by the connected trainer can be edited. Returns the updated note.

update_client_note

Updates an exercise in the trainer's library (official exercises cannot be edited). Pass only the fields to change in `changes`; set an optional field to null to clear it. Returns the updated exercise.

update_exercise

Updates a workout inside a general-library workout plan (name, week/day placement, exercise list, …). `changes.exerciseList` replaces the whole list, so include every exercise the workout should keep (id plus sets). Returns the updated workout.

update_plan_workout

Updates a workout inside a client's plan template. `changes.exerciseList` replaces the whole list, so include every exercise the workout should keep. Returns the updated workout.

update_plan_template_workout

Updates a workout plan's metadata in the trainer's general library (name, description, `active`, `hide`). Pass only the fields to change in `changes` — null clears a field.

update_workout_plan

Updates a plan template's metadata in a client's library. Pass only the fields to change in `changes` — null clears a field (description/imageUrl/blurhash store the null itself). Returns the updated template.

update_workout_plan_template

Updates a workout template in a client's library. Pass only the fields to change in `changes` — set an optional field to null to clear it. `exerciseList` replaces the whole list, so include every exercise the template should keep (ids from list_exercises or list_official_exercises). Returns the updated template.

update_workout_template