Return Workouts of Clients or Prospects

Description

This endpoint returns all workouts associated with a client, prospect, or staff member, allowing filtering by specific parameters such as workout ID or status (inactive/deleted).

🔑 Query Parameters

Parameter	Type	Required	Description
idClient	int32	No	ID of the client to search for workouts.
idProspect	int32	No	ID of the prospect to search for workouts.
idEmployee	int32	No	ID of the staff member to search for workouts.
idWorkout	int32	No	Specific ID to search for a workout.
inactive	boolean	No	Filters only inactive workouts. Default value: `false`.
deleted	boolean	No	Filters only deleted workouts. Default value: `false`.

📤 Response Structure

The response returns all workouts associated with a client, prospect, or staff member, including information about the holder, workout data, series, exercises, and execution settings.

Field	Type	Description
`workouts`	array	List of workouts associated with the client, prospect, or staff member.
`id`	int32	Main identifier of the holder returned (usually the client).
`idClient`	int32	ID of the client associated with the workouts (when applicable).
`idProspect`	int32	ID of the prospect associated with the workouts (when applicable).
`idEmployee`	int32	ID of the staff member associated with the workouts (when applicable).
`name`	string	Full name of the holder.
`photoUrl`	string	URL of the holder's photo (when available).
`firstName`	string	First name of the holder.
`lastName`	string	Last name of the holder.

🧩 Structure of `workouts`

Field	Type	Description
`idWorkout`	int32	Unique identifier of the workout.
`workoutName`	string	Name of the prescribed workout.
`observations`	string	General observations of the workout.
`idClient`	int32	ID of the client linked to the workout.
`idProspect`	int32	ID of the prospect linked to the workout.
`idEmployee`	int32	ID of the staff member linked to the workout.
`flDefaultWorkout`	boolean	Indicates if the workout is a default workout.
`isDeleted`	boolean	Indicates if the workout has been logically deleted.
`creationDate`	string (date-time)	Creation date of the workout.
`startDate`	string (date-time)	Start date of the workout's validity.
`expiryDate`	string (date-time)	End date of the workout's validity.
`tags`	array	List of tags associated with the workout.
`restrictions`	array	List of restrictions associated with the workout.
`series`	array	List of series linked to the workout.
`idInstructor`	int32	ID of the instructor responsible for the workout.
`instructorName`	string	Name of the responsible instructor.
`photoUrl`	string	URL of the instructor's photo.
`instructorPhoto`	string	Alternative URL of the instructor's photo.
`totalSessions`	int32	Total number of sessions planned in the workout.
`weeklyQuantity`	int32	Number of weekly sessions planned.
`weeklyFrequency`	int32	Weekly frequency of the workout.
`idLastWorkut`	int32	ID of the last executed workout.
`workoutStatus`	int32	Current status of the workout in the system.

🧩 Structure of `tags`

Field	Type	Description
`idTagTreino`	int32	Identifier of the workout tag.
`nome`	string	Name of the tag.
`idFilial`	int32	ID of the branch associated with the tag.
`filial`	object	Information about the branch (when available).
`evoTreinoTags`	array	Auxiliary relationships of the tag with the workout.

🧩 Structure of `series`

Field	Type	Description
`seriesName`	string	Name of the series.
`seriesObservations`	string	Specific observations of the series.
`seriesOrder`	int32	Order of the series within the workout.
`seriesItems`	array	List of exercises that make up the series.

🧩 Structure of `seriesItems`

Field	Type	Description
`idExercise`	int32	Identifier of the exercise.
`exerciseType`	string	Type of execution of the exercise (e.g., repetition, time).
`exerciseObservation`	string	Specific observations of the exercise.
`order`	int32	Order of the exercise within the series.
`sets`	int32	Number of sets planned for the exercise.
`exerciseTimeSeconds`	int32	Execution time of the exercise in seconds (when applicable).
`intervalSeconds`	int32	Rest interval in seconds.
`repetitions`	int32	Number of repetitions.
`load`	number	Load applied to the exercise.
`loadType`	string	Type of load (e.g., Kg, Lb).
`compound`	array	List of compound exercises.
`dropset`	array	Dropset configuration of the exercise.
`progressive`	array	Load progression configuration.

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Get all client's or prospect's or employee's workouts of the new prescription

Return Workouts of Clients or Prospects

Description

🔑 Query Parameters

📤 Response Structure

🧩 Structure of `workouts`

🧩 Structure of `tags`

🧩 Structure of `series`

🧩 Structure of `seriesItems`

Request

Request Code Samples

Responses

Get all client's or prospect's or employee's workouts of the new prescription

Return Workouts of Clients or Prospects#

Description#

🔑 Query Parameters#

📤 Response Structure#

🧩 Structure of workouts#

🧩 Structure of tags#

🧩 Structure of series#

🧩 Structure of seriesItems#

Request

Request Code Samples

Responses

Return Workouts of Clients or Prospects

Description

🔑 Query Parameters

📤 Response Structure

🧩 Structure of `workouts`

🧩 Structure of `tags`

🧩 Structure of `series`

🧩 Structure of `seriesItems`