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

Query parameters
NameTypeDescription
pageinteger

Page number (1-based, default 1)

Minimum: 1

limitinteger

Number of items to return (default 25, max 500)

Minimum: 1

Maximum: 500

favoritesOnlystring

Only favorite exercises.

Allowed values: true false

withAlternativesOnlystring

Only exercises that have default alternatives.

Allowed values: true false

Request examples

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

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>"
        }
      ]
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "hasMore": true,
    "truncated": true
  }
}
Response fields (20)
Response fields
NameTypeDescription
dataobject[]
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
paginationobject
pagination.pagenumber
pagination.limitnumber
pagination.totalnumber | 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.hasMoreboolean
pagination.truncatedboolean

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

  • 400 Bad Request
  • 401 Unauthorized
  • 403 Forbidden
  • 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.