List the exercises the coach has configured
GET/api/public/exercises/settings
List the exercises the coach has configured: coach notes, demonstration video, media display, 1RM tracking, favorite and the default alternatives trainees may swap to. These settings are global: they apply to every training plan and every trainee that uses the exercise.
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.
Query parameters
| Name | Type | Description |
|---|---|---|
page | integer | Page number (1-based, default 1) |
limit | integer | Number of items to return (default 25, max 500) |
favoritesOnly | string | Only favorite exercises. |
withAlternativesOnly | string | Only exercises that have default alternatives. |
Request examples
curl --request GET \
--url 'https://api.coach-platform.com/api/public/exercises/settings' \
--header 'Authorization: Bearer cp_live_...'const response = await fetch('https://api.coach-platform.com/api/public/exercises/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>"
}
]
}
],
"pagination": {
"page": 123,
"limit": 123,
"total": 123,
"hasMore": true,
"truncated": true
}
}Response fields (20)
| Name | Type | Description |
|---|---|---|
data | object[] | |
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 | |
pagination | object | |
pagination.page | number | |
pagination.limit | number | |
pagination.total | number | null | Total number of matching items. null when the underlying source cannot report an exact count for this page; use hasMore to keep paging. |
pagination.hasMore | boolean | |
pagination.truncated | boolean | Present and true when the result set exceeded the in-memory scan cap and was truncated. Narrow your filters to page through all items. |
Error responses
400Bad Request401Unauthorized403Forbidden429Too 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.