Get Fitness Assessment Protocol Details

Description

Returns the details and field configuration of a specific fitness assessment protocol.

The response structure varies according to the assessment type provided in the type parameter. Protocol identifiers are not unique across different assessment types; therefore, the type parameter determines which assessment type will be used to retrieve the protocol.

When the type parameter is not provided, the query defaults to Bioimpedance (type = 2).

🚧 Notes
The assessment types available for query are: 1 (Anamnesis), 2 (Bioimpedance), and 3 (Circumferences).
Skinfold assessments (type = 4) do not have custom protocols.
Fields with the Enabled suffix indicate whether the corresponding field is enabled in the protocol.
Fields with the Required suffix indicate whether the corresponding field is required in the protocol.

🔑 Path Parameters

Parameter	Type	Required	Description
`idProtocol`	int32	Yes	Identifier of the custom protocol within the corresponding fitness assessment type.

🔑 Query Parameters

Parameter	Type	Required	Description
`type`	int32	No	Fitness assessment type of the protocol. Available values: `1` = Anamnesis, `2` = Bioimpedance, and `3` = Circumferences. When omitted, `2` (Bioimpedance) is used by default.

📤 Response Structure

The response structure is dynamic and varies according to the type of the requested protocol.

🧩 Response Structure — Anamnesis (`type = 1`)

Field	Type	Description
`idProtocol`	int32	Identifier of the Anamnesis protocol.
`nameProtocol`	string	Protocol name.
`description`	string	Protocol description.
`isEvoDefault`	boolean	Indicates whether this is an EVO default protocol.
`morphologyEnabled`	boolean	Indicates whether the morphology field is enabled.
`objectivesEnabled`	boolean	Indicates whether the objectives field is enabled.
`healthHistoryEnabled`	boolean	Indicates whether the health history field is enabled.
`familyHealthHistoryEnabled`	boolean	Indicates whether the family health history field is enabled.
`medicationUseEnabled`	boolean	Indicates whether the medication use field is enabled.
`surgeriesEnabled`	boolean	Indicates whether the surgeries field is enabled.
`physicalActivityEnabled`	boolean	Indicates whether the physical activity field is enabled.
`sleepHoursEnabled`	boolean	Indicates whether the sleep hours field is enabled.
`sleepQualityEnabled`	boolean	Indicates whether the sleep quality field is enabled.
`professionalActivityEnabled`	boolean	Indicates whether the professional activity field is enabled.
`fitnessLevelEnabled`	boolean	Indicates whether the fitness level field is enabled.
`smokerEnabled`	boolean	Indicates whether the smoking-related field is enabled.
`alcoholIntakeEnabled`	boolean	Indicates whether the alcohol intake field is enabled.
`chronicPainsEnabled`	boolean	Indicates whether the chronic pain field is enabled.
`healthFilesEnabled`	boolean	Indicates whether the health-related files field is enabled.
`morphologyRequired`	boolean	Indicates whether the morphology field is required.
`objectivesRequired`	boolean	Indicates whether the objectives field is required.
`healthHistoryRequired`	boolean	Indicates whether the health history field is required.
`familyHealthHistoryRequired`	boolean	Indicates whether the family health history field is required.
`medicationUseRequired`	boolean	Indicates whether medication use information is required.
`surgeriesRequired`	boolean	Indicates whether surgery information is required.
`physicalActivityRequired`	boolean	Indicates whether physical activity information is required.
`sleepHoursRequired`	boolean	Indicates whether sleep hours are required.
`sleepQualityRequired`	boolean	Indicates whether sleep quality is required.
`professionalActivityRequired`	boolean	Indicates whether professional activity is required.
`fitnessLevelRequired`	boolean	Indicates whether fitness level is required.
`smokerRequired`	boolean	Indicates whether smoking information is required.
`alcoholIntakeRequired`	boolean	Indicates whether alcohol intake information is required.
`chronicPainsRequired`	boolean	Indicates whether chronic pain information is required.
`healthFilesRequired`	boolean	Indicates whether health-related files are required.
`customQuestions`	arrayobject	List of custom questions configured in the protocol. See below.

🧩 `customQuestions` Structure

Field	Type	Description
`idQuestion`	int32	Identifier of the custom question.
`question`	string	Custom question text.
`required`	boolean	Indicates whether an answer to the question is required.

🧩 Response Structure — Bioimpedance (`type = 2`)

Field	Type	Description
`idProtocol`	int32	Identifier of the Bioimpedance protocol.
`nameProtocol`	string	Protocol name.
`description`	string	Protocol description.
`isEvoDefault`	boolean	Indicates whether this is an EVO default protocol.
`fatMassEnabled`	boolean	Indicates whether the fat mass field is enabled.
`fatFreeMassEnabled`	boolean	Indicates whether the fat-free mass field is enabled.
`muscleMassEnabled`	boolean	Indicates whether the muscle mass field is enabled.
`skeletalMassEnabled`	boolean	Indicates whether the skeletal mass field is enabled.
`residualsEnabled`	boolean	Indicates whether the residuals field is enabled.
`visceralFatPercentageEnabled`	boolean	Indicates whether the visceral fat percentage field is enabled.
`bodyWaterEnabled`	boolean	Indicates whether the body water field is enabled.
`bodyWaterPercentageEnabled`	boolean	Indicates whether the body water percentage field is enabled.
`bodyWaterLitersEnabled`	boolean	Indicates whether the body water in liters field is enabled.
`bodyFatPercentageEnabled`	boolean	Indicates whether the body fat percentage field is enabled.
`basalMetabolicRateEnabled`	boolean	Indicates whether the basal metabolic rate field is enabled.
`waistHipRatioEnabled`	boolean	Indicates whether the waist-to-hip ratio field is enabled.
`metabolicAgeEnabled`	boolean	Indicates whether the metabolic age field is enabled.
`obesityDegreeEnabled`	boolean	Indicates whether the obesity degree field is enabled.
`muscleMassRightArmEnabled`	boolean	Indicates whether the right arm muscle mass field is enabled.
`muscleMassLeftArmEnabled`	boolean	Indicates whether the left arm muscle mass field is enabled.
`muscleMassRightLegEnabled`	boolean	Indicates whether the right leg muscle mass field is enabled.
`muscleMassLeftLegEnabled`	boolean	Indicates whether the left leg muscle mass field is enabled.
`muscleMassTrunkEnabled`	boolean	Indicates whether the trunk muscle mass field is enabled.
`fatMassRightArmEnabled`	boolean	Indicates whether the right arm fat mass field is enabled.
`fatMassLeftArmEnabled`	boolean	Indicates whether the left arm fat mass field is enabled.
`fatMassRightLegEnabled`	boolean	Indicates whether the right leg fat mass field is enabled.
`fatMassLeftLegEnabled`	boolean	Indicates whether the left leg fat mass field is enabled.
`fatMassTrunkEnabled`	boolean	Indicates whether the trunk fat mass field is enabled.
`fatMassRequired`	boolean	Indicates whether fat mass is required.
`fatFreeMassRequired`	boolean	Indicates whether fat-free mass is required.
`muscleMassRequired`	boolean	Indicates whether muscle mass is required.
`skeletalMassRequired`	boolean	Indicates whether skeletal mass is required.
`residualsRequired`	boolean	Indicates whether residuals are required.
`visceralFatPercentageRequired`	boolean	Indicates whether visceral fat percentage is required.
`bodyWaterRequired`	boolean	Indicates whether body water is required.
`bodyFatPercentageRequired`	boolean	Indicates whether body fat percentage is required.
`basalMetabolicRateRequired`	boolean	Indicates whether basal metabolic rate is required.
`waistHipRatioRequired`	boolean	Indicates whether waist-to-hip ratio is required.
`metabolicAgeRequired`	boolean	Indicates whether metabolic age is required.
`obesityDegreeRequired`	boolean	Indicates whether obesity degree is required.
`muscleMassRightArmRequired`	boolean	Indicates whether right arm muscle mass is required.
`muscleMassLeftArmRequired`	boolean	Indicates whether left arm muscle mass is required.
`muscleMassRightLegRequired`	boolean	Indicates whether right leg muscle mass is required.
`muscleMassLeftLegRequired`	boolean	Indicates whether left leg muscle mass is required.
`muscleMassTrunkRequired`	boolean	Indicates whether trunk muscle mass is required.
`fatMassRightArmRequired`	boolean	Indicates whether right arm fat mass is required.
`fatMassLeftArmRequired`	boolean	Indicates whether left arm fat mass is required.
`fatMassRightLegRequired`	boolean	Indicates whether right leg fat mass is required.
`fatMassLeftLegRequired`	boolean	Indicates whether left leg fat mass is required.
`fatMassTrunkRequired`	boolean	Indicates whether trunk fat mass is required.

🧩 Response Structure — Circumferences (`type = 3`)

Field	Type	Description
`idProtocol`	int32	Identifier of the Circumferences protocol.
`nameProtocol`	string	Protocol name.
`description`	string	Protocol description.
`isEvoDefault`	boolean	Indicates whether this is an EVO default protocol.
`neckEnabled`	boolean	Indicates whether the neck measurement is enabled.
`shouldersEnabled`	boolean	Indicates whether the shoulder measurement is enabled.
`rightShoulderEnabled`	boolean	Indicates whether the right shoulder measurement is enabled.
`leftShoulderEnabled`	boolean	Indicates whether the left shoulder measurement is enabled.
`chestEnabled`	boolean	Indicates whether the chest measurement is enabled.
`chestExpirationEnabled`	boolean	Indicates whether the chest measurement during expiration is enabled.
`hipEnabled`	boolean	Indicates whether the hip measurement is enabled.
`waistEnabled`	boolean	Indicates whether the waist measurement is enabled.
`abdomenEnabled`	boolean	Indicates whether the abdomen measurement is enabled.
`rightArmContractedEnabled`	boolean	Indicates whether the contracted right arm measurement is enabled.
`rightArmRelaxedEnabled`	boolean	Indicates whether the relaxed right arm measurement is enabled.
`leftArmContractedEnabled`	boolean	Indicates whether the contracted left arm measurement is enabled.
`leftArmRelaxedEnabled`	boolean	Indicates whether the relaxed left arm measurement is enabled.
`rightForearmEnabled`	boolean	Indicates whether the right forearm measurement is enabled.
`leftForearmEnabled`	boolean	Indicates whether the left forearm measurement is enabled.
`rightWristEnabled`	boolean	Indicates whether the right wrist measurement is enabled.
`leftWristEnabled`	boolean	Indicates whether the left wrist measurement is enabled.
`rightProximalThighEnabled`	boolean	Indicates whether the right proximal thigh measurement is enabled.
`leftProximalThighEnabled`	boolean	Indicates whether the left proximal thigh measurement is enabled.
`rightMedialThighEnabled`	boolean	Indicates whether the right medial thigh measurement is enabled.
`leftMedialThighEnabled`	boolean	Indicates whether the left medial thigh measurement is enabled.
`rightDistalThighEnabled`	boolean	Indicates whether the right distal thigh measurement is enabled.
`leftDistalThighEnabled`	boolean	Indicates whether the left distal thigh measurement is enabled.
`rightKneeEnabled`	boolean	Indicates whether the right knee measurement is enabled.
`leftKneeEnabled`	boolean	Indicates whether the left knee measurement is enabled.
`rightCalfEnabled`	boolean	Indicates whether the right calf measurement is enabled.
`leftCalfEnabled`	boolean	Indicates whether the left calf measurement is enabled.
`rightAnkleEnabled`	boolean	Indicates whether the right ankle measurement is enabled.
`leftAnkleEnabled`	boolean	Indicates whether the left ankle measurement is enabled.
`neckRequired`	boolean	Indicates whether the neck measurement is required.
`shouldersRequired`	boolean	Indicates whether the shoulder measurement is required.
`rightShoulderRequired`	boolean	Indicates whether the right shoulder measurement is required.
`leftShoulderRequired`	boolean	Indicates whether the left shoulder measurement is required.
`chestRequired`	boolean	Indicates whether the chest measurement is required.
`chestExpirationRequired`	boolean	Indicates whether the chest measurement during expiration is required.
`hipRequired`	boolean	Indicates whether the hip measurement is required.
`waistRequired`	boolean	Indicates whether the waist measurement is required.
`abdomenRequired`	boolean	Indicates whether the abdomen measurement is required.
`rightArmContractedRequired`	boolean	Indicates whether the contracted right arm measurement is required.
`rightArmRelaxedRequired`	boolean	Indicates whether the relaxed right arm measurement is required.
`leftArmContractedRequired`	boolean	Indicates whether the contracted left arm measurement is required.
`leftArmRelaxedRequired`	boolean	Indicates whether the relaxed left arm measurement is required.
`rightForearmRequired`	boolean	Indicates whether the right forearm measurement is required.
`leftForearmRequired`	boolean	Indicates whether the left forearm measurement is required.
`rightWristRequired`	boolean	Indicates whether the right wrist measurement is required.
`leftWristRequired`	boolean	Indicates whether the left wrist measurement is required.
`rightProximalThighRequired`	boolean	Indicates whether the right proximal thigh measurement is required.
`leftProximalThighRequired`	boolean	Indicates whether the left proximal thigh measurement is required.
`rightMedialThighRequired`	boolean	Indicates whether the right medial thigh measurement is required.
`leftMedialThighRequired`	boolean	Indicates whether the left medial thigh measurement is required.
`rightDistalThighRequired`	boolean	Indicates whether the right distal thigh measurement is required.
`leftDistalThighRequired`	boolean	Indicates whether the left distal thigh measurement is required.
`rightKneeRequired`	boolean	Indicates whether the right knee measurement is required.
`leftKneeRequired`	boolean	Indicates whether the left knee measurement is required.
`rightCalfRequired`	boolean	Indicates whether the right calf measurement is required.
`leftCalfRequired`	boolean	Indicates whether the left calf measurement is required.
`rightAnkleRequired`	boolean	Indicates whether the right ankle measurement is required.
`leftAnkleRequired`	boolean	Indicates whether the left ankle measurement is required.

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 *****************

Get a protocol detail (field configuration) of any type (RF-2). The response shape is dynamic per type. Ids are not unique across types, so type selects the source.

Get Fitness Assessment Protocol Details

Description

🔑 Path Parameters

🔑 Query Parameters

📤 Response Structure

🧩 Response Structure — Anamnesis (`type = 1`)

🧩 `customQuestions` Structure

🧩 Response Structure — Bioimpedance (`type = 2`)

🧩 Response Structure — Circumferences (`type = 3`)

Request

Request Code Samples

Responses

Get a protocol detail (field configuration) of any type (RF-2). The response shape is dynamic per type. Ids are not unique across types, so type selects the source.

Get Fitness Assessment Protocol Details#

Description#

🔑 Path Parameters#

🔑 Query Parameters#

📤 Response Structure#

🧩 Response Structure — Anamnesis (type = 1)#

🧩 customQuestions Structure#

🧩 Response Structure — Bioimpedance (type = 2)#

🧩 Response Structure — Circumferences (type = 3)#

Request

Request Code Samples

Responses

Get Fitness Assessment Protocol Details

Description

🔑 Path Parameters

🔑 Query Parameters

📤 Response Structure

🧩 Response Structure — Anamnesis (`type = 1`)

🧩 `customQuestions` Structure

🧩 Response Structure — Bioimpedance (`type = 2`)

🧩 Response Structure — Circumferences (`type = 3`)