The coach's global settings for one exercise
GET/api/public/exercises/{exerciseId}/settings
The coach's global settings for one exercise. An exercise the coach never configured returns the defaults (no notes, no video, mediaDisplay "gif", no alternatives).
Authentication
Requires an API key, sent as Authorization: Bearer cp_live_....
API keys carry scopes. Get the catalog of scopes and webhook events lists every scope.
Path parameters
| Name | Type | Description |
|---|---|---|
exerciseIdrequired | string | Exercise catalog id from |
Request examples
curl --request GET \
--url 'https://api.coach-platform.com/api/public/exercises/<exerciseId>/settings' \
--header 'Authorization: Bearer cp_live_...'const response = await fetch('https://api.coach-platform.com/api/public/exercises/<exerciseId>/settings', {
method: 'GET',
headers: {
Authorization: 'Bearer cp_live_...',
},
});
const data = await response.json();Responses
200 OK
Successful response
{
"data": {
"exerciseId": "<string>",
"name": "<string>",
"nameHebrew": "<string>",
"isCustom": true,
"notes": "<string>",
"videoLink": "<string>",
"mediaDisplay": "gif",
"trackRm1": true,
"isFavorite": true,
"alternativeExercises": [
{
"exerciseId": "<string>",
"name": "<string>",
"nameHebrew": "<string>"
}
]
}
}Response fields (14)
| Name | Type | Description |
|---|---|---|
data | object | The coach's own settings for one catalog exercise. They apply to every training plan and every trainee that uses the exercise. |
data.exerciseId | string | |
data.name | string | null | |
data.nameHebrew | string | null | |
data.isCustom | boolean | True for an exercise the coach added to their own catalog. |
data.notes | string | null | Coach notes shown to trainees on this exercise. |
data.videoLink | string | null | Coach demonstration video URL. |
data.mediaDisplay | string | How the exercise is shown to trainees: "gif" shows the GIF (tapping it opens the video), "thumbnail" shows the YouTube video thumbnail instead of the GIF. |
data.trackRm1 | boolean | Track an estimated 1RM (Brzycki) for this exercise. |
data.isFavorite | boolean | Marked as a coach favorite. |
data.alternativeExercises | object[] | Default alternatives trainees may swap this exercise for, in every plan. |
data.alternativeExercises[].exerciseId | string | |
data.alternativeExercises[].name | string | null | |
data.alternativeExercises[].nameHebrew | string | null |
Error responses
400Bad Request401Unauthorized403Forbidden404Not Found409Conflict429Too Many Requests500Internal Server Error
These statuses share the same response body.
{
"error": {
"code": "<string>",
"message": "<string>",
"fix": "<string>",
"details": {},
"retryAfterMs": 123
}
}Error fields (6)
| Name | Type | Description |
|---|---|---|
error | object | |
error.code | string | |
error.message | string | |
error.fix | string | null | |
error.details | object | null | |
error.retryAfterMs | number | null |
More Exercises endpoints
This page is also available as Markdown. Browse it in the interactive explorer or download the OpenAPI spec.