GET
/
exercise
/
query
curl --request GET \
  --url https://api.wrkout.xyz/exercise/query \
  --header 'X-API-Key: <api-key>'
{
  "exercises": [
    {
      "id": "<string>",
      "name": "<string>",
      "displayName": "<string>",
      "aliases": [
        "<string>"
      ],
      "premiumImages": [
        "<string>"
      ],
      "premiumVideos": [
        "<string>"
      ]
    }
  ],
  "pagination": {
    "total": 123
  }
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
limit
integer
default:10

The amount of results returned

Required range: 1 <= x <= 25
​
after
string

cursor for pagination

​
before
string

cursor for pagination

​
lang
string

Translation language requested. Please see the list of supported languages. Defaults to en-GB

​
searchlang
string

The language of the search query, so you can search in other languages, defaults to lang if not provided

​
name
string

The name of the exercise to search for

​
alias
string

The alias of the exercise to search for

​
primaryMuscle
enum<string>[]

The primary muscle targeted by the exercise

Available options:
ABDOMINALS,
ADDUCTORS,
BICEPS,
CHEST,
CALVES,
LOWER_BACK,
TRICEPS,
FOREARMS,
ABDUCTORS,
HAMSTRINGS,
QUADRICEPS,
SHOULDERS,
MIDDLE_BACK,
GLUTES,
LATS,
TRAPS,
NECK
​
secondaryMuscle
enum<string>[]

The secondary muscle targeted by the exercise

Available options:
ABDOMINALS,
ADDUCTORS,
BICEPS,
CHEST,
CALVES,
LOWER_BACK,
TRICEPS,
FOREARMS,
ABDUCTORS,
HAMSTRINGS,
QUADRICEPS,
SHOULDERS,
MIDDLE_BACK,
GLUTES,
LATS,
TRAPS,
NECK
​
category
enum<string>[]

The category of the exercise

Available options:
STRENGTH,
STRETCHING,
PLYOMETRICS,
STRONGMAN,
POWERLIFTING,
CARDIO,
OLYMPIC_WEIGHTLIFTING
​
force
(enum<string> | null)[]

The force applied by the exercise

Available options:
PULL,
PUSH,
STATIC
​
level
(enum<string> | null)[]

The level of the exercise

Available options:
BEGINNER,
INTERMEDIATE,
EXPERT
​
mechanic
(enum<string> | null)[]

The mechanic of the exercise

Available options:
COMPOUND,
ISOLATION
​
equipment
(enum<string> | null)[]

The equipment required for the exercise

Available options:
BODY_ONLY,
MACHINE,
OTHER,
FOAM_ROLL,
KETTLEBELLS,
DUMBBELL,
BARBELL,
CABLE,
BANDS,
MEDICINE_BALL,
E_Z_CURL_BAR,
EXERCISE_BALL

Response

200 - application/json
successful operation
​
exercises
object[]
​
pagination
object