Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Public API access token issued by /public/v1/oauth/token. Example: Authorization: Bearer fspt_.... Each resource request rechecks the token company's current provider access. Disabling access blocks existing tokens with 403 auth.provider_unavailable.

Query Parameters

query
string

Full-text exercise search term.

Maximum string length: 100

Alias for query. When set, the items shape matches the non-search (filter-only) branch exactly.

Maximum string length: 100
excludeExerciseIds

Exclude one or more exercises from results (comma-separated string or array of exercise ObjectIds). Aliases accepted: excludeExerciseId / exerciseIds / exerciseId. Invalid id → 400 WORKOUTEXERCISE_EXERCISEID_INVALID. Echoed in selectedFilters.excludeExerciseIds.

Example:

"6925d2764ac340a53e012927,6925d2764ac340a53e012928"

tab
enum<string>
default:library

Author-based tab. library (default) = all visible exercises; my = exercises created by the caller; member = client-created exercises (addedByRole: Client). Unknown values fall back to library. my requires a valid authenticated user id.

Available options:
library,
my,
member
muscleGroups
enum<string>[]

Comma-separated muscle groups. Matches primaryMuscle OR secondaryMuscles.

Available options:
Chest,
Back,
Lats,
Traps,
Shoulders,
Biceps,
Triceps,
Forearms,
Core,
Abs,
Obliques,
Glutes,
Quads,
Hamstrings,
Calves,
Adductors,
Abductors,
Hip Flexors,
Full Body,
Cardio / Conditioning,
Neck,
Lower Back
equipments
enum<string>[]

Comma-separated equipment keys (matches equipment).

Available options:
Dumbbells,
AdjustableDumbbells,
Kettlebell,
AdjustableKettlebell,
CompetitionKettlebell,
Medicineball,
SlamBall,
WallBall,
Weightplate,
BumperPlates,
FractionalPlates,
LoadableDumbbellHandle,
Sandbag,
StrongmanSandbag,
Bulgarianbag,
Aquabag,
Aquaball,
Hydrovest,
MagneticBell,
Macebell,
SteelClub,
IndianClub,
Barbell,
OlympicBarbell,
TechniqueBar,
EZBar,
TrapBar,
SafetySquatBar,
SwissBar,
CamberedBar,
AxleBar,
Landmine,
Bench,
FlatBench,
AdjustableBench,
InclineBench,
DeclineBench,
SealRowBench,
HipThrustBench,
BenchPressRack,
SquatRack,
SquatStand,
PowerRack,
WallMountedRack,
HalfRack,
SmithMachine,
Monolift,
JammerArms,
BarbellJack,
WeightTree,
PlateStorage,
DeadliftPlatform,
Rig,
StrengthMachinesPlateloaded,
StrengthMachinesWeightstack,
StrengthMachinesPneumatic,
MultiGym,
LegPressMachine,
VerticalLegPressMachine,
LeverageSquatMachine,
LinearHackSquatMachine,
BeltSquatMachine,
PendulumSquatMachine,
VSquatMachine,
HackSquatMachine,
LegExtensionMachine,
LegCurlMachine,
SeatedLegCurlMachine,
LyingLegCurlMachine,
StandingLegCurlMachine,
StandingCalfRaiseMachine,
SeatedCalfRaiseMachine,
CalfPressMachine,
HipThrustMachine,
GluteDriveMachine,
GluteKickbackMachine,
HipExtensionMachine,
HipAbductionMachine,
HipAdductionMachine,
ChestPressMachine,
VerticalChestPressMachine,
InclineChestPressMachine,
DeclineChestPressMachine,
IsoLateralChestPressMachine,
IsoLateralInclinePressMachine,
ShoulderPressMachine,
IsoLateralShoulderPressMachine,
MultiPressMachine,
LateralRaiseMachine,
RearDeltMachine,
PecDeckMachine,
PulloverMachine,
LatPulldownMachine,
IsoLateralLatPulldownMachine,
AssistedPullupMachine,
AssistedDipMachine,
SeatedDipMachine,
SeatedRowMachine,
LowRowMachine,
HighRowMachine,
IsoLateralRowMachine,
ChestSupportedRowMachine,
TBarRowMachine,
BicepsCurlMachine,
PreacherCurlMachine,
TricepsExtensionMachine,
AbCrunchMachine,
AbCoasterMachine,
RotaryTorsoMachine,
BackExtensionMachine,
SeatedBackExtensionMachine,
HyperextensionBench,
ReverseHyper,
GHD,
Kinesis,
Pulley,
CableMachine,
CableStation,
CableColumn,
CableCrossover,
DualAdjustablePulley,
SingleCableTower,
FunctionalTrainer,
TotalGymGTS,
Gymstick,
ViPR,
RipTrainer,
Battlerope,
ProwlerSled,
FarmersHandles,
Yoke,
Tire,
Sledgehammer,
TorqueTank,
SledTrack,
WallBallTarget,
AgilityPoles,
MiniHurdles,
SprintParachute,
PullUpBar,
Parallelbars,
DipBars,
Equalizer,
Suspensiontrainer,
SuspensionSlingTrainer,
GymnasticRings,
MonkeyBars,
PegBoard,
RopeClimb,
Wall,
StallBars,
DoorPullUpBar,
PushUpHandles,
AbStraps,
Boxstep,
SoftPlyoBox,
Hurdle,
Speedladder,
Parallettes,
NordicBench,
SissySquatBench,
Cardio,
Treadmill,
CurvedTreadmill,
AirRunner,
AssaultRunner,
StationaryBike,
UprightBike,
RecumbentBike,
BikeErg,
SpinBike,
AirBike,
Rower,
WaterRower,
FanRower,
ArmErgometer,
SkiErg,
Elliptical,
ArcTrainer,
NuStep,
StairClimber,
StepMill,
JacobsLadder,
VersaClimber,
Bosu,
Balanceball,
Exerciseball,
PilatesTennisball,
PilatesRing,
YogaMat,
YogaBlock,
YogaWheel,
StretchStrap,
MobilityStick,
MassageBall,
PeanutMassageBall,
Airpad,
Balanceboard,
BalancePad,
WobbleBoard,
Glidedisc,
Foamroller,
Elasticbands,
TherapyBand,
Resistanceband,
MiniBand,
PullUpAssistBand,
Powertube,
AnkleWeights,
SlantBoard,
Vibrationtraining,
CableRope,
StraightBarAttachment,
CurlBarAttachment,
LatBarAttachment,
TricepsBarAttachment,
RowHandle,
DHandle,
DoubleDHandle,
AnkleCuff,
CableCuff,
LandmineHandle,
MagGripAttachment,
DipBelt,
AbWheel,
WristRoller,
FatGrip,
Chain,
DoorAnchor,
JumpRope,
SpeedRope,
WeightedJumpRope,
SledHarness,
LiftingStraps,
LiftingHooks,
WristWraps,
WeightliftingBelt,
Clubbel,
Stick,
Bodybow,
BuddySystem,
Multinet,
Flowin,
Aerialhoop,
Dancingpole,
Trapeze,
HulaHoop,
Trampoline,
XCO,
PilatesReformer,
PilatesChair,
PilatesCadillac,
PilatesBarrel,
PilatesSpringboard,
BalanceBeam,
TreatmentTable,
RehabTable,
SlideBoard
categories
enum<string>[]

Comma-separated categories (matches primaryCategory).

Available options:
Agility & Speed,
Strength,
Hypertrophy,
Strength - Dynamic,
Strength - Explosive,
Strength - Static,
Cardio,
Cardio - Duration,
Cardio - Interval,
HIIT,
Crossfit,
Mobility,
Stretching,
Core,
Coordination & Balance,
Movement Prep,
Functional Training,
Recovery,
Sports,
Martial Arts,
Yoga,
Other,
GROUP_WORKOUT_TEMPLATE,
Plyometric,
Cycling,
Cardio - interval,
Mobilisation,
Stabilisation,
Daily Living,
Target zone,
Respiration,
Breathing,
Massage,
Outdoor sports,
Indoor sports,
Dance,
Group Lessons,
Martial arts,
Material Arts,
Fight skills,
Mind and body,
,
default
page
integer
Required range: x >= 1
Example:

1

limit
integer
Required range: 1 <= x <= 100
Example:

20

primaryCategory
enum<string>
Available options:
Agility & Speed,
Strength,
Hypertrophy,
Strength - Dynamic,
Strength - Explosive,
Strength - Static,
Cardio,
Cardio - Duration,
Cardio - Interval,
HIIT,
Crossfit,
Mobility,
Stretching,
Core,
Coordination & Balance,
Movement Prep,
Functional Training,
Recovery,
Sports,
Martial Arts,
Yoga,
Other,
GROUP_WORKOUT_TEMPLATE,
Plyometric,
Cycling,
Cardio - interval,
Mobilisation,
Stabilisation,
Daily Living,
Target zone,
Respiration,
Breathing,
Massage,
Outdoor sports,
Indoor sports,
Dance,
Group Lessons,
Martial arts,
Material Arts,
Fight skills,
Mind and body,
,
default
secondaryCategory
enum<string>
Available options:
Agility & Speed,
Strength,
Hypertrophy,
Strength - Dynamic,
Strength - Explosive,
Strength - Static,
Cardio,
Cardio - Duration,
Cardio - Interval,
HIIT,
Crossfit,
Mobility,
Stretching,
Core,
Coordination & Balance,
Movement Prep,
Functional Training,
Recovery,
Sports,
Martial Arts,
Yoga,
Other,
GROUP_WORKOUT_TEMPLATE,
Plyometric,
Cycling,
Cardio - interval,
Mobilisation,
Stabilisation,
Daily Living,
Target zone,
Respiration,
Breathing,
Massage,
Outdoor sports,
Indoor sports,
Dance,
Group Lessons,
Martial arts,
Material Arts,
Fight skills,
Mind and body,
,
default
primaryMuscle
enum<string>
Available options:
Chest,
Back,
Lats,
Traps,
Shoulders,
Biceps,
Triceps,
Forearms,
Core,
Abs,
Obliques,
Glutes,
Quads,
Hamstrings,
Calves,
Adductors,
Abductors,
Hip Flexors,
Full Body,
Cardio / Conditioning,
Neck,
Lower Back
secondaryMuscle
enum<string>
Available options:
Chest,
Back,
Lats,
Traps,
Shoulders,
Biceps,
Triceps,
Forearms,
Core,
Abs,
Obliques,
Glutes,
Quads,
Hamstrings,
Calves,
Adductors,
Abductors,
Hip Flexors,
Full Body,
Cardio / Conditioning,
Neck,
Lower Back
difficulty
enum<string>
Available options:
Beginner,
Intermediate,
Advanced
visibility
enum<string>
Available options:
Everyone,
Company,
Fitsociety
visibilityScope
enum<string>
Available options:
company,
everyone,
fitsociety
createdBy
string

Filter exercises by the user that created them.

Example:

"67f1234567890abcdef1234"

planId
string

Optional workout plan/template id. When combined with planMomentId, returned exercises that are already in that day include planPrescription.

Example:

"67f1234567890abcdef1234"

templateId
string

Alias for planId.

Example:

"67f1234567890abcdef1234"

planMomentId
string

Optional plan day/moment id used with planId to attach day-level target sets, reps, and RPE.

Example:

"67f1234567890abcdef1234"

dayId
string

Alias for planMomentId.

Example:

"67f1234567890abcdef1234"

Response

Exercise search results.

data
object
required
meta
object
required