Get Members' Latest Workouts

Description

This endpoint provides a management view of the latest workouts of active members of a branch, with filtering options by workout status, instructor, and creation, expiration, edit, and last completed session date ranges.

The query considers only workouts from the new workout prescription version. When a member has no workout from the new version, including cases where all of the member's workouts are from the legacy version, the member is considered to have no workout (workoutStatus = 0).

The response returns registration and management information for the latest workout considered for each member, without including detailed workout data such as exercises and sets.

🔑 Query Parameters

Parameter	Type	Required	Description
`idBranch`	int32	Situational	Identifier of the branch whose workouts will be retrieved. For a General Admin key, it is optional and, when omitted, the query considers all branches. For a multilocation key, it is required. For a branch key, the scope is always the branch associated with the key; providing a different branch results in a `400` error.
`workoutStatus`	int32	No	Filters by the status of the latest workout considered for the member. Values: `0` = no workout, `1` = expired, `2` = active, and `4` = future start date.
`idInstructor`	int32	No	Filters by the identifier of the instructor who prescribed the workout.
`createdDateStart`	string (date-time)	No	Start date and time of the workout creation period. The start of the range is inclusive.
`createdDateEnd`	string (date-time)	No	End date and time of the workout creation period. The end of the range is inclusive and considers the entire day.
`expiryDateStart`	string (date-time)	No	Start date and time of the workout expiration period. The start of the range is inclusive.
`expiryDateEnd`	string (date-time)	No	End date and time of the workout expiration period. The end of the range is inclusive and considers the entire day.
`editDateStart`	string (date-time)	No	Start date and time of the workout's last edit period. The start of the range is inclusive. Workouts that have never been edited are not returned when this filter is used.
`editDateEnd`	string (date-time)	No	End date and time of the workout's last edit period. The end of the range is inclusive and considers the entire day.
`lastSessionDateStart`	string (date-time)	No	Start date and time of the member's last completed session period. The start of the range is inclusive.
`lastSessionDateEnd`	string (date-time)	No	End date and time of the member's last completed session period. The end of the range is inclusive and considers the entire day.
`take`	int32	No	Number of records per page. The maximum limit is `50`. Values greater than `50` or non-positive values use `50`. Default: `50`.
`skip`	int32	No	Number of records to skip before returning the results. Default: `0`.

🔷 Workout Status

The workoutStatus parameter allows members to be filtered according to the status of the latest workout considered in the query.

Code	Status	Description
`0`	No workout	The member does not have a workout from the new workout prescription version. This also applies when all of the member's workouts belong to the legacy version.
`1`	Expired	The latest workout from the new version has expired.
`2`	Active	The latest workout from the new version is active.
`4`	Future start date	The latest workout from the new version has a start date later than the query date.

📤 Response Structure

The response returns a list containing the latest workout from the new version for each active member considered in the query.

The returned data is intended for management and registration purposes. Detailed workout information, such as exercises, sets, and other prescription settings, is not included in this response.

Field	Type	Description
`id`	int32	Identifier of the returned record.
`idBranch`	int32	Identifier of the branch associated with the record.
`idClient`	int32	Identifier of the client associated with the workout.
`idProspect`	int32	Identifier of the associated prospect, when applicable.
`idEmployee`	int32	Identifier of the employee associated with the workout.
`name`	string	Name associated with the record.
`photoUrl`	string	URL of the client's photo.
`firstName`	string	Client's first name.
`lastName`	string	Client's last name.
`idWorkout`	int32	Workout identifier.
`workoutName`	string	Workout name.
`observations`	string	Workout-related observations.
`flDefaultWorkout`	boolean	Indicates whether the workout is the default workout.
`isDeleted`	boolean	Indicates whether the workout is marked as deleted.
`creationDate`	date-time	Date and time when the workout was created.
`editedDate`	date-time	Date and time of the workout's last edit.
`startDate`	date-time	Workout start date and time.
`expiryDate`	date-time	Workout expiration date and time.
`tags`	arrayobject	List of tags associated with the workout. See below.
`restrictions`	arrayobject	List of restrictions associated with the workout. See below.
`workoutStatus`	int32	Workout status. See the values above.
`idInstructor`	int32	Identifier of the instructor who prescribed the workout.
`instructorName`	string	Name of the instructor who prescribed the workout.
`instructorPhoto`	string	URL of the instructor's photo.
`idLastWorkut`	int32	Identifier of the latest workout considered.
`totalSessions`	int32	Total number of sessions planned or registered for the workout.
`completedSessions`	int32	Number of completed sessions.
`lastCompletedSessionDate`	date-time	Date and time of the member's last completed session.
`weeklyQuantity`	int32	Weekly quantity configured for the workout.
`weeklyFrequency`	int32	Weekly frequency configured for the workout.

🧩 `tags` Structure

Field	Type	Description
`idTagTreino`	int32	Identifier of the workout tag.
`nome`	string	Tag name.
`idFilial`	int32	Identifier of the branch associated with the tag.

🧩 `restrictions` Structure

Field	Type	Description
`idRestricaoTreino`	int32	Identifier of the workout restriction.
`nome`	string	Restriction name.
`idFilial`	int32	Identifier of the branch associated with the restriction.

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

Responses

🟢200

application/json

Success

Body

Example

[
    {
        "id": 0,
        "idBranch": 0,
        "idClient": 0,
        "idProspect": 0,
        "idEmployee": 0,
        "name": "string",
        "photoUrl": "string",
        "firstName": "string",
        "lastName": "string",
        "idWorkout": 0,
        "workoutName": "string",
        "observations": "string",
        "flDefaultWorkout": true,
        "isDeleted": true,
        "creationDate": "2019-08-24T14:15:22.123Z",
        "editedDate": "2019-08-24T14:15:22.123Z",
        "startDate": "2019-08-24T14:15:22.123Z",
        "expiryDate": "2019-08-24T14:15:22.123Z",
        "tags": [
            {
                "idTagTreino": 0,
                "nome": "string",
                "idFilial": 0
            }
        ],
        "restrictions": [
            {
                "idRestricaoTreino": 0,
                "nome": "string",
                "idFilial": 0
            }
        ],
        "workoutStatus": 0,
        "idInstructor": 0,
        "instructorName": "string",
        "instructorPhoto": "string",
        "idLastWorkut": 0,
        "totalSessions": 0,
        "completedSessions": 0,
        "lastCompletedSessionDate": "2019-08-24T14:15:22.123Z",
        "weeklyQuantity": 0,
        "weeklyFrequency": 0
    }
]

🟠400

Get the latest workout of each active member of a branch (management view). Only workouts from the new workout version are considered - a member whose workouts all come from the legacy version is reported as having no workout (workoutStatus 0).

Get Members' Latest Workouts#

Description#

🔑 Query Parameters#

🔷 Workout Status#

📤 Response Structure#

🧩 tags Structure#

🧩 restrictions Structure#

Request