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

Path parameters
NameTypeDescription
exerciseIdrequiredstring

Exercise catalog id from GET /exercises.

Request examples

cURL
curl --request GET \
  --url 'https://api.coach-platform.com/api/public/exercises/<exerciseId>/settings' \
  --header 'Authorization: Bearer cp_live_...'
JavaScript (fetch)
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

Example body (application/json)
{
  "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)
Response fields
NameTypeDescription
dataobject

The coach's own settings for one catalog exercise. They apply to every training plan and every trainee that uses the exercise.

data.exerciseIdstring
data.namestring | null
data.nameHebrewstring | null
data.isCustomboolean

True for an exercise the coach added to their own catalog.

data.notesstring | null

Coach notes shown to trainees on this exercise.

data.videoLinkstring | null

Coach demonstration video URL.

data.mediaDisplaystring

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.

Allowed values: gif thumbnail

data.trackRm1boolean

Track an estimated 1RM (Brzycki) for this exercise.

data.isFavoriteboolean

Marked as a coach favorite.

data.alternativeExercisesobject[]

Default alternatives trainees may swap this exercise for, in every plan.

data.alternativeExercises[].exerciseIdstring
data.alternativeExercises[].namestring | null
data.alternativeExercises[].nameHebrewstring | null

Error responses

  • 400 Bad Request
  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not Found
  • 409 Conflict
  • 429 Too Many Requests
  • 500 Internal Server Error

These statuses share the same response body.

Example body (application/json)
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "fix": "<string>",
    "details": {},
    "retryAfterMs": 123
  }
}
Error fields (6)
Error fields
NameTypeDescription
errorobject
error.codestring
error.messagestring
error.fixstring | null
error.detailsobject | null
error.retryAfterMsnumber | null

This page is also available as Markdown. Browse it in the interactive explorer or download the OpenAPI spec.