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

secondaryMuscle
enum<string>[]

The secondary muscle targeted by the exercise

category
enum<string>[]

The category of the exercise

force
(enum<string> | null)[]

The force applied by the exercise

level
(enum<string> | null)[]

The level of the exercise

mechanic
(enum<string> | null)[]

The mechanic of the exercise

equipment
(enum<string> | null)[]

The equipment required for the exercise

Response

200 - application/json

successful operation

The response is of type object.