GET
/api/v11/user/subscriptions▶Request Headers
x-user-idx-user-access-token
Responses
200application/json; charset=utf-8
{
"extensions": [],
"subscriptions": [
{
"id": "integer",
"trial": "boolean",
"paused": "boolean",
"period": "string",
"status": "string",
"platform": "string",
"product_id": "string",
"start_date": "integer",
"account_hold": "boolean",
"expires_date": "integer",
"billing_error": "boolean",
"billing_retry": "boolean",
"auto_renew_status": "boolean",
"grace_period_end_date": "integer",
"subscription_management_url": "string"
}
]
}Response Headers
content-typex-runtimex-frame-optionsx-xss-protectionx-content-type-optionsx-permitted-cross-domain-policiesreferrer-policyserver_timestampuser_expireduser_trialetagx-request-idx-cacheviax-amz-cf-popx-amz-cf-id
GET
/api/v12/user▶Request Headers
x-user-idx-user-access-token
Query Parameters
| Name | Type |
|---|---|
| device_timestamp | string |
Responses
200application/json; charset=utf-8
{
"id": "integer",
"bio": "null",
"day": "integer",
"dob": "string",
"paid": "boolean",
"tags": ["string"],
"week": "integer",
"email": "string",
"trial": "boolean",
"gender": "null",
"locale": "string",
"sirens": "boolean",
"country": "string",
"goal_kg": "number",
"program": {
"id": "integer",
"name": "string",
"tags": [
{
"id": "integer",
"name": "string",
"type": "string"
}
],
"image": "string",
"is_new": "boolean",
"acronym": "string",
"trainer": {
"id": "integer",
"name": "string",
"code_name": "string",
"image_url": "string",
"hero_image_url": "string",
"profile_image_url": "string"
},
"workouts": [
{
"id": "integer",
"name": "string",
"details": "null",
"position": "integer",
"code_name": "string",
"week_groups": [
{
"id": "integer",
"name": "string",
"is_new": "boolean",
"end_week": "integer",
"start_week": "integer",
"trophy_image": "string",
"difficulty_level": "string"
}
]
}
],
"code_name": "string",
"html_body": "string",
"attributes": [
{
"id": "integer",
"name": "string",
"total": "string",
"value": "string",
"detail": "string",
"code_name": "string"
}
],
"card_image": "string",
"discipline": "string",
"assessments": [],
"html_summary": "string",
"challenges_count": "integer",
"difficulty_level": "string",
"workouts_per_week": "integer",
"avg_workout_duration": "integer",
"terms_and_conditions": "null",
"get_ready_message_body": "null",
"get_ready_message_title": "null"
},
"website": "null",
"ab_tests": [
{
"id": "integer",
"name": "string",
"value": "string",
"code_name": "string"
}
],
"is_guest": "boolean",
"language": "string",
"location": "null",
"progress": [],
"start_kg": "number",
"username": "string",
"water_ml": "integer",
"apple_uid": "null",
"height_cm": "integer",
"id_me_uid": "null",
"image_url": "string",
"instagram": "null",
"last_name": "string",
"time_zone": "string",
"tutorials": "boolean",
"weight_kg": "number",
"first_name": "string",
"google_uid": "null",
"idfa_token": "null",
"assessments": {
"one_rm_assessment": "null"
},
"geo_country": "string",
"is_browsing": "boolean",
"is_pregnant": "boolean",
"repetitions": "boolean",
"unit_system": "string",
"ab_test_type": "string",
"access_token": "string",
"cancelled_at": "integer",
"current_step": "string",
"external_ids": {
"braze": "string",
"universal": "string",
"apps_flyer_ios": "string",
"apps_flyer_android": "null"
},
"facebook_uid": "null",
"payment_type": "string",
"ab_test_types": ["string"],
"trainer_audio": "null",
"is_forum_admin": "boolean",
"technique_tips": "boolean",
"unit_system_id": "integer",
"billing_address": {
"zip": "null",
"city": "null",
"state": "null",
"country": "null",
"street_address": "null"
},
"deferlink_source": "null",
"food_category_id": "integer",
"completed_programs": ["string"],
"follow_after_reply": "boolean",
"food_category_name": "string",
"is_forum_activated": "boolean",
"program_start_date": "integer",
"started_workout_on": "integer",
"receive_newsletters": "boolean",
"display_yoga_as_flow": "null",
"hiit_timer_direction": "string",
"liss_timer_direction": "string",
"disclose_forum_online": "boolean",
"notify_new_post_alert": "boolean",
"notify_new_post_email": "boolean",
"browsing_total_workouts": "integer",
"last_challenge_duration": "null",
"notify_post_liked_alert": "boolean",
"steps_achievement_count": "integer",
"subscription_expires_at": "integer",
"use_suggestion_template": "boolean",
"water_achievement_count": "integer",
"allow_forum_notifications": "boolean",
"auto_exercise_substitutions": "boolean",
"browsing_remaining_workouts": "null",
"notify_post_mentioned_alert": "boolean",
"notify_post_mentioned_email": "boolean",
"notify_user_mentioned_alert": "boolean",
"notify_user_mentioned_email": "boolean",
"requested_health_data_consent": "boolean",
"notify_discussion_locked_alert": "boolean",
"notify_discussion_renamed_alert": "boolean"
}Response Headers
content-typex-request-idx-runtimex-frame-optionsx-xss-protectionx-content-type-optionsx-permitted-cross-domain-policiesreferrer-policyserver_timestampuser_expireduser_trialcontent-encodingetagx-cacheviax-amz-cf-popx-amz-cf-id
GET
/api/v1/ab-tests/{code_name}▶Path Parameters
{code_name}
Query Parameters
| Name | Type |
|---|---|
| condition | string |
Responses
200application/json; charset=utf-8
{
"id": "integer",
"data": [
{
"intro_video": {
"hls_url": "string",
"dash_url": "string"
}
}
],
"name": "string",
"value": "string",
"code_name": "string"
}GET
/api/v1/activity-insights/achievements▶Request Headers
x-user-idx-user-access-token
Query Parameters
| Name | Type |
|---|---|
| filter | string |
Responses
200application/json; charset=utf-8
{}Response Headers
content-typex-runtimex-frame-optionsx-xss-protectionx-content-type-optionsx-permitted-cross-domain-policiesreferrer-policyserver_timestampuser_expireduser_trialetagx-request-idx-cacheviax-amz-cf-popx-amz-cf-id
GET
/api/{slug}/referrals▶Path Parameters
{slug}
Request Headers
x-user-idx-user-access-token
Responses
200application/json; charset=utf-8
{}Response Headers
content-typex-runtimex-frame-optionsx-xss-protectionx-content-type-optionsx-permitted-cross-domain-policiesreferrer-policyserver_timestampuser_expireduser_trialetagx-request-idx-cacheviax-amz-cf-popx-amz-cf-id
GET
/api/v9/planner/events▶Request Headers
x-user-idx-user-access-token
Query Parameters
| Name | Type |
|---|---|
| month | string |
| year | string |
Responses
200application/json; charset=utf-8
{
"0": {
"id": "integer",
"name": "string",
"focus": {
"id": "integer",
"body": "string",
"name": "string",
"image": "string",
"image_tv": "null",
"card_image": "string",
"card_image_tv": "null",
"estimated_duration": "string"
},
"notes": "string",
"steps": "null",
"program": {
"id": "integer",
"name": "string",
"acronym": "string",
"trainer": {
"id": "integer",
"name": "string",
"code_name": "string",
"image_url": "string",
"hero_image_url": "string",
"profile_image_url": "string"
},
"code_name": "string"
},
"distance": "null",
"optional": "boolean",
"event_type": "string",
"workout_id": "integer",
"event_state": "string",
"recommended": "boolean",
"achievements": [],
"workout_tags": [],
"workout_type": "string",
"category_type": "string",
"section_count": "integer",
"completed_date": "integer",
"dashboard_item": "string",
"exercise_count": "integer",
"scheduled_date": "null",
"subcategory_type": "string",
"workout_session_id": "integer",
"recommended_workout": {
"name": "string",
"focus": {
"id": "integer",
"body": "string",
"name": "string",
"image": "string",
"image_tv": "null",
"card_image": "string",
"card_image_tv": "null",
"estimated_duration": "string"
},
"weekday": "integer",
"optional": "boolean",
"workout_id": "integer",
"workout_tags": [],
"category_type": "string",
"section_count": "integer",
"exercise_count": "integer",
"subcategory_type": "string"
},
"workout_session_url": "string",
"recommended_program_week": "integer"
}
}Response Headers
content-typex-request-idx-runtimex-frame-optionsx-xss-protectionx-content-type-optionsx-permitted-cross-domain-policiesreferrer-policyserver_timestampuser_expireduser_trialcontent-encodingetagx-cacheviax-amz-cf-popx-amz-cf-id
GET
/api/{slug}/user/subscriptions/offer▶Path Parameters
{slug}
Request Headers
x-user-idx-user-access-token
Query Parameters
| Name | Type |
|---|---|
| offer_guid | string |
Responses
200application/json; charset=utf-8
{
"analytics": "string",
"is_eligible": "boolean"
}Response Headers
content-typex-runtimex-frame-optionsx-xss-protectionx-content-type-optionsx-permitted-cross-domain-policiesreferrer-policyserver_timestampuser_expireduser_trialetagx-request-idx-cacheviax-amz-cf-popx-amz-cf-id
GET
/api/{slug}/chapters▶Path Parameters
{slug}
Request Headers
x-user-idx-user-access-token
Responses
200application/json; charset=utf-8
{
"0": {
"id": "integer",
"name": "string",
"position": "integer",
"sections": [
{
"id": "integer",
"name": "string",
"image": "string",
"is_read": "boolean",
"position": "integer"
}
],
"featured_image": "string"
}
}Response Headers
content-typex-request-idx-runtimex-frame-optionsx-xss-protectionx-content-type-optionsx-permitted-cross-domain-policiesreferrer-policyserver_timestampuser_expireduser_trialcontent-encodingetagx-cacheviax-amz-cf-popx-amz-cf-id
GET
/api/v1/forum/notifications▶Request Headers
x-user-idx-user-access-token
Query Parameters
| Name | Type |
|---|---|
| page | string |
Responses
200application/json; charset=utf-8
{}Response Headers
content-typex-runtimex-frame-optionsx-xss-protectionx-content-type-optionsx-permitted-cross-domain-policiesreferrer-policytotal_countlast_timestamptotal_pagetotal_unread_countserver_timestampuser_expireduser_trialetagx-request-idx-cacheviax-amz-cf-popx-amz-cf-id
GET
/api/v14/{type}/favourites▶Path Parameters
{type}
Query Parameters
| Name | Type |
|---|---|
| page | string |
Responses
200application/json; charset=utf-8
{
"favourites": [
{
"image": "string",
"title": "string",
"subtitle": "string",
"program_id": "integer",
"workout_id": "integer",
"eyebrow_text": "string",
"favourite_id": "integer",
"target_audience": "null"
}
]
}PUT
/api/{slug}/ab-tests▶Path Parameters
{slug}
Request Headers
content-typex-user-idx-user-access-tokenupload-draft-interop-versioncontent-lengthupload-complete
Request Bodymultipart/form-data; boundary=Boundary+AC803020236C5041
<raw text body>Response Headers
content-typex-runtimex-frame-optionsx-xss-protectionx-content-type-optionsx-permitted-cross-domain-policiesreferrer-policyserver_timestampuser_expireduser_trialx-request-idx-cacheviax-amz-cf-popx-amz-cf-id
PUT
/api/v12/user▶Request Headers
content-typex-user-idx-user-access-tokenupload-draft-interop-versioncontent-lengthupload-complete
Request Bodymultipart/form-data; boundary=Boundary+DDCC1CB8AAE8F6D5
<raw text body>Responses
200application/json; charset=utf-8
{
"id": "integer",
"bio": "null",
"day": "integer",
"dob": "string",
"paid": "boolean",
"tags": ["string"],
"week": "integer",
"email": "string",
"trial": "boolean",
"gender": "null",
"locale": "string",
"sirens": "boolean",
"country": "string",
"goal_kg": "number",
"program": {
"id": "integer",
"name": "string",
"tags": [
{
"id": "integer",
"name": "string",
"type": "string"
}
],
"image": "string",
"is_new": "boolean",
"acronym": "string",
"trainer": {
"id": "integer",
"name": "string",
"code_name": "string",
"image_url": "string",
"hero_image_url": "string",
"profile_image_url": "string"
},
"workouts": [
{
"id": "integer",
"name": "string",
"details": "null",
"position": "integer",
"code_name": "string",
"week_groups": [
{
"id": "integer",
"name": "string",
"is_new": "boolean",
"end_week": "integer",
"start_week": "integer",
"trophy_image": "string",
"difficulty_level": "string"
}
]
}
],
"code_name": "string",
"html_body": "string",
"attributes": [
{
"id": "integer",
"name": "string",
"total": "string",
"value": "string",
"detail": "string",
"code_name": "string"
}
],
"card_image": "string",
"discipline": "string",
"assessments": [],
"html_summary": "string",
"challenges_count": "integer",
"difficulty_level": "string",
"workouts_per_week": "integer",
"avg_workout_duration": "integer",
"terms_and_conditions": "null",
"get_ready_message_body": "null",
"get_ready_message_title": "null"
},
"website": "null",
"ab_tests": [
{
"id": "integer",
"name": "string",
"value": "string",
"code_name": "string"
}
],
"is_guest": "boolean",
"language": "string",
"location": "null",
"progress": [],
"start_kg": "number",
"username": "string",
"water_ml": "integer",
"apple_uid": "null",
"height_cm": "integer",
"id_me_uid": "null",
"image_url": "string",
"instagram": "null",
"last_name": "string",
"time_zone": "string",
"tutorials": "boolean",
"weight_kg": "number",
"first_name": "string",
"google_uid": "null",
"idfa_token": "null",
"assessments": {
"one_rm_assessment": "null"
},
"geo_country": "string",
"is_browsing": "boolean",
"is_pregnant": "boolean",
"repetitions": "boolean",
"unit_system": "string",
"ab_test_type": "string",
"access_token": "string",
"cancelled_at": "integer",
"current_step": "string",
"external_ids": {
"braze": "string",
"universal": "string",
"apps_flyer_ios": "string",
"apps_flyer_android": "null"
},
"facebook_uid": "null",
"payment_type": "string",
"ab_test_types": ["string"],
"trainer_audio": "null",
"is_forum_admin": "boolean",
"technique_tips": "boolean",
"unit_system_id": "integer",
"billing_address": {
"zip": "null",
"city": "null",
"state": "null",
"country": "null",
"street_address": "null"
},
"deferlink_source": "null",
"food_category_id": "integer",
"completed_programs": ["string"],
"follow_after_reply": "boolean",
"food_category_name": "string",
"is_forum_activated": "boolean",
"program_start_date": "integer",
"started_workout_on": "integer",
"receive_newsletters": "boolean",
"display_yoga_as_flow": "null",
"hiit_timer_direction": "string",
"liss_timer_direction": "string",
"disclose_forum_online": "boolean",
"notify_new_post_alert": "boolean",
"notify_new_post_email": "boolean",
"browsing_total_workouts": "integer",
"last_challenge_duration": "null",
"notify_post_liked_alert": "boolean",
"steps_achievement_count": "integer",
"subscription_expires_at": "integer",
"use_suggestion_template": "boolean",
"water_achievement_count": "integer",
"allow_forum_notifications": "boolean",
"auto_exercise_substitutions": "boolean",
"browsing_remaining_workouts": "null",
"notify_post_mentioned_alert": "boolean",
"notify_post_mentioned_email": "boolean",
"notify_user_mentioned_alert": "boolean",
"notify_user_mentioned_email": "boolean",
"requested_health_data_consent": "boolean",
"notify_discussion_locked_alert": "boolean",
"notify_discussion_renamed_alert": "boolean"
}Response Headers
referrer-policycontent-typex-request-idx-runtimex-frame-optionsx-xss-protectionx-content-type-optionsx-permitted-cross-domain-policiesserver_timestampuser_expireduser_trialcontent-encodingetagx-cacheviax-amz-cf-popx-amz-cf-id
POST
/api/v8/step-log▶Request Headers
content-typex-user-idx-user-access-tokencontent-length
Request Bodyapplication/json
{
"steps": "integer",
"log_on": "integer",
"goal_steps": "integer"
}Response Headers
content-typex-runtimex-frame-optionsx-xss-protectionx-content-type-optionsx-permitted-cross-domain-policiesreferrer-policyserver_timestampuser_expireduser_trialx-request-idx-cacheviax-amz-cf-popx-amz-cf-id
PUT
/api/{slug}/trainer-program▶Path Parameters
{slug}
Request Headers
content-typex-user-idx-user-access-tokenupload-draft-interop-versioncontent-lengthupload-complete
Request Bodymultipart/form-data; boundary=Boundary+62D8906B0370DA79
<raw text body>Response Headers
content-typex-frame-optionsx-xss-protectionx-content-type-optionsx-permitted-cross-domain-policiesreferrer-policyserver_timestampuser_expireduser_trialx-request-idx-runtimex-cacheviax-amz-cf-popx-amz-cf-id
GET
/api/v12/user/program▶Request Headers
x-user-idx-user-access-token
Responses
200application/json; charset=utf-8
{
"user": {
"id": "integer",
"bio": "null",
"day": "integer",
"dob": "string",
"paid": "boolean",
"tags": ["string"],
"week": "integer",
"email": "string",
"trial": "boolean",
"gender": "null",
"locale": "string",
"sirens": "boolean",
"country": "string",
"goal_kg": "number",
"program": {
"id": "integer",
"name": "string",
"tags": [
{
"id": "integer",
"name": "string",
"type": "string"
}
],
"image": "string",
"is_new": "boolean",
"acronym": "string",
"trainer": {
"id": "integer",
"name": "string",
"code_name": "string",
"image_url": "string",
"hero_image_url": "string",
"profile_image_url": "string"
},
"workouts": [
{
"id": "integer",
"name": "string",
"details": "null",
"position": "integer",
"code_name": "string",
"week_groups": [
{
"id": "integer",
"name": "string",
"is_new": "boolean",
"end_week": "integer",
"start_week": "integer",
"trophy_image": "string",
"difficulty_level": "string"
}
]
}
],
"code_name": "string",
"html_body": "string",
"attributes": [
{
"id": "integer",
"name": "string",
"total": "string",
"value": "string",
"detail": "string",
"code_name": "string"
}
],
"card_image": "string",
"discipline": "string",
"assessments": [],
"html_summary": "string",
"challenges_count": "integer",
"difficulty_level": "string",
"workouts_per_week": "integer",
"avg_workout_duration": "integer",
"terms_and_conditions": "null",
"get_ready_message_body": "null",
"get_ready_message_title": "null"
},
"website": "null",
"ab_tests": [
{
"id": "integer",
"name": "string",
"value": "string",
"code_name": "string"
}
],
"is_guest": "boolean",
"language": "string",
"location": "null",
"progress": [
{
"id": "integer",
"hitt": "integer",
"liss": "integer",
"name": "string",
"rest": "integer",
"total": "integer",
"code_name": "string",
"completed": "integer",
"rehabilitation": "integer",
"workout_contents": []
}
],
"start_kg": "number",
"username": "string",
"water_ml": "integer",
"apple_uid": "null",
"height_cm": "integer",
"id_me_uid": "null",
"image_url": "string",
"instagram": "null",
"last_name": "string",
"time_zone": "string",
"tutorials": "boolean",
"weight_kg": "number",
"first_name": "string",
"google_uid": "null",
"idfa_token": "null",
"assessments": {
"one_rm_assessment": "null"
},
"geo_country": "string",
"is_browsing": "boolean",
"is_pregnant": "boolean",
"repetitions": "boolean",
"unit_system": "string",
"ab_test_type": "string",
"access_token": "string",
"cancelled_at": "integer",
"current_step": "string",
"external_ids": {
"braze": "string",
"universal": "string",
"apps_flyer_ios": "string",
"apps_flyer_android": "null"
},
"facebook_uid": "null",
"payment_type": "string",
"ab_test_types": ["string"],
"trainer_audio": "null",
"is_forum_admin": "boolean",
"technique_tips": "boolean",
"unit_system_id": "integer",
"billing_address": {
"zip": "null",
"city": "null",
"state": "null",
"country": "null",
"street_address": "null"
},
"deferlink_source": "null",
"food_category_id": "integer",
"completed_programs": ["string"],
"follow_after_reply": "boolean",
"food_category_name": "string",
"is_forum_activated": "boolean",
"program_start_date": "integer",
"started_workout_on": "integer",
"receive_newsletters": "boolean",
"display_yoga_as_flow": "null",
"hiit_timer_direction": "string",
"liss_timer_direction": "string",
"disclose_forum_online": "boolean",
"notify_new_post_alert": "boolean",
"notify_new_post_email": "boolean",
"browsing_total_workouts": "integer",
"last_challenge_duration": "null",
"notify_post_liked_alert": "boolean",
"steps_achievement_count": "integer",
"subscription_expires_at": "integer",
"use_suggestion_template": "boolean",
"water_achievement_count": "integer",
"allow_forum_notifications": "boolean",
"auto_exercise_substitutions": "boolean",
"browsing_remaining_workouts": "null",
"notify_post_mentioned_alert": "boolean",
"notify_post_mentioned_email": "boolean",
"notify_user_mentioned_alert": "boolean",
"notify_user_mentioned_email": "boolean",
"requested_health_data_consent": "boolean",
"notify_discussion_locked_alert": "boolean",
"notify_discussion_renamed_alert": "boolean"
},
"week_welcome": {
"week": "integer",
"image": "string",
"cardio_goals": "integer",
"program_phase": "string",
"recovery_goals": "integer",
"resistance_goals": "integer"
},
"dashboard_items": [
{
"id": "integer",
"name": "string",
"image": "null",
"image_tv": "null",
"code_name": "string",
"full_name": "string",
"html_body": "null",
"card_image": "null",
"categories": [
{
"id": "integer",
"body": "string",
"name": "string",
"goals": "integer",
"image": "string",
"image_tv": "null",
"code_name": "string",
"full_name": "string",
"html_body": "string",
"card_image": "string",
"description": "string",
"image_watch": "null",
"card_image_tv": "null",
"sub_categories": [
{
"id": "integer",
"name": "string",
"max_time": "null",
"min_time": "null",
"code_name": "string",
"description": "string",
"workout_summaries": [
{
"id": "integer",
"name": "string",
"focus": {
"id": "integer",
"body": "string",
"name": "string",
"image": "string",
"image_tv": "null",
"code_name": "null",
"card_image": "string",
"card_image_tv": "null",
"estimated_duration": "string"
},
"is_new": "boolean",
"duration": "null",
"platform": "null",
"image_url": "null",
"program_id": "integer",
"is_optional": "boolean",
"favourite_id": "integer",
"is_completed": "boolean",
"program_name": "string",
"trainer_name": "string",
"workout_tags": [],
"circuit_count": "integer",
"completed_time": "null",
"exercise_count": "integer",
"training_style": "string",
"program_acronym": "string",
"target_audience": "null",
"subcategory_name": "string",
"subcategory_type": "string",
"completed_duration": "null",
"trainer_image_watch": "string",
"community_completed_count": "null",
"community_average_duration": "null",
"scheduled_activity_summaries": []
}
]
}
],
"completed_count": "integer"
}
],
"description": "string",
"image_watch": "null",
"card_image_tv": "null"
}
]
}Response Headers
content-typex-frame-optionsx-xss-protectionx-content-type-optionsx-permitted-cross-domain-policiesreferrer-policyetagserver_timestampuser_expireduser_trialx-request-idx-runtimex-cacheviax-amz-cf-popx-amz-cf-id
GET
/api/v17/{type}▶Path Parameters
{type}
Responses
200application/json; charset=utf-8
{
"0": {
"id": "integer",
"name": "string",
"type": "string",
"image": "null",
"image_tv": "null",
"code_name": "string",
"full_name": "string",
"html_body": "string",
"card_image": "string",
"description": "string",
"image_watch": "null",
"card_image_tv": "null",
"workout_summaries": [
{
"id": "integer",
"name": "string",
"focus": {
"id": "integer",
"body": "string",
"name": "string",
"image": "string",
"image_tv": "null",
"code_name": "null",
"card_image": "string",
"card_image_tv": "null",
"estimated_duration": "string"
},
"is_new": "boolean",
"duration": "null",
"platform": "null",
"image_url": "string",
"program_id": "integer",
"is_optional": "boolean",
"favourite_id": "null",
"is_completed": "boolean",
"program_name": "string",
"trainer_name": "string",
"workout_tags": [
{
"id": "integer",
"name": "string",
"code_name": "string",
"sub_workout_tags": [
{
"id": "integer",
"name": "string",
"code_name": "string"
}
]
}
],
"circuit_count": "integer",
"completed_time": "null",
"exercise_count": "integer",
"training_style": "string",
"program_acronym": "string",
"target_audience": "string",
"subcategory_name": "string",
"subcategory_type": "string",
"completed_duration": "null",
"trainer_image_watch": "string",
"community_completed_count": "null",
"community_average_duration": "null",
"scheduled_activity_summaries": []
}
]
}
}GET
/api/v1/dashboard/week-welcome▶Request Headers
x-user-idx-user-access-token
Query Parameters
| Name | Type |
|---|---|
| week | string |
Responses
200application/json; charset=utf-8
{
"week_welcome": {
"week": "integer",
"goals": [
{
"name": "string",
"volume": "string"
}
],
"title": "string",
"subtitle": "string"
}
}Response Headers
content-typex-runtimex-frame-optionsx-xss-protectionx-content-type-optionsx-permitted-cross-domain-policiesreferrer-policyserver_timestampuser_expireduser_trialetagx-request-idx-cacheviax-amz-cf-popx-amz-cf-id
GET
/api/v8/planner/recommended/{type}▶Path Parameters
{type}
Responses
200application/json; charset=utf-8
{
"0": {
"recommended_workouts": [
{
"name": "string",
"focus": {
"id": "integer",
"body": "string",
"name": "string",
"image": "string",
"image_tv": "null",
"card_image": "string",
"card_image_tv": "null",
"estimated_duration": "string"
},
"weekday": "integer",
"optional": "boolean",
"workout_id": "integer",
"workout_tags": [],
"category_type": "string",
"section_count": "integer",
"exercise_count": "integer",
"subcategory_type": "string"
}
],
"rehabilitation_weekdays": ["integer"],
"rehabilitation_workout_count": "integer"
}
}GET
/api/{slug}/in-app-messaging▶Path Parameters
{slug}
Request Headers
x-user-idx-user-access-token
Responses
200application/json; charset=utf-8
{}Response Headers
content-typex-runtimex-frame-optionsx-xss-protectionx-content-type-optionsx-permitted-cross-domain-policiesreferrer-policyserver_timestampuser_expireduser_trialetagx-request-idx-cacheviax-amz-cf-popx-amz-cf-id
GET
/api/{slug}/activity-insights▶Path Parameters
{slug}
Request Headers
x-user-idx-user-access-token
Responses
200application/json; charset=utf-8
{
"goal": {
"items": [
{
"id": "integer",
"hitt": "integer",
"liss": "integer",
"name": "string",
"rest": "integer",
"type": "string",
"total": "integer",
"code_name": "string",
"completed": "integer",
"rehabilitation": "integer"
}
],
"program_info": "string"
},
"streak": "null",
"latest_achievements": [
{
"id": "integer",
"name": "string",
"badge_url": "string",
"code_name": "string",
"description": "string",
"completion_date": "integer"
}
],
"latest_progress_photos": []
}Response Headers
content-typex-request-idx-runtimex-frame-optionsx-xss-protectionx-content-type-optionsx-permitted-cross-domain-policiesreferrer-policyserver_timestampuser_expireduser_trialcontent-encodingetagx-cacheviax-amz-cf-popx-amz-cf-id
GET
/api/v26/community-events/current▶Request Headers
x-user-idx-user-access-token
Responses
200application/json; charset=utf-8
{
"0": {
"id": "integer",
"logo": "string",
"name": "string",
"image": "string",
"state": "string",
"active": "boolean",
"details": "string",
"message": "string",
"end_date": "integer",
"code_name": "string",
"start_date": "integer",
"member_completed": "boolean",
"member_participating": "boolean",
"participating_members": {
"count": "integer",
"image_urls": ["string"]
},
"participation_open_date": "integer",
"terms_and_conditions_url": "string",
"participation_closed_date": "integer"
}
}Response Headers
content-typex-request-idx-runtimex-frame-optionsx-xss-protectionx-content-type-optionsx-permitted-cross-domain-policiesreferrer-policyserver_timestampuser_expireduser_trialcontent-encodingetagx-cacheviax-amz-cf-popx-amz-cf-id
PUT
/api/v1/dashboard/week-welcome▶Request Headers
content-typex-user-idx-user-access-tokenupload-draft-interop-versioncontent-lengthupload-complete
Request Bodymultipart/form-data; boundary=Boundary+B3BF881925F8585C
<raw text body>Response Headers
content-typex-runtimex-frame-optionsx-xss-protectionx-content-type-optionsx-permitted-cross-domain-policiesreferrer-policyserver_timestampuser_expireduser_trialx-request-idx-cacheviax-amz-cf-popx-amz-cf-id
POST
/api/v7/user-events▶Request Headers
content-typex-user-idx-user-access-tokencontent-length
Request Bodyapplication/json
{
"user_events": [
{
"swk_log_time": "integer",
"swk_event_name": "string",
"swk_custom_field": {
"SWKAppEventParameterFirebaseId": "string"
}
}
]
}Response Headers
content-typex-runtimex-frame-optionsx-xss-protectionx-content-type-optionsx-permitted-cross-domain-policiesreferrer-policyserver_timestampuser_expireduser_trialx-request-idx-cacheviax-amz-cf-popx-amz-cf-id
POST
/api/v5/email/login▶Request Headers
content-typecontent-length
Request Bodyapplication/json
{
"dob": "string",
"email": "string",
"gender": "string",
"locale": "string",
"anon_id": "string",
"country": "string",
"goal_kg": "integer",
"ios_user": "string",
"password": "string",
"start_kg": "integer",
"height_cm": "integer",
"last_name": "string",
"time_zone": "string",
"weight_kg": "integer",
"first_name": "string",
"idfa_token": "string",
"idfv_token": "string",
"unit_system_id": "integer",
"device_timestamp": "string",
"food_category_id": "integer",
"ios_apps_flyer_id": "string",
"hiit_timer_direction": "string",
"liss_timer_direction": "string",
"use_suggestion_template": "integer",
"requested_health_data_consent": "string"
}Responses
422application/json; charset=utf-8
{
"type": "string",
"reason": ["string"]
}Response Headers
content-typex-runtimex-frame-optionsx-xss-protectionx-content-type-optionsx-permitted-cross-domain-policiesreferrer-policyserver_timestampuser_expireduser_trialx-request-idx-cacheviax-amz-cf-popx-amz-cf-id
PATCH
/api/v12/user▶Request Headers
content-typex-user-idx-user-access-tokencontent-length
Request Bodyapplication/json
{
"external_ids": {
"apps_flyer_ios": "string"
}
}Response Headers
content-typex-runtimex-frame-optionsx-xss-protectionx-content-type-optionsx-permitted-cross-domain-policiesreferrer-policyserver_timestampuser_expireduser_trialx-request-idx-cacheviax-amz-cf-popx-amz-cf-id
GET
/api/{slug}/checkout/prices/{id}▶Path Parameters
{slug}{id}
Request Headers
x-user-idx-user-access-token
Query Parameters
| Name | Type |
|---|---|
| appstore_country | string |
Responses
200application/json; charset=utf-8
{
"products": [
{
"sku": "string",
"tag": "string",
"name": "string",
"title": "string",
"currency": "string",
"subtitle": "string",
"highlight": "boolean",
"base_price": "string",
"includes_trial": "boolean"
}
]
}Response Headers
content-typex-runtimex-frame-optionsx-xss-protectionx-content-type-optionsx-permitted-cross-domain-policiesreferrer-policyserver_timestampuser_expireduser_trialetagx-request-idx-cacheviax-amz-cf-popx-amz-cf-id
Data Lineage
Click any field to trace its flow
Select a field, parameter, header, or cookie to see:
- Where the value comes from
- Where the value is used
Data Lineage
Click any field to trace its flow
Select a field, parameter, header, or cookie to see:
- Where the value comes from
- Where the value is used