id
stringlengths
53
86
api_name
stringlengths
2
76
api_description
stringlengths
1
500
api_score
float64
0
10
endpoint_name
stringlengths
1
190
endpoint_description
stringlengths
0
500
response_status_code
int64
100
505
response_summary
stringlengths
1
68
response_json
stringlengths
6
50k
response_json_schema
stringlengths
14
150k
077f2038-276b-4db0-a661-83c9299af959/f5a708c6-b8f9-473e-9b47-0aa0a3d4fa9f/0/0
Creemos
Obtén acceso a los recursos y contenido de creemos para que puedas incluir en tu app o sitio. El API cuenta con Biblia, Evangelio, Cancionero, Santos, Oraciones, Influencers, Podcast, Catecismo, Libros, Artistas y mucho mas!
null
Movimiento o Carisma
Agentes de una nueva Evangelización
200
New Example
{"key1": "value", "key2": "value"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}, "required": ["key1", "key2"]}
077f2038-276b-4db0-a661-83c9299af959/9f3dd530-8b2b-4dd0-b472-1c08f47ac265/0/0
Creemos
Obtén acceso a los recursos y contenido de creemos para que puedas incluir en tu app o sitio. El API cuenta con Biblia, Evangelio, Cancionero, Santos, Oraciones, Influencers, Podcast, Catecismo, Libros, Artistas y mucho mas!
null
Oración
Oración Para pedir, agradecer, adorar y alabar
200
New Example
{"key1": "value", "key2": "value"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}, "required": ["key1", "key2"]}
077f2038-276b-4db0-a661-83c9299af959/3ae43fa4-0dd5-473b-90ff-dfd3fecc7fe6/0/0
Creemos
Obtén acceso a los recursos y contenido de creemos para que puedas incluir en tu app o sitio. El API cuenta con Biblia, Evangelio, Cancionero, Santos, Oraciones, Influencers, Podcast, Catecismo, Libros, Artistas y mucho mas!
null
Influencer
Evangelizando a las nuevas generaciones Influencer Catolicos! Hermanos que con su carisma particular deciden evangelizar en el mundo del Instagram, TikTok, Facebook, Twitter, Youtube y Twitch!
200
New Example
{"key1": "value", "key2": "value"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}, "required": ["key1", "key2"]}
077f2038-276b-4db0-a661-83c9299af959/52396b0e-885f-4c08-8c88-45ec49b0ad42/0/0
Creemos
Obtén acceso a los recursos y contenido de creemos para que puedas incluir en tu app o sitio. El API cuenta con Biblia, Evangelio, Cancionero, Santos, Oraciones, Influencers, Podcast, Catecismo, Libros, Artistas y mucho mas!
null
Artista
¡Conocé a los artistas católicos más populares! Más de 100 Musicos, Dibujantes, Actores, Escritores y compositores Católicos. Athenas Vénica, Cristobal Fones, Eduardo Meana, Pascua Joven, Maxi Larghi, Pablo Martinez y muchos mas hermanos que con su arte nos acercan un poco más a Dios
200
New Example
{"key1": "value", "key2": "value"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}, "required": ["key1", "key2"]}
077f2038-276b-4db0-a661-83c9299af959/63d9d14e-4df5-4a18-a7d2-c13644c64057/0/0
Creemos
Obtén acceso a los recursos y contenido de creemos para que puedas incluir en tu app o sitio. El API cuenta con Biblia, Evangelio, Cancionero, Santos, Oraciones, Influencers, Podcast, Catecismo, Libros, Artistas y mucho mas!
null
Cancion
Obtene los acordes , la letra , categoria, spotify y youtube de la cancion. Pues aquel que canta alabanzas, también alaba con alegría!
200
New Example
{"key1": "value", "key2": "value"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}, "required": ["key1", "key2"]}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/774e8065-42ed-4f35-a1bc-7f3929870113/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
team_members_update
Add members to a team
200
null
{"profiles": [], "is_active": true, "joined": ""}
{"required": ["profiles"], "type": "object", "properties": {"profiles": {"type": "array", "items": {"type": "string", "format": "uuid"}}, "is_active": {"title": "Is active", "description": "Whether profile actively participates in challenge.\n\nWhile inactive, scores/leaderboard will not be updated but still be visible.", "type": "boolean"}, "joined": {"title": "Joined", "description": "The timestamp when the profile/team joined the challenge.", "type": "string", "format": "date-time"}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/63547b52-a0f9-4447-b7e7-b1fba026ae01/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
team_read
Get a single team
200
null
{"name": "", "public_id": "", "url": "", "num_members": "", "members": [{"url": "", "public_id": "", "name": "", "reference": ""}], "avatar": "", "description": ""}
{"required": ["name", "description"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "maxLength": 100, "minLength": 1}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "url": {"title": "Url", "type": "string", "format": "uri"}, "num_members": {"title": "Num members", "type": "string"}, "members": {"description": "List of members in this team", "type": "array", "items": {"description": "List of members in this team", "type": "object", "properties": {"url": {"title": "Url", "type": "string", "format": "uri"}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "name": {"title": "Name", "type": "string", "minLength": 1}, "reference": {"title": "Reference", "type": "string", "maxLength": 255}}}}, "avatar": {"title": "Avatar", "type": ["string", "null"], "format": "uri", "minLength": 1}, "description": {"title": "Description", "type": "string", "minLength": 1}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/3bd8494f-afc1-403f-a6d6-047e6cdad666/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
team_remove_members
Remove members from the team
201
null
{"profiles": [], "is_active": true, "joined": ""}
{"required": ["profiles"], "type": "object", "properties": {"profiles": {"type": "array", "items": {"type": "string", "format": "uuid"}}, "is_active": {"title": "Is active", "description": "Whether profile actively participates in challenge.\n\nWhile inactive, scores/leaderboard will not be updated but still be visible.", "type": "boolean"}, "joined": {"title": "Joined", "description": "The timestamp when the profile/team joined the challenge.", "type": "string", "format": "date-time"}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/672cc7f2-60a3-4069-b8af-41bb52220c3d/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
team_member_create
Add member to a team
201
null
{"profile": "", "joined": ""}
{"required": ["profile"], "type": "object", "properties": {"profile": {"title": "Profile", "description": "A profile public_id is expected", "type": "string", "format": "uuid"}, "joined": {"title": "Joined", "description": "The timestamp when the profile/team joined the challenge.", "type": "string", "format": "date-time"}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/1c896acb-c8f6-42c9-8e41-0a566555a299/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
team_members_create
Add members to a team
201
null
{"profiles": [], "is_active": true, "joined": ""}
{"required": ["profiles"], "type": "object", "properties": {"profiles": {"type": "array", "items": {"type": "string", "format": "uuid"}}, "is_active": {"title": "Is active", "description": "Whether profile actively participates in challenge.\n\nWhile inactive, scores/leaderboard will not be updated but still be visible.", "type": "boolean"}, "joined": {"title": "Joined", "description": "The timestamp when the profile/team joined the challenge.", "type": "string", "format": "date-time"}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/19a2552d-4aba-4bb1-94f8-1d5c5bfb48b5/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
team_create
Creates a new team
201
null
{"name": "", "public_id": "", "url": "", "num_members": "", "members": [{"url": "", "public_id": "", "name": "", "reference": ""}], "avatar": "", "description": ""}
{"required": ["name", "description"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "maxLength": 100, "minLength": 1}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "url": {"title": "Url", "type": "string", "format": "uri"}, "num_members": {"title": "Num members", "type": "string"}, "members": {"description": "List of members in this team", "type": "array", "items": {"description": "List of members in this team", "type": "object", "properties": {"url": {"title": "Url", "type": "string", "format": "uri"}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "name": {"title": "Name", "type": "string", "minLength": 1}, "reference": {"title": "Reference", "type": "string", "maxLength": 255}}}}, "avatar": {"title": "Avatar", "type": ["string", "null"], "format": "uri", "minLength": 1}, "description": {"title": "Description", "type": "string", "minLength": 1}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/17dd2db7-832c-4dbf-81b8-f63b892e3c1e/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
team_update
Creates a new team
200
null
{"name": "", "public_id": "", "url": "", "num_members": "", "members": [{"url": "", "public_id": "", "name": "", "reference": ""}], "avatar": "", "description": ""}
{"required": ["name", "description"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "maxLength": 100, "minLength": 1}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "url": {"title": "Url", "type": "string", "format": "uri"}, "num_members": {"title": "Num members", "type": "string"}, "members": {"description": "List of members in this team", "type": "array", "items": {"description": "List of members in this team", "type": "object", "properties": {"url": {"title": "Url", "type": "string", "format": "uri"}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "name": {"title": "Name", "type": "string", "minLength": 1}, "reference": {"title": "Reference", "type": "string", "maxLength": 255}}}}, "avatar": {"title": "Avatar", "type": ["string", "null"], "format": "uri", "minLength": 1}, "description": {"title": "Description", "type": "string", "minLength": 1}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/35156348-abfd-47fc-8000-91d26ce12761/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
team_member_update
Add member to a team
200
null
{"profile": "", "joined": ""}
{"required": ["profile"], "type": "object", "properties": {"profile": {"title": "Profile", "description": "A profile public_id is expected", "type": "string", "format": "uuid"}, "joined": {"title": "Joined", "description": "The timestamp when the profile/team joined the challenge.", "type": "string", "format": "date-time"}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/afc5392d-ffe7-4d03-abbf-3ac84514e690/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
team_partial_update
Creates a new team
200
null
{"name": "", "public_id": "", "url": "", "num_members": "", "members": [{"url": "", "public_id": "", "name": "", "reference": ""}], "avatar": "", "description": ""}
{"required": ["name", "description"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "maxLength": 100, "minLength": 1}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "url": {"title": "Url", "type": "string", "format": "uri"}, "num_members": {"title": "Num members", "type": "string"}, "members": {"description": "List of members in this team", "type": "array", "items": {"description": "List of members in this team", "type": "object", "properties": {"url": {"title": "Url", "type": "string", "format": "uri"}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "name": {"title": "Name", "type": "string", "minLength": 1}, "reference": {"title": "Reference", "type": "string", "maxLength": 255}}}}, "avatar": {"title": "Avatar", "type": ["string", "null"], "format": "uri", "minLength": 1}, "description": {"title": "Description", "type": "string", "minLength": 1}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/4c9c0a99-1df3-42a0-a5d7-e10df81eef45/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
team_list
List all available teams
200
null
{"count": 0, "next": "", "previous": "", "results": [{"name": "", "public_id": "", "url": "", "num_members": "", "avatar": ""}]}
{"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": ["string", "null"], "format": "uri"}, "previous": {"type": ["string", "null"], "format": "uri"}, "results": {"type": "array", "items": {"required": ["name"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "maxLength": 100, "minLength": 1}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "url": {"title": "Url", "type": "string", "format": "uri"}, "num_members": {"title": "Num members", "type": "string"}, "avatar": {"title": "Avatar", "type": ["string", "null"], "format": "uri", "minLength": 1}}}}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/bb1f501e-c646-4d4d-89bb-f07558e16dc9/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_list
Lists all available profiles
200
null
{"count": 0, "next": "", "previous": "", "results": [{"url": "", "public_id": "", "name": "", "gender": "M", "teams": [{"name": "", "public_id": "", "url": "", "avatar": ""}], "reference": "", "avatar": ""}]}
{"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": ["string", "null"], "format": "uri"}, "previous": {"type": ["string", "null"], "format": "uri"}, "results": {"type": "array", "items": {"type": "object", "properties": {"url": {"title": "Url", "type": "string", "format": "uri"}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "name": {"title": "Name", "type": "string", "minLength": 1}, "gender": {"title": "Gender", "type": "string", "enum": ["M", "F", "X"]}, "teams": {"description": "Team of which this profile is a member of", "type": "array", "items": {"description": "Team of which this profile is a member of", "required": ["name"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "maxLength": 100, "minLength": 1}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "url": {"title": "Url", "type": "string", "format": "uri"}, "avatar": {"title": "Avatar", "type": ["string", "null"], "format": "uri", "minLength": 1}}}}, "reference": {"title": "Reference", "type": "string", "maxLength": 255}, "avatar": {"title": "Avatar", "type": ["string", "null"], "format": "uri", "minLength": 1}}}}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/fa2dd490-9634-4e9a-818d-6b987a7e7f52/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_create
Creates a new profile. The bearer field contains a profile bearer token. When this is used in the Authorization header actions are performed as that profile, which will also enable access to private data. Using a profile bearer token disables administrative features such as creating profiles, making this token safe for 'public' use. A profile bearer token has no expiration, so it remains valid as long as the profile is active.
201
null
{"url": "", "public_id": "", "given_name": "", "family_name": "", "nickname": "", "gender": "M", "birthdate": "", "zoneinfo": "", "locale": "", "reference": "", "avatar": "", "bearer": ""}
{"required": ["reference"], "type": "object", "properties": {"url": {"title": "Url", "type": "string", "format": "uri"}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "given_name": {"title": "Given name", "type": "string", "maxLength": 100}, "family_name": {"title": "Family name", "type": "string", "maxLength": 100}, "nickname": {"title": "Nickname", "type": "string", "maxLength": 100}, "gender": {"title": "Gender", "type": "string", "enum": ["M", "F", "X"]}, "birthdate": {"title": "Birthdate", "type": ["string", "null"], "format": "date"}, "zoneinfo": {"title": "Zoneinfo", "type": "string"}, "locale": {"title": "Locale", "type": "string", "maxLength": 5}, "reference": {"title": "Reference", "type": "string", "maxLength": 256, "minLength": 1}, "avatar": {"title": "Avatar", "type": ["string", "null"], "format": "uri", "minLength": 1}, "bearer": {"title": "Bearer", "description": "Used for authenticating as a profile. Make this the active Authorization bearer to perform actions using this profile.", "type": "string", "minLength": 1}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/e122ada2-3254-441a-823a-58d53a7e9a60/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_daily_summary_list
Provides summarized data per day.
200
null
[{"date": "", "distance": 0, "steps": 0, "calories": 0, "points": 0, "source": "AGGREGATED", "heart_rate_summary": {"min": 0, "max": 0, "average": 0, "resting": 0}, "stress_summary": {"stress_qualifier": "UNKNOWN", "average_stress_level": 0, "max_stress_level": 0}}]
{"type": "array", "items": {"required": ["date", "source"], "type": "object", "properties": {"date": {"title": "Date", "description": "Date of the summary.", "type": "string", "format": "date"}, "distance": {"title": "Distance", "description": "Distance in meters.", "type": ["number", "null"]}, "steps": {"title": "Steps", "description": "Steps taken.", "type": ["number", "null"]}, "calories": {"title": "Calories", "description": "Calories burned.", "type": ["number", "null"]}, "points": {"title": "Points", "description": "Points earned.", "type": ["number", "null"]}, "source": {"title": "Source", "description": "Origin of the data.", "type": "string", "enum": ["AGGREGATED", "ANDROID", "APPLE", "FITBIT", "GARMIN", "GOOGLEFIT", "HUAWEI", "MYZONE", "OMH", "OURA", "POLAR", "SAMSUNG", "STRAVA", "WF", "WITHINGS"]}, "heart_rate_summary": {"type": "object", "properties": {"min": {"title": "Min", "description": "Minimum heart rate.", "type": ["integer", "null"]}, "max": {"title": "Max", "description": "Maximum heart rate.", "type": ["integer", "null"]}, "average": {"title": "Average", "description": "Average heart rate.", "type": ["integer", "null"]}, "resting": {"title": "Resting", "description": "Resting heart rate.", "type": ["integer", "null"]}}}, "stress_summary": {"required": ["stress_qualifier"], "type": "object", "properties": {"stress_qualifier": {"title": "Stress qualifier", "description": "Qualifier describing stress level.", "type": "string", "enum": ["UNKNOWN", "CALM", "BALANCED", "STRESSFUL", "VERY_STRESSFUL"]}, "average_stress_level": {"title": "Average_stress_level", "description": "Average stress level.", "type": ["integer", "null"]}, "max_stress_level": {"title": "Max_stress_level", "description": "Maximum stress level.", "type": ["integer", "null"]}, "rest_stress_duration": {"title": "Rest stress duration", "description": "Time at restful stress level.", "minLength": 1}, "low_stress_duration": {"title": "Low stress duration", "description": "Time at low stress level.", "minLength": 1}, "medium_stress_duration": {"title": "Medium stress duration", "description": "Time at medium stress level.", "minLength": 1}, "high_stress_duration": {"title": "High stress duration", "description": "Time at high stress level.", "minLength": 1}, "stress_duration": {"title": "Stress duration", "description": "Total time in stress.", "minLength": 1}}}}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/b8e6f39d-4c4a-4600-becc-364434b50288/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_bmi_list
Presents the Body-Mass-Index over time.
200
null
[{"timestamp": "", "source": "AGGREGATED", "is_manual": true, "bmi": 0}]
{"type": "array", "items": {"required": ["timestamp", "source"], "type": "object", "properties": {"timestamp": {"title": "Timestamp", "description": "Starting time of the measurement.", "type": "string", "format": "date-time"}, "source": {"title": "Source", "description": "Origin of the data.", "type": "string", "enum": ["AGGREGATED", "ANDROID", "APPLE", "FITBIT", "GARMIN", "GOOGLEFIT", "HUAWEI", "MYZONE", "OMH", "OURA", "POLAR", "SAMSUNG", "STRAVA", "WF", "WITHINGS"]}, "is_manual": {"title": "Is_manual", "description": "Whether the data was entered manually.", "type": ["boolean", "null"]}, "bmi": {"title": "Bmi", "description": "Body Mass Index, automatically calculated if not entered and both weight and height are available.", "type": ["number", "null"]}}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/f9aa2689-7710-46dd-afaa-c9218a682add/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
challenge_periods
Get all periods for the challenge. This endpoint returns a list of objects.
200
null
{"start": "", "end": ""}
{"type": "object", "properties": {"start": {"title": "Start", "type": "string", "format": "date-time"}, "end": {"title": "End", "type": "string", "format": "date-time"}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/e23403aa-b618-4824-bd76-c81bb2853ce7/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
challenge_members_create
Add members to a team. Note: for now if the challenge is a team challenge and no team is specified, the first team for the specified profile is used. Do note that this is a temporary fix and may be removed at any time. Note: for the GET/POST endpoint an admin bearer token is required, while the GET also accepts profile bearer tokens
201
null
{"profiles": [], "is_active": true, "team": "", "joined": ""}
{"required": ["profiles"], "type": "object", "properties": {"profiles": {"type": "array", "items": {"type": "string", "format": "uuid"}}, "is_active": {"title": "Is active", "description": "Whether profile actively participates in challenge.\n\nWhile inactive, scores/leaderboard will not be updated but still be visible.", "type": "boolean"}, "team": {"title": "Team", "description": "A team public_id is expected", "type": "string", "format": "uuid"}, "joined": {"title": "Joined", "description": "The timestamp when the profile/team joined the challenge.", "type": "string", "format": "date-time"}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/c7e32516-f45e-4f4a-b7f1-ffe05a95c30d/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_stress_summary_list
Presents stress summaries.
200
null
[{"timestamp": "", "source": "AGGREGATED", "stress_qualifier": "UNKNOWN", "average_stress_level": 0, "max_stress_level": 0}]
{"type": "array", "items": {"required": ["timestamp", "source", "stress_qualifier"], "type": "object", "properties": {"timestamp": {"title": "Timestamp", "description": "Starting time of the measurement.", "type": "string", "format": "date-time"}, "duration": {"title": "Duration", "minLength": 1}, "source": {"title": "Source", "description": "Origin of the data.", "type": "string", "enum": ["AGGREGATED", "ANDROID", "APPLE", "FITBIT", "GARMIN", "GOOGLEFIT", "HUAWEI", "MYZONE", "OMH", "OURA", "POLAR", "SAMSUNG", "STRAVA", "WF", "WITHINGS"]}, "stress_qualifier": {"title": "Stress qualifier", "description": "Qualifier describing stress level.", "type": "string", "enum": ["UNKNOWN", "CALM", "BALANCED", "STRESSFUL", "VERY_STRESSFUL"]}, "average_stress_level": {"title": "Average_stress_level", "description": "Average stress level.", "type": ["integer", "null"]}, "max_stress_level": {"title": "Max_stress_level", "description": "Maximum stress level.", "type": ["integer", "null"]}, "rest_stress_duration": {"title": "Rest stress duration", "description": "Time at restful stress level.", "minLength": 1}, "low_stress_duration": {"title": "Low stress duration", "description": "Time at low stress level.", "minLength": 1}, "medium_stress_duration": {"title": "Medium stress duration", "description": "Time at medium stress level.", "minLength": 1}, "high_stress_duration": {"title": "High stress duration", "description": "Time at high stress level.", "minLength": 1}, "stress_duration": {"title": "Stress duration", "description": "Total time in stress.", "minLength": 1}}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/5fb4e4d0-2597-4636-ac6e-363523c0559c/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_connections_read
Lists the connections available for a profile and their "state". This endpoint returns a list of objects.
200
null
{"display_name": "", "url": "", "connected": "CONNECTED", "connection_slug": "", "img_url": ""}
{"type": "object", "properties": {"display_name": {"title": "Display name", "type": "string"}, "url": {"title": "Url", "type": "string", "minLength": 1}, "connected": {"title": "Connected", "type": "string", "enum": ["CONNECTED", "ERROR", "NOT_CONNECTED"]}, "connection_slug": {"title": "Connection slug", "type": "string", "minLength": 1}, "img_url": {"title": "Img url", "type": "string", "minLength": 1}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/fcb4fc1d-7489-47cc-b38a-c1e34ce92981/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_challenges
This docstring is used by Django Rest Framework
200
null
{"url": "", "public_id": "", "title": "", "slogan": "", "description": "", "start": "", "end": "", "type": "INDIVIDUAL", "goal": "DAILY", "goal_value": 0, "goal_type": "POINTS", "visibility": "PUBLIC", "num_members": "", "leaderboard_rank": 0, "leaderboard_score": 0, "is_participating": true, "enrollment": {"team": "", "team_public_id": "", "team_size": 0, "leaderboard_rank": 0, "leaderboard_score": 0}, "repetition": "NONE", "avatar": "", "data_source": "", "activity_types": [{"activity_type": "RUNNING"}], "current_period_start": "", "current_period_end": "", "goal_cap": true, "joined": ""}
{"required": ["title", "start", "type", "goal", "goal_type", "visibility", "repetition"], "type": "object", "properties": {"url": {"title": "Url", "type": "string", "format": "uri"}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "title": {"title": "Title", "type": "string", "minLength": 1}, "slogan": {"title": "Slogan", "type": "string"}, "description": {"title": "Description", "type": "string"}, "start": {"title": "Start", "type": "string", "format": "date-time"}, "end": {"title": "End", "type": ["string", "null"], "format": "date-time"}, "type": {"title": "Type", "type": "string", "enum": ["INDIVIDUAL", "GROUP", "TEAM"]}, "goal": {"title": "Goal", "type": "string", "enum": ["DAILY", "TOTAL", "WEEKLY", "MONTHLY"]}, "goal_value": {"title": "Goal value", "type": ["integer", "null"], "maximum": 2147483647, "minimum": -2147483648}, "goal_type": {"title": "Goal type", "type": "string", "enum": ["POINTS", "DISTANCE", "CALORIES", "DURATION", "STEPS"]}, "visibility": {"title": "Visibility", "type": "string", "enum": ["PUBLIC", "PRIVATE"]}, "num_members": {"title": "Num members", "type": "string"}, "leaderboard_rank": {"title": "Leaderboard rank", "description": "Current or final rank among the participants of the challenge as determined by the relevant score.", "type": "integer"}, "leaderboard_score": {"title": "Leaderboard score", "description": "The profile's current or final score.", "type": "number"}, "is_participating": {"title": "Is participating", "description": "Does the current profile participate in this challenge?", "type": "boolean"}, "enrollment": {"type": "object", "properties": {"team": {"title": "Team", "type": "string", "minLength": 1}, "team_public_id": {"title": "Team public id", "type": "string", "minLength": 1}, "team_size": {"title": "Team size", "type": "integer"}, "leaderboard_rank": {"title": "Leaderboard rank", "description": "Current or final rank among the participants of the challenge as determined by the relevant score.", "type": "integer"}, "leaderboard_score": {"title": "Leaderboard score", "description": "The profile's current or final score.", "type": "number"}}}, "repetition": {"title": "Repetition", "type": "string", "enum": ["NONE", "STREAK", "STICKTOIT", "GOALBREAKER"]}, "avatar": {"title": "Avatar", "type": ["string", "null"], "format": "uri", "minLength": 1}, "data_source": {"title": "Data source", "type": "string", "minLength": 1}, "activity_types": {"type": "array", "items": {"required": ["activity_type"], "type": "object", "properties": {"activity_type": {"title": "Activity type", "type": "string", "enum": ["RUNNING", "CROSSFIT", "CYCLING", "SWIMMING", "OTHER", "ROWING", "WALKING", "MINDFULNESS", "YOGA", "STRENGTH_TRAINING"]}}}}, "current_period_start": {"title": "Current period start", "description": "The start (exclusive) of the current period. Null if the challenge has not started yet.", "type": "string", "format": "date-time"}, "current_period_end": {"title": "Current period end", "description": "The end (exclusive) of the current period. Null if the challenge end has passed.", "type": "string", "format": "date-time"}, "goal_cap": {"title": "Goal cap", "description": "Whether scores should be unable to surpass the goal value.", "type": "boolean"}, "joined": {"title": "Joined", "description": "The timestamp when the profile joined the challenge.", "type": "string", "format": "date-time"}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/71d29d36-4b04-4c1e-8dbb-b19dcbccd069/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_height_list
Lists changes in height for the profile.
200
null
[{"timestamp": "", "source": "AGGREGATED", "is_manual": true, "height": 0}]
{"type": "array", "items": {"required": ["timestamp", "source"], "type": "object", "properties": {"timestamp": {"title": "Timestamp", "description": "Starting time of the measurement.", "type": "string", "format": "date-time"}, "source": {"title": "Source", "description": "Origin of the data.", "type": "string", "enum": ["AGGREGATED", "ANDROID", "APPLE", "FITBIT", "GARMIN", "GOOGLEFIT", "HUAWEI", "MYZONE", "OMH", "OURA", "POLAR", "SAMSUNG", "STRAVA", "WF", "WITHINGS"]}, "is_manual": {"title": "Is_manual", "description": "Whether the data was entered manually.", "type": ["boolean", "null"]}, "height": {"title": "Height", "description": "Height in cm.", "type": ["number", "null"]}}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/65a0b6f1-04a9-4d7a-96a4-2f35adb73fec/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_heartrate_sample_list
Heart Rate measured at a single point in time.
200
null
[{"timestamp": "", "source": "AGGREGATED", "is_manual": true, "value": 0, "min": 0, "max": 0}]
{"type": "array", "items": {"required": ["timestamp", "source"], "type": "object", "properties": {"timestamp": {"title": "Timestamp", "description": "Starting time of the measurement.", "type": "string", "format": "date-time"}, "duration": {"title": "Duration", "minLength": 1}, "source": {"title": "Source", "description": "Origin of the data.", "type": "string", "enum": ["AGGREGATED", "ANDROID", "APPLE", "FITBIT", "GARMIN", "GOOGLEFIT", "HUAWEI", "MYZONE", "OMH", "OURA", "POLAR", "SAMSUNG", "STRAVA", "WF", "WITHINGS"]}, "is_manual": {"title": "Is_manual", "description": "Whether the data was entered manually.", "type": ["boolean", "null"]}, "value": {"title": "Value", "description": "Measured heart rate in beats/min.", "type": ["integer", "null"]}, "min": {"title": "Min", "description": "Minimum value measured in the time window.", "type": ["integer", "null"]}, "max": {"title": "Max", "description": "Maximum value measured in the time window.", "type": ["integer", "null"]}}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/73a0099a-6cb0-4fec-8d6e-616f1184146c/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_event_list
Lists events, generic actions for which points have been awarded.
200
null
[{"timestamp": "", "points": 0, "description": ""}]
{"type": "array", "items": {"type": "object", "properties": {"timestamp": {"title": "Timestamp", "description": "Time at which the action was performed.", "type": "string", "format": "date-time"}, "points": {"title": "Points", "description": "Amount of points awarded for the action.", "type": ["number", "null"]}, "description": {"title": "Description", "description": "Title / description of the action.", "type": ["string", "null"]}}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/0c93ecdd-f591-4f16-8f42-01fc61a3d32d/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_event_create
Create a new event for the profile.
201
null
{"timestamp": "", "points": 0, "description": ""}
{"type": "object", "properties": {"timestamp": {"title": "Timestamp", "description": "Time at which the action was performed.", "type": "string", "format": "date-time"}, "points": {"title": "Points", "description": "Amount of points awarded for the action.", "type": ["number", "null"]}, "description": {"title": "Description", "description": "Title / description of the action.", "type": ["string", "null"]}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/6a983e1a-5f41-4399-b101-4520fe0b779f/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_biometric_measurement_list
List changes in biometric measurements for the profile.
200
null
[{"timestamp": "", "end": "", "source": "AGGREGATED", "measurement_type": "", "is_manual": true, "value": 0, "unit": ""}]
{"type": "array", "items": {"required": ["timestamp", "source", "measurement_type"], "type": "object", "properties": {"timestamp": {"title": "Timestamp", "description": "Starting time of the measurement.", "type": "string", "format": "date-time"}, "end": {"title": "End", "description": "End time of the measurement.", "type": ["string", "null"], "format": "date-time"}, "source": {"title": "Source", "description": "Origin of the data.", "type": "string", "enum": ["AGGREGATED", "ANDROID", "APPLE", "FITBIT", "GARMIN", "GOOGLEFIT", "HUAWEI", "MYZONE", "OMH", "OURA", "POLAR", "SAMSUNG", "STRAVA", "WF", "WITHINGS"]}, "measurement_type": {"title": "Measurement_type", "description": "Type of biometric measurement.", "type": "string", "minLength": 1}, "is_manual": {"title": "Is_manual", "description": "Whether the data was entered manually.", "type": ["boolean", "null"]}, "value": {"title": "Value", "description": "Value of this measurement.", "type": ["number", "null"]}, "unit": {"title": "Unit", "description": "Unit of this measurement", "type": ["string", "null"]}}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/fbeb2c2a-dff3-4375-b773-6797367ab1a4/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_read
Gets a single profile
200
null
{"url": "", "public_id": "", "given_name": "", "family_name": "", "nickname": "", "gender": "M", "birthdate": "", "zoneinfo": "", "locale": "", "total_calories": 0, "total_distance": 0, "total_steps": 0, "total_points": 0, "reference": "", "teams": [{"name": "", "public_id": "", "url": "", "avatar": ""}], "avatar": "", "num_active_challenges": "", "num_done_challenges": "", "num_future_challenges": ""}
{"type": "object", "properties": {"url": {"title": "Url", "type": "string", "format": "uri"}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "given_name": {"title": "Given name", "type": "string", "maxLength": 100}, "family_name": {"title": "Family name", "type": "string", "maxLength": 100}, "nickname": {"title": "Nickname", "type": "string", "maxLength": 100}, "gender": {"title": "Gender", "type": "string", "enum": ["M", "F", "X"]}, "birthdate": {"title": "Birthdate", "type": ["string", "null"], "format": "date"}, "zoneinfo": {"title": "Zoneinfo", "type": "string"}, "locale": {"title": "Locale", "type": "string", "maxLength": 5}, "total_calories": {"title": "Total calories", "type": "number"}, "total_distance": {"title": "Total distance", "type": "number"}, "total_steps": {"title": "Total steps", "type": "number"}, "total_points": {"title": "Total points", "type": "number"}, "total_activity_duration": {"title": "Total activity duration", "minLength": 1}, "reference": {"title": "Reference", "type": "string", "maxLength": 255}, "teams": {"description": "Team of which this profile is a member of", "type": "array", "items": {"description": "Team of which this profile is a member of", "required": ["name"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "maxLength": 100, "minLength": 1}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "url": {"title": "Url", "type": "string", "format": "uri"}, "avatar": {"title": "Avatar", "type": ["string", "null"], "format": "uri", "minLength": 1}}}}, "avatar": {"title": "Avatar", "type": ["string", "null"], "format": "uri", "minLength": 1}, "num_active_challenges": {"title": "Num active challenges", "type": "string"}, "num_done_challenges": {"title": "Num done challenges", "type": "string"}, "num_future_challenges": {"title": "Num future challenges", "type": "string"}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/287950c8-2750-48b1-beb4-162fe6ce6f74/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_update
Updates the specified profile, excluding ID, team and public id.
200
null
{"url": "", "public_id": "", "given_name": "", "family_name": "", "nickname": "", "gender": "M", "birthdate": "", "zoneinfo": "", "locale": "", "total_calories": 0, "total_distance": 0, "total_steps": 0, "total_points": 0, "reference": "", "teams": [{"name": "", "public_id": "", "url": "", "avatar": ""}], "avatar": "", "num_active_challenges": "", "num_done_challenges": "", "num_future_challenges": ""}
{"type": "object", "properties": {"url": {"title": "Url", "type": "string", "format": "uri"}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "given_name": {"title": "Given name", "type": "string", "maxLength": 100}, "family_name": {"title": "Family name", "type": "string", "maxLength": 100}, "nickname": {"title": "Nickname", "type": "string", "maxLength": 100}, "gender": {"title": "Gender", "type": "string", "enum": ["M", "F", "X"]}, "birthdate": {"title": "Birthdate", "type": ["string", "null"], "format": "date"}, "zoneinfo": {"title": "Zoneinfo", "type": "string"}, "locale": {"title": "Locale", "type": "string", "maxLength": 5}, "total_calories": {"title": "Total calories", "type": "number"}, "total_distance": {"title": "Total distance", "type": "number"}, "total_steps": {"title": "Total steps", "type": "number"}, "total_points": {"title": "Total points", "type": "number"}, "total_activity_duration": {"title": "Total activity duration", "minLength": 1}, "reference": {"title": "Reference", "type": "string", "maxLength": 255}, "teams": {"description": "Team of which this profile is a member of", "type": "array", "items": {"description": "Team of which this profile is a member of", "required": ["name"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "maxLength": 100, "minLength": 1}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "url": {"title": "Url", "type": "string", "format": "uri"}, "avatar": {"title": "Avatar", "type": ["string", "null"], "format": "uri", "minLength": 1}}}}, "avatar": {"title": "Avatar", "type": ["string", "null"], "format": "uri", "minLength": 1}, "num_active_challenges": {"title": "Num active challenges", "type": "string"}, "num_done_challenges": {"title": "Num done challenges", "type": "string"}, "num_future_challenges": {"title": "Num future challenges", "type": "string"}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/1a3ea0e7-c796-43a4-8cbe-c264625ad890/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_ecg_samples_list
To get electrocardiogram (ECG) recordings, the endpoint /ecg_samples/ can be used. \ This endpoint return an ECG recording as an array of tuples [(time, value)]. Other information that is returned is the duration of the recording, sample frequency and sample count.
200
null
[{"timestamp": "", "duration": 0, "source": "AGGREGATED", "sample_frequency": 0, "sample_count": 0, "data": []}]
{"type": "array", "items": {"required": ["timestamp", "source"], "type": "object", "properties": {"timestamp": {"title": "Timestamp", "description": "Starting time of the measurement.", "type": "string", "format": "date-time"}, "duration": {"title": "Duration", "description": "Duration of the measurement.", "type": ["number", "null"]}, "source": {"title": "Source", "description": "Origin of the data.", "type": "string", "enum": ["AGGREGATED", "ANDROID", "APPLE", "FITBIT", "GARMIN", "GOOGLEFIT", "HUAWEI", "MYZONE", "OMH", "OURA", "POLAR", "SAMSUNG", "STRAVA", "WF", "WITHINGS"]}, "sample_frequency": {"title": "Sample_frequency", "description": "Sampling frequency of heart beats as integer in Hz.", "type": ["integer", "null"]}, "sample_count": {"title": "Sample_count", "description": "Sample count of heart beats as integer.", "type": ["integer", "null"]}, "data": {"description": "ECG data, represented as [[time (s), value (mcV)], [time2 (s), value2 (mcV)]), ..", "type": ["array", "null"], "items": {"type": ["string", "null"]}}}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/a47eb264-5ad1-4618-9c7d-5592488062e8/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_challenge_read
Provides a list of challenges where the profile can participate and is already participating in. This endpoint returns a list of objects.
200
null
{"url": "", "public_id": "", "title": "", "slogan": "", "description": "", "start": "", "end": "", "type": "INDIVIDUAL", "goal": "DAILY", "goal_value": 0, "goal_type": "POINTS", "visibility": "PUBLIC", "num_members": "", "leaderboard_rank": 0, "leaderboard_score": 0, "is_participating": true, "enrollment": {"team": "", "team_public_id": "", "team_size": 0, "leaderboard_rank": 0, "leaderboard_score": 0}, "repetition": "NONE", "avatar": "", "data_source": "", "activity_types": [{"activity_type": "RUNNING"}], "current_period_start": "", "current_period_end": "", "goal_cap": true, "joined": ""}
{"required": ["title", "start", "type", "goal", "goal_type", "visibility", "repetition"], "type": "object", "properties": {"url": {"title": "Url", "type": "string", "format": "uri"}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "title": {"title": "Title", "type": "string", "minLength": 1}, "slogan": {"title": "Slogan", "type": "string"}, "description": {"title": "Description", "type": "string"}, "start": {"title": "Start", "type": "string", "format": "date-time"}, "end": {"title": "End", "type": ["string", "null"], "format": "date-time"}, "type": {"title": "Type", "type": "string", "enum": ["INDIVIDUAL", "GROUP", "TEAM"]}, "goal": {"title": "Goal", "type": "string", "enum": ["DAILY", "TOTAL", "WEEKLY", "MONTHLY"]}, "goal_value": {"title": "Goal value", "type": ["integer", "null"], "maximum": 2147483647, "minimum": -2147483648}, "goal_type": {"title": "Goal type", "type": "string", "enum": ["POINTS", "DISTANCE", "CALORIES", "DURATION", "STEPS"]}, "visibility": {"title": "Visibility", "type": "string", "enum": ["PUBLIC", "PRIVATE"]}, "num_members": {"title": "Num members", "type": "string"}, "leaderboard_rank": {"title": "Leaderboard rank", "description": "Current or final rank among the participants of the challenge as determined by the relevant score.", "type": "integer"}, "leaderboard_score": {"title": "Leaderboard score", "description": "The profile's current or final score.", "type": "number"}, "is_participating": {"title": "Is participating", "description": "Does the current profile participate in this challenge?", "type": "boolean"}, "enrollment": {"type": "object", "properties": {"team": {"title": "Team", "type": "string", "minLength": 1}, "team_public_id": {"title": "Team public id", "type": "string", "minLength": 1}, "team_size": {"title": "Team size", "type": "integer"}, "leaderboard_rank": {"title": "Leaderboard rank", "description": "Current or final rank among the participants of the challenge as determined by the relevant score.", "type": "integer"}, "leaderboard_score": {"title": "Leaderboard score", "description": "The profile's current or final score.", "type": "number"}}}, "repetition": {"title": "Repetition", "type": "string", "enum": ["NONE", "STREAK", "STICKTOIT", "GOALBREAKER"]}, "avatar": {"title": "Avatar", "type": ["string", "null"], "format": "uri", "minLength": 1}, "data_source": {"title": "Data source", "type": "string", "minLength": 1}, "activity_types": {"type": "array", "items": {"required": ["activity_type"], "type": "object", "properties": {"activity_type": {"title": "Activity type", "type": "string", "enum": ["RUNNING", "CROSSFIT", "CYCLING", "SWIMMING", "OTHER", "ROWING", "WALKING", "MINDFULNESS", "YOGA", "STRENGTH_TRAINING"]}}}}, "current_period_start": {"title": "Current period start", "description": "The start (exclusive) of the current period. Null if the challenge has not started yet.", "type": "string", "format": "date-time"}, "current_period_end": {"title": "Current period end", "description": "The end (exclusive) of the current period. Null if the challenge end has passed.", "type": "string", "format": "date-time"}, "goal_cap": {"title": "Goal cap", "description": "Whether scores should be unable to surpass the goal value.", "type": "boolean"}, "joined": {"title": "Joined", "description": "The timestamp when the profile joined the challenge.", "type": "string", "format": "date-time"}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/ae1526db-2843-4128-9b1d-d89eb1312c8f/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_heartrate_summary_list
Presents heart rate information.
200
null
[{"timestamp": "", "source": "AGGREGATED", "is_manual": true, "min": 0, "max": 0, "average": 0, "resting": 0}]
{"type": "array", "items": {"required": ["timestamp", "source"], "type": "object", "properties": {"timestamp": {"title": "Timestamp", "description": "Starting time of the measurement.", "type": "string", "format": "date-time"}, "duration": {"title": "Duration", "minLength": 1}, "source": {"title": "Source", "description": "Origin of the data.", "type": "string", "enum": ["AGGREGATED", "ANDROID", "APPLE", "FITBIT", "GARMIN", "GOOGLEFIT", "HUAWEI", "MYZONE", "OMH", "OURA", "POLAR", "SAMSUNG", "STRAVA", "WF", "WITHINGS"]}, "is_manual": {"title": "Is_manual", "description": "Whether the data was entered manually.", "type": ["boolean", "null"]}, "min": {"title": "Min", "description": "Minimum heart rate.", "type": ["integer", "null"]}, "max": {"title": "Max", "description": "Maximum heart rate.", "type": ["integer", "null"]}, "average": {"title": "Average", "description": "Average heart rate.", "type": ["integer", "null"]}, "resting": {"title": "Resting", "description": "Resting heart rate.", "type": ["integer", "null"]}}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/69aad4f6-9127-4c09-80f6-67ece1cfdf4e/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_stress_samples_list
Presents stress samples.
200
null
[{"timestamp": "", "source": "AGGREGATED", "stress_value": 0}]
{"type": "array", "items": {"required": ["timestamp", "source", "stress_value"], "type": "object", "properties": {"timestamp": {"title": "Timestamp", "description": "Starting time of the measurement.", "type": "string", "format": "date-time"}, "source": {"title": "Source", "description": "Origin of the data.", "type": "string", "enum": ["AGGREGATED", "ANDROID", "APPLE", "FITBIT", "GARMIN", "GOOGLEFIT", "HUAWEI", "MYZONE", "OMH", "OURA", "POLAR", "SAMSUNG", "STRAVA", "WF", "WITHINGS"]}, "stress_value": {"title": "Stress_value", "description": "Stress value.", "type": "integer"}}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/44bf282b-2eef-49c9-b1bc-202e9717b736/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_daily_detail_list
Intraday data measured at a single point in time.
200
null
[{"timestamp": "", "duration": 0, "source": "AGGREGATED", "steps": 0, "calories": 0, "distance": 0}]
{"type": "array", "items": {"required": ["timestamp", "source"], "type": "object", "properties": {"timestamp": {"title": "Timestamp", "description": "Starting time of the measurement.", "type": "string", "format": "date-time"}, "duration": {"title": "Duration", "description": "Duration of the measurement.", "type": ["number", "null"]}, "source": {"title": "Source", "description": "Origin of the data.", "type": "string", "enum": ["AGGREGATED", "ANDROID", "APPLE", "FITBIT", "GARMIN", "GOOGLEFIT", "HUAWEI", "MYZONE", "OMH", "OURA", "POLAR", "SAMSUNG", "STRAVA", "WF", "WITHINGS"]}, "steps": {"title": "Steps", "description": "Steps taken.", "type": ["integer", "null"]}, "calories": {"title": "Calories", "description": "Calories burned.", "type": ["number", "null"]}, "distance": {"title": "Distance", "description": "Distance in meters.", "type": ["number", "null"]}}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/6da5779e-3018-4b53-8560-33cd8cca72ed/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_workout_list
Lists workouts associated with the profile. Used to be known as Activity.
200
null
[{"timestamp": "", "source": "AGGREGATED", "is_manual": true, "type": "RUNNING", "distance": 0, "steps": 0, "elevation": 0, "speed": 0, "calories": 0, "points": 0, "heart_rate_summary": {"min": 0, "max": 0, "average": 0, "resting": 0}}]
{"type": "array", "items": {"required": ["timestamp", "source", "type"], "type": "object", "properties": {"timestamp": {"title": "Timestamp", "description": "Starting time of the measurement.", "type": "string", "format": "date-time"}, "duration": {"title": "Duration", "minLength": 1}, "source": {"title": "Source", "description": "Origin of the data.", "type": "string", "enum": ["AGGREGATED", "ANDROID", "APPLE", "FITBIT", "GARMIN", "GOOGLEFIT", "HUAWEI", "MYZONE", "OMH", "OURA", "POLAR", "SAMSUNG", "STRAVA", "WF", "WITHINGS"]}, "is_manual": {"title": "Is_manual", "description": "Whether the data was entered manually.", "type": ["boolean", "null"]}, "type": {"title": "Type", "description": "Type of the activity.", "type": "string", "enum": ["RUNNING", "CROSSFIT", "CYCLING", "SWIMMING", "OTHER", "ROWING", "WALKING", "MINDFULNESS", "YOGA", "STRENGTH_TRAINING"]}, "distance": {"title": "Distance", "description": "Distance in meters.", "type": ["number", "null"]}, "steps": {"title": "Steps", "description": "Steps taken.", "type": ["number", "null"]}, "elevation": {"title": "Elevation", "description": "Elevation gained during the workout.", "type": ["number", "null"]}, "speed": {"title": "Speed", "description": "Average speed during the workout", "type": ["number", "null"]}, "calories": {"title": "Calories", "description": "Calories burned.", "type": ["number", "null"]}, "points": {"title": "Points", "description": "Points earned.", "type": ["number", "null"]}, "heart_rate_summary": {"type": "object", "properties": {"min": {"title": "Min", "description": "Minimum heart rate.", "type": ["integer", "null"]}, "max": {"title": "Max", "description": "Maximum heart rate.", "type": ["integer", "null"]}, "average": {"title": "Average", "description": "Average heart rate.", "type": ["integer", "null"]}, "resting": {"title": "Resting", "description": "Resting heart rate.", "type": ["integer", "null"]}}}}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/601f0b78-fda4-498f-80bc-fc5d56211366/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_connection_widget
Presents an HTML connection widget.
200
null
{"display_name": "", "url": "", "connected": "CONNECTED", "connection_slug": "", "img_url": ""}
{"type": "object", "properties": {"display_name": {"title": "Display name", "type": "string"}, "url": {"title": "Url", "type": "string", "minLength": 1}, "connected": {"title": "Connected", "type": "string", "enum": ["CONNECTED", "ERROR", "NOT_CONNECTED"]}, "connection_slug": {"title": "Connection slug", "type": "string"}, "img_url": {"title": "Img url", "type": "string", "minLength": 1}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/2aed811d-dbd5-42cf-972d-1443f70b5a75/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
app_totals_list
Total values for calories, distance, steps, points and activity duration over all profiles in the app.
200
null
[{"total_calories": 0, "total_distance": 0, "total_steps": 0, "total_points": 0}]
{"type": "array", "items": {"type": "object", "properties": {"total_calories": {"title": "Total calories", "type": "number"}, "total_distance": {"title": "Total distance", "type": "number"}, "total_steps": {"title": "Total steps", "type": "number"}, "total_points": {"title": "Total points", "type": "number"}, "total_activity_duration": {"title": "Total activity duration", "minLength": 1}}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/b68e2877-4ef5-402e-a13f-9a6eac58642f/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_activity_segment_list
Lists segments of activities and small non-workout-like movements.
200
null
[{"timestamp": "", "source": "AGGREGATED", "is_manual": true, "type": "RUNNING", "distance": 0, "steps": 0, "elevation": 0, "speed": 0, "calories": 0, "points": 0, "heart_rate_summary": {"min": 0, "max": 0, "average": 0, "resting": 0}}]
{"type": "array", "items": {"required": ["timestamp", "source", "type"], "type": "object", "properties": {"timestamp": {"title": "Timestamp", "description": "Starting time of the measurement.", "type": "string", "format": "date-time"}, "duration": {"title": "Duration", "minLength": 1}, "source": {"title": "Source", "description": "Origin of the data.", "type": "string", "enum": ["AGGREGATED", "ANDROID", "APPLE", "FITBIT", "GARMIN", "GOOGLEFIT", "HUAWEI", "MYZONE", "OMH", "OURA", "POLAR", "SAMSUNG", "STRAVA", "WF", "WITHINGS"]}, "is_manual": {"title": "Is_manual", "description": "Whether the data was entered manually.", "type": ["boolean", "null"]}, "type": {"title": "Type", "description": "Type of the activity.", "type": "string", "enum": ["RUNNING", "CROSSFIT", "CYCLING", "SWIMMING", "OTHER", "ROWING", "WALKING", "MINDFULNESS", "YOGA", "STRENGTH_TRAINING"]}, "distance": {"title": "Distance", "description": "Distance in meters.", "type": ["number", "null"]}, "steps": {"title": "Steps", "description": "Steps taken.", "type": ["number", "null"]}, "elevation": {"title": "Elevation", "description": "Elevation gained during the workout.", "type": ["number", "null"]}, "speed": {"title": "Speed", "description": "Average speed during the workout", "type": ["number", "null"]}, "calories": {"title": "Calories", "description": "Calories burned.", "type": ["number", "null"]}, "points": {"title": "Points", "description": "Points earned.", "type": ["number", "null"]}, "heart_rate_summary": {"type": "object", "properties": {"min": {"title": "Min", "description": "Minimum heart rate.", "type": ["integer", "null"]}, "max": {"title": "Max", "description": "Maximum heart rate.", "type": ["integer", "null"]}, "average": {"title": "Average", "description": "Average heart rate.", "type": ["integer", "null"]}, "resting": {"title": "Resting", "description": "Resting heart rate.", "type": ["integer", "null"]}}}}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/03889de8-a328-4792-83f4-f02199cf6fdb/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_weight_list
Lists changes in weight for the profile.
200
null
[{"timestamp": "", "source": "AGGREGATED", "is_manual": true, "weight": 0}]
{"type": "array", "items": {"required": ["timestamp", "source"], "type": "object", "properties": {"timestamp": {"title": "Timestamp", "description": "Starting time of the measurement.", "type": "string", "format": "date-time"}, "source": {"title": "Source", "description": "Origin of the data.", "type": "string", "enum": ["AGGREGATED", "ANDROID", "APPLE", "FITBIT", "GARMIN", "GOOGLEFIT", "HUAWEI", "MYZONE", "OMH", "OURA", "POLAR", "SAMSUNG", "STRAVA", "WF", "WITHINGS"]}, "is_manual": {"title": "Is_manual", "description": "Whether the data was entered manually.", "type": ["boolean", "null"]}, "weight": {"title": "Weight", "description": "Weight in kg.", "type": ["number", "null"]}}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/37d12d66-2e33-43bf-a003-91a99b89374d/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
challenge_member_update
Add member to a team. Note: for now if the challenge is a team challenge and no team is specified, the first team for the specified profile is used. Do note that this is a temporary fix and may be removed at any time.
200
null
{"profile": "", "team": "", "is_active": true, "joined": ""}
{"required": ["profile"], "type": "object", "properties": {"profile": {"title": "Profile", "description": "A profile public_id is expected", "type": "string", "format": "uuid"}, "team": {"title": "Team", "description": "A team public_id is expected", "type": "string", "format": "uuid"}, "is_active": {"title": "Is active", "description": "Whether profile actively participates in challenge.\n\nWhile inactive, scores/leaderboard will not be updated but still be visible.", "type": "boolean"}, "joined": {"title": "Joined", "description": "The timestamp when the profile/team joined the challenge.", "type": "string", "format": "date-time"}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/324dfb17-d246-444f-88cb-9be4ecea4bfd/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_biometric_list
Lists changes in weight, height and bmi for the profile.
200
null
[{"timestamp": "", "source": "AGGREGATED", "is_manual": true, "weight": 0, "height": 0, "bmi": 0}]
{"type": "array", "items": {"required": ["timestamp", "source"], "type": "object", "properties": {"timestamp": {"title": "Timestamp", "description": "Starting time of the measurement.", "type": "string", "format": "date-time"}, "source": {"title": "Source", "description": "Origin of the data.", "type": "string", "enum": ["AGGREGATED", "ANDROID", "APPLE", "FITBIT", "GARMIN", "GOOGLEFIT", "HUAWEI", "MYZONE", "OMH", "OURA", "POLAR", "SAMSUNG", "STRAVA", "WF", "WITHINGS"]}, "is_manual": {"title": "Is_manual", "description": "Whether the data was entered manually.", "type": ["boolean", "null"]}, "weight": {"title": "Weight", "description": "Weight in kg.", "type": ["number", "null"]}, "height": {"title": "Height", "description": "Height in cm.", "type": ["number", "null"]}, "bmi": {"title": "Bmi", "description": "Body Mass Index, automatically calculated if not entered and both weight and height are available.", "type": ["number", "null"]}}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/b8ec94f1-328d-4a5f-ad49-67c254a2d5c9/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_sleep_detail_list
Provides sleep detail data.
200
null
[{"timestamp": "", "source": "AGGREGATED", "timestamp_end": "", "level": "AWAKE"}]
{"type": "array", "items": {"required": ["timestamp", "source", "level"], "type": "object", "properties": {"timestamp": {"title": "Timestamp", "description": "Starting time of the measurement.", "type": "string", "format": "date-time"}, "source": {"title": "Source", "description": "Origin of the data.", "type": "string", "enum": ["AGGREGATED", "ANDROID", "APPLE", "FITBIT", "GARMIN", "GOOGLEFIT", "HUAWEI", "MYZONE", "OMH", "OURA", "POLAR", "SAMSUNG", "STRAVA", "WF", "WITHINGS"]}, "timestamp_end": {"title": "Timestamp end", "description": "Ending time of the measurement.", "type": "string", "format": "date-time"}, "level": {"title": "Level", "description": "Sleep level", "type": "string", "enum": ["AWAKE", "LIGHT", "DEEP", "REM", "UNKNOWN"]}, "duration": {"title": "Duration", "minLength": 1}}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/300858ba-dd6b-41e9-9ed3-81b9bac1a111/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_partial_update
Performs a partial update
200
null
{"url": "", "public_id": "", "given_name": "", "family_name": "", "nickname": "", "gender": "M", "birthdate": "", "zoneinfo": "", "locale": "", "total_calories": 0, "total_distance": 0, "total_steps": 0, "total_points": 0, "reference": "", "teams": [{"name": "", "public_id": "", "url": "", "avatar": ""}], "avatar": "", "num_active_challenges": "", "num_done_challenges": "", "num_future_challenges": ""}
{"type": "object", "properties": {"url": {"title": "Url", "type": "string", "format": "uri"}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "given_name": {"title": "Given name", "type": "string", "maxLength": 100}, "family_name": {"title": "Family name", "type": "string", "maxLength": 100}, "nickname": {"title": "Nickname", "type": "string", "maxLength": 100}, "gender": {"title": "Gender", "type": "string", "enum": ["M", "F", "X"]}, "birthdate": {"title": "Birthdate", "type": ["string", "null"], "format": "date"}, "zoneinfo": {"title": "Zoneinfo", "type": "string"}, "locale": {"title": "Locale", "type": "string", "maxLength": 5}, "total_calories": {"title": "Total calories", "type": "number"}, "total_distance": {"title": "Total distance", "type": "number"}, "total_steps": {"title": "Total steps", "type": "number"}, "total_points": {"title": "Total points", "type": "number"}, "total_activity_duration": {"title": "Total activity duration", "minLength": 1}, "reference": {"title": "Reference", "type": "string", "maxLength": 255}, "teams": {"description": "Team of which this profile is a member of", "type": "array", "items": {"description": "Team of which this profile is a member of", "required": ["name"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "maxLength": 100, "minLength": 1}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "url": {"title": "Url", "type": "string", "format": "uri"}, "avatar": {"title": "Avatar", "type": ["string", "null"], "format": "uri", "minLength": 1}}}}, "avatar": {"title": "Avatar", "type": ["string", "null"], "format": "uri", "minLength": 1}, "num_active_challenges": {"title": "Num active challenges", "type": "string"}, "num_done_challenges": {"title": "Num done challenges", "type": "string"}, "num_future_challenges": {"title": "Num future challenges", "type": "string"}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/0f27c5ff-ff65-4993-97f4-7270c42590f0/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
challenge_remove_members
Remove members from the challenge
201
null
{"profiles": [], "is_active": true, "team": "", "joined": ""}
{"required": ["profiles"], "type": "object", "properties": {"profiles": {"type": "array", "items": {"type": "string", "format": "uuid"}}, "is_active": {"title": "Is active", "description": "Whether profile actively participates in challenge.\n\nWhile inactive, scores/leaderboard will not be updated but still be visible.", "type": "boolean"}, "team": {"title": "Team", "description": "A team public_id is expected", "type": "string", "format": "uuid"}, "joined": {"title": "Joined", "description": "The timestamp when the profile/team joined the challenge.", "type": "string", "format": "date-time"}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/7a64e633-aa14-4a50-8ccf-01a4d03b5d7e/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
challenge_member_create
Add member to a team. Note: for now if the challenge is a team challenge and no team is specified, the first team for the specified profile is used. Do note that this is a temporary fix and may be removed at any time.
201
null
{"profile": "", "team": "", "is_active": true, "joined": ""}
{"required": ["profile"], "type": "object", "properties": {"profile": {"title": "Profile", "description": "A profile public_id is expected", "type": "string", "format": "uuid"}, "team": {"title": "Team", "description": "A team public_id is expected", "type": "string", "format": "uuid"}, "is_active": {"title": "Is active", "description": "Whether profile actively participates in challenge.\n\nWhile inactive, scores/leaderboard will not be updated but still be visible.", "type": "boolean"}, "joined": {"title": "Joined", "description": "The timestamp when the profile/team joined the challenge.", "type": "string", "format": "date-time"}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/3b939a2c-16da-4a8e-b3e9-f0ae70ed7d20/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
challenge_deactivate_members_update
This docstring is used by Django Rest Framework
200
null
{"profiles": [], "is_active": true, "team": "", "joined": ""}
{"required": ["profiles"], "type": "object", "properties": {"profiles": {"type": "array", "items": {"type": "string", "format": "uuid"}}, "is_active": {"title": "Is active", "description": "Whether profile actively participates in challenge.\n\nWhile inactive, scores/leaderboard will not be updated but still be visible.", "type": "boolean"}, "team": {"title": "Team", "description": "A team public_id is expected", "type": "string", "format": "uuid"}, "joined": {"title": "Joined", "description": "The timestamp when the profile/team joined the challenge.", "type": "string", "format": "date-time"}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/69bfac3e-6508-4254-b40a-6c7902145d65/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
profile_sleep_summary_list
Provides summarized sleep data.
200
null
[{"timestamp": "", "timestamp_end": "", "source": "AGGREGATED", "is_manual": true, "sleep_score": 0}]
{"type": "array", "items": {"required": ["timestamp", "source"], "type": "object", "properties": {"timestamp": {"title": "Timestamp", "description": "Starting time of the measurement.", "type": "string", "format": "date-time"}, "duration": {"title": "Duration", "minLength": 1}, "timestamp_end": {"title": "Timestamp end", "type": "string", "format": "date-time"}, "source": {"title": "Source", "description": "Origin of the data.", "type": "string", "enum": ["AGGREGATED", "ANDROID", "APPLE", "FITBIT", "GARMIN", "GOOGLEFIT", "HUAWEI", "MYZONE", "OMH", "OURA", "POLAR", "SAMSUNG", "STRAVA", "WF", "WITHINGS"]}, "is_manual": {"title": "Is_manual", "description": "Whether the data was entered manually.", "type": ["boolean", "null"]}, "awake": {"title": "Awake", "description": "Time awake.", "minLength": 1}, "light": {"title": "Light", "description": "Time in light sleep.", "minLength": 1}, "deep": {"title": "Deep", "description": "Time in deep sleep.", "minLength": 1}, "rem": {"title": "Rem", "description": "Time in REM sleep.", "minLength": 1}, "sleep_score": {"title": "Sleep_score", "description": "Sleep score", "type": ["integer", "null"]}, "total_time_in_sleep": {"title": "Total time in sleep", "minLength": 1}}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/44e65712-ce08-4af8-876b-c60bfb11b1b5/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
challenge_deactivate_members_create
This docstring is used by Django Rest Framework
201
null
{"profiles": [], "is_active": true, "team": "", "joined": ""}
{"required": ["profiles"], "type": "object", "properties": {"profiles": {"type": "array", "items": {"type": "string", "format": "uuid"}}, "is_active": {"title": "Is active", "description": "Whether profile actively participates in challenge.\n\nWhile inactive, scores/leaderboard will not be updated but still be visible.", "type": "boolean"}, "team": {"title": "Team", "description": "A team public_id is expected", "type": "string", "format": "uuid"}, "joined": {"title": "Joined", "description": "The timestamp when the profile/team joined the challenge.", "type": "string", "format": "date-time"}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/d6c95e9e-9b5d-4e70-b505-335e3a2be0e8/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
challenge_members_read
Get a paginated list of members enrolled to a Challenge
200
null
{"count": 0, "next": "", "previous": "", "results": [{"url": "", "public_id": "", "title": "", "slogan": "", "description": "", "start": "", "end": "", "type": "INDIVIDUAL", "goal": "DAILY", "goal_value": 0, "goal_type": "POINTS", "visibility": "PUBLIC", "num_members": "", "calculation_method": "SUM", "goal_progress": 0, "enrollment_method": "AUTOMATIC", "default_enrollment_time": "CHALLENGE_START", "repetition": "NONE", "avatar": "", "data_source": "", "activity_types": [{"activity_type": "RUNNING"}], "current_period_start": "", "current_period_end": "", "goal_cap": true, "total_calories": 0, "total_distance": 0, "total_steps": 0, "total_points": 0}]}
{"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": ["string", "null"], "format": "uri"}, "previous": {"type": ["string", "null"], "format": "uri"}, "results": {"type": "array", "items": {"required": ["title", "start", "type", "goal", "goal_type", "visibility", "calculation_method", "enrollment_method", "repetition"], "type": "object", "properties": {"url": {"title": "Url", "type": "string", "format": "uri"}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "title": {"title": "Title", "type": "string", "minLength": 1}, "slogan": {"title": "Slogan", "type": "string"}, "description": {"title": "Description", "type": "string"}, "start": {"title": "Start", "type": "string", "format": "date-time"}, "end": {"title": "End", "type": ["string", "null"], "format": "date-time"}, "type": {"title": "Type", "type": "string", "enum": ["INDIVIDUAL", "GROUP", "TEAM"]}, "goal": {"title": "Goal", "type": "string", "enum": ["DAILY", "TOTAL", "WEEKLY", "MONTHLY"]}, "goal_value": {"title": "Goal value", "type": ["integer", "null"], "maximum": 2147483647, "minimum": -2147483648}, "goal_type": {"title": "Goal type", "type": "string", "enum": ["POINTS", "DISTANCE", "CALORIES", "DURATION", "STEPS"]}, "visibility": {"title": "Visibility", "type": "string", "enum": ["PUBLIC", "PRIVATE"]}, "num_members": {"title": "Num members", "type": "string"}, "calculation_method": {"title": "Calculation method", "type": "string", "enum": ["SUM", "AVERAGE"]}, "goal_progress": {"title": "Goal progress", "description": "Progress towards the goal, from perspective of profile whose bearer is used for authentication: can be an individual/team/global score. When goal is duration, this is the duration in seconds. When an admin token is used, returns 0.0.", "type": "number"}, "enrollment_method": {"title": "Enrollment method", "type": "string", "enum": ["AUTOMATIC", "MANUAL"]}, "default_enrollment_time": {"title": "Default enrollment time", "type": "string", "enum": ["CHALLENGE_START", "ENROLLMENT_TIME"]}, "repetition": {"title": "Repetition", "type": "string", "enum": ["NONE", "STREAK", "STICKTOIT", "GOALBREAKER"]}, "avatar": {"title": "Avatar", "type": ["string", "null"], "format": "uri", "minLength": 1}, "data_source": {"title": "Data source", "type": "string", "minLength": 1}, "activity_types": {"type": "array", "items": {"required": ["activity_type"], "type": "object", "properties": {"activity_type": {"title": "Activity type", "type": "string", "enum": ["RUNNING", "CROSSFIT", "CYCLING", "SWIMMING", "OTHER", "ROWING", "WALKING", "MINDFULNESS", "YOGA", "STRENGTH_TRAINING"]}}}}, "current_period_start": {"title": "Current period start", "description": "The start (exclusive) of the current period. Null if the challenge has not started yet.", "type": "string", "format": "date-time"}, "current_period_end": {"title": "Current period end", "description": "The end (exclusive) of the current period. Null if the challenge end has passed.", "type": "string", "format": "date-time"}, "goal_cap": {"title": "Goal cap", "description": "Whether scores should be unable to surpass the goal value.", "type": "boolean"}, "total_calories": {"title": "Total calories", "type": "number"}, "total_distance": {"title": "Total distance", "type": "number"}, "total_steps": {"title": "Total steps", "type": "number"}, "total_points": {"title": "Total points", "type": "number"}, "total_activity_duration": {"title": "Total activity duration", "minLength": 1}}}}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/b88335d3-2fc0-460b-927b-7fa8ad178328/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
challenge_deactivate_member_create
This docstring is used by Django Rest Framework
201
null
{"profile": "", "team": "", "is_active": true, "joined": ""}
{"required": ["profile"], "type": "object", "properties": {"profile": {"title": "Profile", "description": "A profile public_id is expected", "type": "string", "format": "uuid"}, "team": {"title": "Team", "description": "A team public_id is expected", "type": "string", "format": "uuid"}, "is_active": {"title": "Is active", "description": "Whether profile actively participates in challenge.\n\nWhile inactive, scores/leaderboard will not be updated but still be visible.", "type": "boolean"}, "joined": {"title": "Joined", "description": "The timestamp when the profile/team joined the challenge.", "type": "string", "format": "date-time"}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/bb7b48b2-9d61-493e-ad2c-5a8373377619/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
challenge_team_read
List team members' contribution to the challenge. This endpoint returns a list of objects.
200
null
{"url": "", "public_id": "", "name": "", "gender": "M", "teams": [{"name": "", "public_id": "", "url": "", "avatar": ""}], "reference": "", "score": 0, "position": 0, "avatar": ""}
{"required": ["avatar"], "type": "object", "properties": {"url": {"title": "Url", "type": "string", "format": "uri"}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "name": {"title": "Name", "type": "string", "minLength": 1}, "gender": {"title": "Gender", "type": "string", "enum": ["M", "F", "X"]}, "teams": {"description": "Team of which this profile is a member of", "type": "array", "items": {"description": "Team of which this profile is a member of", "required": ["name"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "maxLength": 100, "minLength": 1}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "url": {"title": "Url", "type": "string", "format": "uri"}, "avatar": {"title": "Avatar", "type": ["string", "null"], "format": "uri", "minLength": 1}}}}, "reference": {"title": "Reference", "type": "string", "minLength": 1}, "score": {"title": "Score", "type": "number"}, "position": {"title": "Position", "type": "integer"}, "avatar": {"title": "Avatar", "type": "string", "format": "uri", "minLength": 1}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/6c0d4638-7813-45d6-ae72-e721d7181ecd/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
challenge_leaderboard_read
Displays the leaderboard for a challenge. This endpoint returns a list of objects.
200
null
{"name": "", "public_id": "", "url": "", "score": 0, "position": 0, "avatar": ""}
{"required": ["avatar"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "minLength": 1}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "url": {"title": "Url", "type": "string", "format": "uri"}, "score": {"title": "Score", "type": "number"}, "position": {"title": "Position", "type": "integer"}, "avatar": {"title": "Avatar", "type": "string", "format": "uri", "minLength": 1}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/e5ed54df-34d7-448e-a573-9fb8c13d01ff/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
challenge_members_update
Add members to a team. Note: for now if the challenge is a team challenge and no team is specified, the first team for the specified profile is used. Do note that this is a temporary fix and may be removed at any time. Note: for the GET/POST endpoint an admin bearer token is required, while the GET also accepts profile bearer tokens
200
null
{"profiles": [], "is_active": true, "team": "", "joined": ""}
{"required": ["profiles"], "type": "object", "properties": {"profiles": {"type": "array", "items": {"type": "string", "format": "uuid"}}, "is_active": {"title": "Is active", "description": "Whether profile actively participates in challenge.\n\nWhile inactive, scores/leaderboard will not be updated but still be visible.", "type": "boolean"}, "team": {"title": "Team", "description": "A team public_id is expected", "type": "string", "format": "uuid"}, "joined": {"title": "Joined", "description": "The timestamp when the profile/team joined the challenge.", "type": "string", "format": "date-time"}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/5455faae-b9ec-4392-bdbf-167c8e2dd82c/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
challenge_create
Creates a new challenge
201
null
{"url": "", "public_id": "", "title": "", "slogan": "", "description": "", "start": "", "end": "", "type": "INDIVIDUAL", "goal": "DAILY", "goal_value": 0, "goal_type": "POINTS", "visibility": "PUBLIC", "num_members": "", "calculation_method": "SUM", "goal_progress": 0, "enrollment_method": "AUTOMATIC", "default_enrollment_time": "CHALLENGE_START", "repetition": "NONE", "avatar": "", "data_source": "", "activity_types": [{"activity_type": "RUNNING"}], "current_period_start": "", "current_period_end": "", "goal_cap": true, "total_calories": 0, "total_distance": 0, "total_steps": 0, "total_points": 0}
{"required": ["title", "start", "type", "goal", "goal_type", "visibility", "calculation_method", "enrollment_method", "repetition"], "type": "object", "properties": {"url": {"title": "Url", "type": "string", "format": "uri"}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "title": {"title": "Title", "type": "string", "minLength": 1}, "slogan": {"title": "Slogan", "type": "string"}, "description": {"title": "Description", "type": "string"}, "start": {"title": "Start", "type": "string", "format": "date-time"}, "end": {"title": "End", "type": ["string", "null"], "format": "date-time"}, "type": {"title": "Type", "type": "string", "enum": ["INDIVIDUAL", "GROUP", "TEAM"]}, "goal": {"title": "Goal", "type": "string", "enum": ["DAILY", "TOTAL", "WEEKLY", "MONTHLY"]}, "goal_value": {"title": "Goal value", "type": ["integer", "null"], "maximum": 2147483647, "minimum": -2147483648}, "goal_type": {"title": "Goal type", "type": "string", "enum": ["POINTS", "DISTANCE", "CALORIES", "DURATION", "STEPS"]}, "visibility": {"title": "Visibility", "type": "string", "enum": ["PUBLIC", "PRIVATE"]}, "num_members": {"title": "Num members", "type": "string"}, "calculation_method": {"title": "Calculation method", "type": "string", "enum": ["SUM", "AVERAGE"]}, "goal_progress": {"title": "Goal progress", "description": "Progress towards the goal, from perspective of profile whose bearer is used for authentication: can be an individual/team/global score. When goal is duration, this is the duration in seconds. When an admin token is used, returns 0.0.", "type": "number"}, "enrollment_method": {"title": "Enrollment method", "type": "string", "enum": ["AUTOMATIC", "MANUAL"]}, "default_enrollment_time": {"title": "Default enrollment time", "type": "string", "enum": ["CHALLENGE_START", "ENROLLMENT_TIME"]}, "repetition": {"title": "Repetition", "type": "string", "enum": ["NONE", "STREAK", "STICKTOIT", "GOALBREAKER"]}, "avatar": {"title": "Avatar", "type": ["string", "null"], "format": "uri", "minLength": 1}, "data_source": {"title": "Data source", "type": "string", "minLength": 1}, "activity_types": {"type": "array", "items": {"required": ["activity_type"], "type": "object", "properties": {"activity_type": {"title": "Activity type", "type": "string", "enum": ["RUNNING", "CROSSFIT", "CYCLING", "SWIMMING", "OTHER", "ROWING", "WALKING", "MINDFULNESS", "YOGA", "STRENGTH_TRAINING"]}}}}, "current_period_start": {"title": "Current period start", "description": "The start (exclusive) of the current period. Null if the challenge has not started yet.", "type": "string", "format": "date-time"}, "current_period_end": {"title": "Current period end", "description": "The end (exclusive) of the current period. Null if the challenge end has passed.", "type": "string", "format": "date-time"}, "goal_cap": {"title": "Goal cap", "description": "Whether scores should be unable to surpass the goal value.", "type": "boolean"}, "total_calories": {"title": "Total calories", "type": "number"}, "total_distance": {"title": "Total distance", "type": "number"}, "total_steps": {"title": "Total steps", "type": "number"}, "total_points": {"title": "Total points", "type": "number"}, "total_activity_duration": {"title": "Total activity duration", "minLength": 1}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/81cc6083-ef3d-4fe7-8534-0270605070e3/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
challenge_leaderboard_history
Retrieve the scores of the authenticated profile for all periods since the profile joined the challenge. This endpoint returns a list of objects.
200
null
{"score": 0, "start": "", "end": ""}
{"type": "object", "properties": {"score": {"title": "Score", "type": "number"}, "start": {"title": "Start", "type": "string", "format": "date-time"}, "end": {"title": "End", "type": "string", "format": "date-time"}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/008a8805-82e7-4acf-9337-3a3102ee7f7b/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
challenge_partial_update
Edits a challenge
200
null
{"url": "", "public_id": "", "title": "", "slogan": "", "description": "", "start": "", "end": "", "type": "INDIVIDUAL", "goal": "DAILY", "goal_value": 0, "goal_type": "POINTS", "visibility": "PUBLIC", "num_members": "", "calculation_method": "SUM", "goal_progress": 0, "enrollment_method": "AUTOMATIC", "default_enrollment_time": "CHALLENGE_START", "repetition": "NONE", "avatar": "", "data_source": "", "activity_types": [{"activity_type": "RUNNING"}], "current_period_start": "", "current_period_end": "", "goal_cap": true, "total_calories": 0, "total_distance": 0, "total_steps": 0, "total_points": 0}
{"required": ["title", "start", "type", "goal", "goal_type", "visibility", "calculation_method", "enrollment_method", "repetition"], "type": "object", "properties": {"url": {"title": "Url", "type": "string", "format": "uri"}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "title": {"title": "Title", "type": "string", "minLength": 1}, "slogan": {"title": "Slogan", "type": "string"}, "description": {"title": "Description", "type": "string"}, "start": {"title": "Start", "type": "string", "format": "date-time"}, "end": {"title": "End", "type": ["string", "null"], "format": "date-time"}, "type": {"title": "Type", "type": "string", "enum": ["INDIVIDUAL", "GROUP", "TEAM"]}, "goal": {"title": "Goal", "type": "string", "enum": ["DAILY", "TOTAL", "WEEKLY", "MONTHLY"]}, "goal_value": {"title": "Goal value", "type": ["integer", "null"], "maximum": 2147483647, "minimum": -2147483648}, "goal_type": {"title": "Goal type", "type": "string", "enum": ["POINTS", "DISTANCE", "CALORIES", "DURATION", "STEPS"]}, "visibility": {"title": "Visibility", "type": "string", "enum": ["PUBLIC", "PRIVATE"]}, "num_members": {"title": "Num members", "type": "string"}, "calculation_method": {"title": "Calculation method", "type": "string", "enum": ["SUM", "AVERAGE"]}, "goal_progress": {"title": "Goal progress", "description": "Progress towards the goal, from perspective of profile whose bearer is used for authentication: can be an individual/team/global score. When goal is duration, this is the duration in seconds. When an admin token is used, returns 0.0.", "type": "number"}, "enrollment_method": {"title": "Enrollment method", "type": "string", "enum": ["AUTOMATIC", "MANUAL"]}, "default_enrollment_time": {"title": "Default enrollment time", "type": "string", "enum": ["CHALLENGE_START", "ENROLLMENT_TIME"]}, "repetition": {"title": "Repetition", "type": "string", "enum": ["NONE", "STREAK", "STICKTOIT", "GOALBREAKER"]}, "avatar": {"title": "Avatar", "type": ["string", "null"], "format": "uri", "minLength": 1}, "data_source": {"title": "Data source", "type": "string", "minLength": 1}, "activity_types": {"type": "array", "items": {"required": ["activity_type"], "type": "object", "properties": {"activity_type": {"title": "Activity type", "type": "string", "enum": ["RUNNING", "CROSSFIT", "CYCLING", "SWIMMING", "OTHER", "ROWING", "WALKING", "MINDFULNESS", "YOGA", "STRENGTH_TRAINING"]}}}}, "current_period_start": {"title": "Current period start", "description": "The start (exclusive) of the current period. Null if the challenge has not started yet.", "type": "string", "format": "date-time"}, "current_period_end": {"title": "Current period end", "description": "The end (exclusive) of the current period. Null if the challenge end has passed.", "type": "string", "format": "date-time"}, "goal_cap": {"title": "Goal cap", "description": "Whether scores should be unable to surpass the goal value.", "type": "boolean"}, "total_calories": {"title": "Total calories", "type": "number"}, "total_distance": {"title": "Total distance", "type": "number"}, "total_steps": {"title": "Total steps", "type": "number"}, "total_points": {"title": "Total points", "type": "number"}, "total_activity_duration": {"title": "Total activity duration", "minLength": 1}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/7f84b7c8-73ec-413a-b71e-1a0d83f13f64/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
challenge_update
Edits a challenge
200
null
{"url": "", "public_id": "", "title": "", "slogan": "", "description": "", "start": "", "end": "", "type": "INDIVIDUAL", "goal": "DAILY", "goal_value": 0, "goal_type": "POINTS", "visibility": "PUBLIC", "num_members": "", "calculation_method": "SUM", "goal_progress": 0, "enrollment_method": "AUTOMATIC", "default_enrollment_time": "CHALLENGE_START", "repetition": "NONE", "avatar": "", "data_source": "", "activity_types": [{"activity_type": "RUNNING"}], "current_period_start": "", "current_period_end": "", "goal_cap": true, "total_calories": 0, "total_distance": 0, "total_steps": 0, "total_points": 0}
{"required": ["title", "start", "type", "goal", "goal_type", "visibility", "calculation_method", "enrollment_method", "repetition"], "type": "object", "properties": {"url": {"title": "Url", "type": "string", "format": "uri"}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "title": {"title": "Title", "type": "string", "minLength": 1}, "slogan": {"title": "Slogan", "type": "string"}, "description": {"title": "Description", "type": "string"}, "start": {"title": "Start", "type": "string", "format": "date-time"}, "end": {"title": "End", "type": ["string", "null"], "format": "date-time"}, "type": {"title": "Type", "type": "string", "enum": ["INDIVIDUAL", "GROUP", "TEAM"]}, "goal": {"title": "Goal", "type": "string", "enum": ["DAILY", "TOTAL", "WEEKLY", "MONTHLY"]}, "goal_value": {"title": "Goal value", "type": ["integer", "null"], "maximum": 2147483647, "minimum": -2147483648}, "goal_type": {"title": "Goal type", "type": "string", "enum": ["POINTS", "DISTANCE", "CALORIES", "DURATION", "STEPS"]}, "visibility": {"title": "Visibility", "type": "string", "enum": ["PUBLIC", "PRIVATE"]}, "num_members": {"title": "Num members", "type": "string"}, "calculation_method": {"title": "Calculation method", "type": "string", "enum": ["SUM", "AVERAGE"]}, "goal_progress": {"title": "Goal progress", "description": "Progress towards the goal, from perspective of profile whose bearer is used for authentication: can be an individual/team/global score. When goal is duration, this is the duration in seconds. When an admin token is used, returns 0.0.", "type": "number"}, "enrollment_method": {"title": "Enrollment method", "type": "string", "enum": ["AUTOMATIC", "MANUAL"]}, "default_enrollment_time": {"title": "Default enrollment time", "type": "string", "enum": ["CHALLENGE_START", "ENROLLMENT_TIME"]}, "repetition": {"title": "Repetition", "type": "string", "enum": ["NONE", "STREAK", "STICKTOIT", "GOALBREAKER"]}, "avatar": {"title": "Avatar", "type": ["string", "null"], "format": "uri", "minLength": 1}, "data_source": {"title": "Data source", "type": "string", "minLength": 1}, "activity_types": {"type": "array", "items": {"required": ["activity_type"], "type": "object", "properties": {"activity_type": {"title": "Activity type", "type": "string", "enum": ["RUNNING", "CROSSFIT", "CYCLING", "SWIMMING", "OTHER", "ROWING", "WALKING", "MINDFULNESS", "YOGA", "STRENGTH_TRAINING"]}}}}, "current_period_start": {"title": "Current period start", "description": "The start (exclusive) of the current period. Null if the challenge has not started yet.", "type": "string", "format": "date-time"}, "current_period_end": {"title": "Current period end", "description": "The end (exclusive) of the current period. Null if the challenge end has passed.", "type": "string", "format": "date-time"}, "goal_cap": {"title": "Goal cap", "description": "Whether scores should be unable to surpass the goal value.", "type": "boolean"}, "total_calories": {"title": "Total calories", "type": "number"}, "total_distance": {"title": "Total distance", "type": "number"}, "total_steps": {"title": "Total steps", "type": "number"}, "total_points": {"title": "Total points", "type": "number"}, "total_activity_duration": {"title": "Total activity duration", "minLength": 1}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/8a2c5a50-c689-49b6-a641-c3074bf8d557/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
challenge_team_list
List the standings of different teams in challenges (don't have to be team challenges). This endpoint returns a list of objects.
200
null
{"count": 0, "next": "", "previous": "", "results": [{"name": "", "public_id": "", "url": "", "num_members": "", "score": 0, "position": 0, "avatar": ""}]}
{"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": ["string", "null"], "format": "uri"}, "previous": {"type": ["string", "null"], "format": "uri"}, "results": {"type": "array", "items": {"required": ["name", "avatar"], "type": "object", "properties": {"name": {"title": "Name", "type": "string", "maxLength": 100, "minLength": 1}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "url": {"title": "Url", "type": "string", "format": "uri"}, "num_members": {"title": "Num members", "type": "string"}, "score": {"title": "Score", "type": "number"}, "position": {"title": "Position", "type": "integer"}, "avatar": {"title": "Avatar", "type": "string", "format": "uri", "minLength": 1}}}}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/af5f4ff7-1456-43de-8f55-78e8a5eb2401/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
challenge_deactivate_member_update
This docstring is used by Django Rest Framework
200
null
{"profile": "", "team": "", "is_active": true, "joined": ""}
{"required": ["profile"], "type": "object", "properties": {"profile": {"title": "Profile", "description": "A profile public_id is expected", "type": "string", "format": "uuid"}, "team": {"title": "Team", "description": "A team public_id is expected", "type": "string", "format": "uuid"}, "is_active": {"title": "Is active", "description": "Whether profile actively participates in challenge.\n\nWhile inactive, scores/leaderboard will not be updated but still be visible.", "type": "boolean"}, "joined": {"title": "Joined", "description": "The timestamp when the profile/team joined the challenge.", "type": "string", "format": "date-time"}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/694cebc1-e31c-4143-94a1-0840df8f0aec/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
challenge_read
Gets a single challenge
200
null
{"url": "", "public_id": "", "title": "", "slogan": "", "description": "", "start": "", "end": "", "type": "INDIVIDUAL", "goal": "DAILY", "goal_value": 0, "goal_type": "POINTS", "visibility": "PUBLIC", "num_members": "", "calculation_method": "SUM", "goal_progress": 0, "enrollment_method": "AUTOMATIC", "default_enrollment_time": "CHALLENGE_START", "repetition": "NONE", "avatar": "", "data_source": "", "activity_types": [{"activity_type": "RUNNING"}], "current_period_start": "", "current_period_end": "", "goal_cap": true, "total_calories": 0, "total_distance": 0, "total_steps": 0, "total_points": 0}
{"required": ["title", "start", "type", "goal", "goal_type", "visibility", "calculation_method", "enrollment_method", "repetition"], "type": "object", "properties": {"url": {"title": "Url", "type": "string", "format": "uri"}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "title": {"title": "Title", "type": "string", "minLength": 1}, "slogan": {"title": "Slogan", "type": "string"}, "description": {"title": "Description", "type": "string"}, "start": {"title": "Start", "type": "string", "format": "date-time"}, "end": {"title": "End", "type": ["string", "null"], "format": "date-time"}, "type": {"title": "Type", "type": "string", "enum": ["INDIVIDUAL", "GROUP", "TEAM"]}, "goal": {"title": "Goal", "type": "string", "enum": ["DAILY", "TOTAL", "WEEKLY", "MONTHLY"]}, "goal_value": {"title": "Goal value", "type": ["integer", "null"], "maximum": 2147483647, "minimum": -2147483648}, "goal_type": {"title": "Goal type", "type": "string", "enum": ["POINTS", "DISTANCE", "CALORIES", "DURATION", "STEPS"]}, "visibility": {"title": "Visibility", "type": "string", "enum": ["PUBLIC", "PRIVATE"]}, "num_members": {"title": "Num members", "type": "string"}, "calculation_method": {"title": "Calculation method", "type": "string", "enum": ["SUM", "AVERAGE"]}, "goal_progress": {"title": "Goal progress", "description": "Progress towards the goal, from perspective of profile whose bearer is used for authentication: can be an individual/team/global score. When goal is duration, this is the duration in seconds. When an admin token is used, returns 0.0.", "type": "number"}, "enrollment_method": {"title": "Enrollment method", "type": "string", "enum": ["AUTOMATIC", "MANUAL"]}, "default_enrollment_time": {"title": "Default enrollment time", "type": "string", "enum": ["CHALLENGE_START", "ENROLLMENT_TIME"]}, "repetition": {"title": "Repetition", "type": "string", "enum": ["NONE", "STREAK", "STICKTOIT", "GOALBREAKER"]}, "avatar": {"title": "Avatar", "type": ["string", "null"], "format": "uri", "minLength": 1}, "data_source": {"title": "Data source", "type": "string", "minLength": 1}, "activity_types": {"type": "array", "items": {"required": ["activity_type"], "type": "object", "properties": {"activity_type": {"title": "Activity type", "type": "string", "enum": ["RUNNING", "CROSSFIT", "CYCLING", "SWIMMING", "OTHER", "ROWING", "WALKING", "MINDFULNESS", "YOGA", "STRENGTH_TRAINING"]}}}}, "current_period_start": {"title": "Current period start", "description": "The start (exclusive) of the current period. Null if the challenge has not started yet.", "type": "string", "format": "date-time"}, "current_period_end": {"title": "Current period end", "description": "The end (exclusive) of the current period. Null if the challenge end has passed.", "type": "string", "format": "date-time"}, "goal_cap": {"title": "Goal cap", "description": "Whether scores should be unable to surpass the goal value.", "type": "boolean"}, "total_calories": {"title": "Total calories", "type": "number"}, "total_distance": {"title": "Total distance", "type": "number"}, "total_steps": {"title": "Total steps", "type": "number"}, "total_points": {"title": "Total points", "type": "number"}, "total_activity_duration": {"title": "Total activity duration", "minLength": 1}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/528cdaa5-2c65-4a60-b0b7-a4d66da88a7e/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
challenge_list
Lists all available challenges
200
null
{"count": 0, "next": "", "previous": "", "results": [{"url": "", "public_id": "", "title": "", "slogan": "", "description": "", "start": "", "end": "", "type": "INDIVIDUAL", "goal": "DAILY", "goal_value": 0, "goal_type": "POINTS", "visibility": "PUBLIC", "num_members": "", "repetition": "NONE", "avatar": "", "data_source": "", "activity_types": [{"activity_type": "RUNNING"}], "current_period_start": "", "current_period_end": "", "goal_cap": true}]}
{"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": ["string", "null"], "format": "uri"}, "previous": {"type": ["string", "null"], "format": "uri"}, "results": {"type": "array", "items": {"required": ["title", "start", "type", "goal", "goal_type", "visibility", "repetition"], "type": "object", "properties": {"url": {"title": "Url", "type": "string", "format": "uri"}, "public_id": {"title": "Public id", "type": "string", "format": "uuid"}, "title": {"title": "Title", "type": "string", "minLength": 1}, "slogan": {"title": "Slogan", "type": "string"}, "description": {"title": "Description", "type": "string"}, "start": {"title": "Start", "type": "string", "format": "date-time"}, "end": {"title": "End", "type": ["string", "null"], "format": "date-time"}, "type": {"title": "Type", "type": "string", "enum": ["INDIVIDUAL", "GROUP", "TEAM"]}, "goal": {"title": "Goal", "type": "string", "enum": ["DAILY", "TOTAL", "WEEKLY", "MONTHLY"]}, "goal_value": {"title": "Goal value", "type": ["integer", "null"], "maximum": 2147483647, "minimum": -2147483648}, "goal_type": {"title": "Goal type", "type": "string", "enum": ["POINTS", "DISTANCE", "CALORIES", "DURATION", "STEPS"]}, "visibility": {"title": "Visibility", "type": "string", "enum": ["PUBLIC", "PRIVATE"]}, "num_members": {"title": "Num members", "type": "string"}, "repetition": {"title": "Repetition", "type": "string", "enum": ["NONE", "STREAK", "STICKTOIT", "GOALBREAKER"]}, "avatar": {"title": "Avatar", "type": ["string", "null"], "format": "uri", "minLength": 1}, "data_source": {"title": "Data source", "type": "string", "minLength": 1}, "activity_types": {"type": "array", "items": {"required": ["activity_type"], "type": "object", "properties": {"activity_type": {"title": "Activity type", "type": "string", "enum": ["RUNNING", "CROSSFIT", "CYCLING", "SWIMMING", "OTHER", "ROWING", "WALKING", "MINDFULNESS", "YOGA", "STRENGTH_TRAINING"]}}}}, "current_period_start": {"title": "Current period start", "description": "The start (exclusive) of the current period. Null if the challenge has not started yet.", "type": "string", "format": "date-time"}, "current_period_end": {"title": "Current period end", "description": "The end (exclusive) of the current period. Null if the challenge end has passed.", "type": "string", "format": "date-time"}, "goal_cap": {"title": "Goal cap", "description": "Whether scores should be unable to surpass the goal value.", "type": "boolean"}}}}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/f5e2955e-6a9a-4cc6-b961-3b57e491cf7c/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
connection_connect_create
Get OAuth URL for this connection.
200
null
{"next": ""}
{"required": ["next"], "type": "object", "properties": {"next": {"title": "Next", "type": "string", "format": "uri", "minLength": 1}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/2c39a556-8c09-4cd3-a266-dc07ab1b6a85/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
notification_send_to_all_create
Send a notification to all registered devices in the app.
201
null
{"title": "", "body": "", "schedule": "", "link": ""}
{"required": ["title", "body"], "type": "object", "properties": {"title": {"title": "Title", "type": "string", "maxLength": 512, "minLength": 1}, "body": {"title": "Body", "type": "string", "maxLength": 2048, "minLength": 1}, "schedule": {"title": "Schedule", "description": "date and time to send notification", "type": ["string", "null"], "format": "date-time"}, "link": {"title": "Link", "type": "string", "maxLength": 1024}}}
5818a24b-ae4a-44c7-adf6-7bccbaf54051/21ddafe1-0855-44eb-868b-a97a3dfb700d/0/0
WeFitter
WeFitter API gives your platform easy access to today’s most used fitness apps and wearable connections in the fitness and health space. By integrating our REST API, valuable health and fitness data from your endusers flows into your platform in order to analyse, leverage and combine with gamification. To receive API credentials, please send an e-mail to [email protected]
null
notification_send_to_profiles_create
Send a notification to all registered devices for the specified profiles.
201
null
{"title": "", "body": "", "schedule": "", "link": "", "profiles": []}
{"required": ["title", "body", "profiles"], "type": "object", "properties": {"title": {"title": "Title", "type": "string", "maxLength": 512, "minLength": 1}, "body": {"title": "Body", "type": "string", "maxLength": 2048, "minLength": 1}, "schedule": {"title": "Schedule", "description": "date and time to send notification", "type": ["string", "null"], "format": "date-time"}, "link": {"title": "Link", "type": "string", "maxLength": 1024}, "profiles": {"type": "array", "items": {"description": "The profiles to send the push notification to", "type": "string", "format": "uuid"}}}}
23b569d1-ec4a-4504-837b-f4e53c413c21/4c8f2d13-6803-46b4-9a6c-1f9a591688fb/0/0
Wellbeing Express
Wellata is a wellbeing content API designed to eliminate the complexities and costs of creating, buying, curating, configuring, and maintaining content
5.5
Api Data
Returns ref to be used for future api calls
200
Response
{"bookmarks": {}, "experiments": {"draft": [], "running": []}, "forms": {"everything": {"action": "https://wellbeingexpress.cdn.prismic.io/api/v1/documents/search", "enctype": "application/x-www-form-urlencoded", "fields": {"access_token": {"default": "MC5ZRDM0M3hBQUFDQUFSam1N.aiHvv71gA--_vTwgRu-_vULvv73vv73vv70K77-9MDTvv73vv73vv73vv73vv70o77-977-9du-_ve-_vTTvv73vv70", "multiple": false, "type": "String"}, "after": {"multiple": false, "type": "String"}, "fetch": {"multiple": false, "type": "String"}, "fetchLinks": {"multiple": false, "type": "String"}, "graphQuery": {"multiple": false, "type": "String"}, "lang": {"multiple": false, "type": "String"}, "orderings": {"multiple": false, "type": "String"}, "page": {"default": "1", "multiple": false, "type": "Integer"}, "pageSize": {"default": "20", "multiple": false, "type": "Integer"}, "q": {"multiple": true, "type": "String"}, "ref": {"multiple": false, "type": "String"}, "referer": {"multiple": false, "type": "String"}}, "method": "GET"}}, "integrationFieldsRef": null, "languages": [{"id": "en-au", "name": "English - Australia"}], "license": "All Rights Reserved", "oauth_initiate": "https://wellbeingexpress.prismic.io/auth", "oauth_token": "https://wellbeingexpress.prismic.io/auth/token", "refs": [{"id": "master", "isMasterRef": true, "label": "Master", "ref": "YFcpYxAAACMAfZH_"}], "tags": ["Mindset", "Work", "Fuel", "Body", "Fitness", "Connections", "B4-3", "SkinCheck3", "Relationship", "Finances", "Home", "remote", "W2", "Recipes", "M4", "Conections", "C2-1", "Family", "Carers", "month1", "Diet-Goal", "goals", "fuel", "mindset", "M7", "C5", "M5", "M9", "F5-1", "W3", "Learning-Goals", "C5-3", "M7-3", "BestU", "Connections ", "C5-2", "stopbreathe", "Travel", "Social-Life-Goals", "goal", "Creative-Goals", "Goals", "connections", "Lifestyle-Goals", "Financial-Goals", "StressManagement-Goals", "Exercise-Goal", "Mndset", "workinhibits3", "F7-3", "C1-3", "socialrelationships2", "c4-2", "M11-3", "findmake", "c1-2", "M11-2", "F2-3", "veg3", "veg1", "F2-1", "C5-1", "Find5", "sedentary2", "B1-2", "WorkInhibits1", "F7-1", "socialrelationships1", "c4-1", "sedentary1", "B1-1", "veg2", "F2-2", "5ll2", "C6-2", "F7-2", "workinhibits2", "cfitness2", "FI3-2", "FVigorous3", "cfitness3", "FI3-3", "F3-1", "fruit1", "selflove", "M1-2", "workplacestress2", "W5-1", "Physically2", "FI2-2", "Sedentary3", "B1-3", "fgoals1", "FI4-1", "5ll3", "C6-3", "fruit2", "F3-2", "teamwork2", "W1-2", "c1-1", "commplan", "F3-3", "fruit3", "gym2", "FI5-2", "water2", "F1-2", "sleep2", "B3-2", "F4-1", "sugar1", "F1-1", "water1", "dailylift", "M2-2", "sugar3", "F4-3", "activelistening", "M3-1", "yourwhy", "justbreathe", "M2-1", "sugar2", "F4-2", "water3", "F1-3", "work", "W4-1", "WorkplaceRecognition1", "B8-1", "Alcohol1", "FI2-3", "Physically3", "W5-3", "WorkplaceStress3", "FI4-3", "FGoals3", "5LL1", "W4-3", "WorkplaceRecognition3", "TeamOpinion2", "W6-2", "M7-1", "Smoke1", "M9-1", "HelpPointers", "cfitness1", "FI3-1", "socialrelationships3", "c4-3", "unhealthy1", "F5-3", "unhealthy3", "M8-3", "F6-2", "unhealthy2", "fgoals2", "FI4-2", "attitudeforgratitude", "M3-3", "energy1", "B10-1", "M4-2", "thoughtpatterns", "currentd1", "F6-1", "F6-3", "CurrentD3", "meditation", "physically1", "FI2-1", "meditation-Financial Abundance", "FVigorous2", "SkinCheck1", "SkinCheck2", "B4-1", "B4-2", "Focus", "Streaks", "Milestones", "Trophies", "Meditations"], "types": {"7_day_program": "7 Day Program", "achievement": "achievement", "article": "article", "blog": "blog", "contentcategory": "contentcategory", "courses": "courses", "dailyquote": "dailyquote", "dashboard-content": "dashboard-content", "dashboardbanner": "dashboardbanner", "footer": "footer", "goalcategories": "goalcategories", "goals": "goals", "header": "header", "lessons": "lessons", "meditation": "meditation", "mental_health_disclaimer": "Policies and Disclaimers", "pages": "pages", "posts": "posts", "privacy_policy": "Privacy Policy", "product": "product", "program": "program", "questionnaire": "questionnaire", "quiz-ta": "quiz-tag", "quiz-tag": "quiz-tag", "quotes": "quotes", "reminders": "reminders", "results-explainer-1": "results-explainer-1", "results-explainer-2": "results-explainer-2", "section-banner": "section-banner", "sidemenu": "sidemenu", "sub-section": "sub-section", "test-ctype": "test-ctype", "thanks": "thanks", "topic": "topics", "your_results_1": "Your Results 1", "your_wellbeing_results_2": "Your Results 2"}, "version": "fbb44a3"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"bookmarks": {"type": "object"}, "experiments": {"type": "object", "properties": {"draft": {"type": "array"}, "running": {"type": "array"}}, "required": ["draft", "running"]}, "forms": {"type": "object", "properties": {"everything": {"type": "object", "properties": {"action": {"type": "string"}, "enctype": {"type": "string"}, "fields": {"type": "object", "properties": {"access_token": {"type": "object", "properties": {"default": {"type": "string"}, "multiple": {"type": "boolean"}, "type": {"type": "string"}}, "required": ["default", "multiple", "type"]}, "after": {"type": "object", "properties": {"multiple": {"type": "boolean"}, "type": {"type": "string"}}, "required": ["multiple", "type"]}, "fetch": {"type": "object", "properties": {"multiple": {"type": "boolean"}, "type": {"type": "string"}}, "required": ["multiple", "type"]}, "fetchLinks": {"type": "object", "properties": {"multiple": {"type": "boolean"}, "type": {"type": "string"}}, "required": ["multiple", "type"]}, "graphQuery": {"type": "object", "properties": {"multiple": {"type": "boolean"}, "type": {"type": "string"}}, "required": ["multiple", "type"]}, "lang": {"type": "object", "properties": {"multiple": {"type": "boolean"}, "type": {"type": "string"}}, "required": ["multiple", "type"]}, "orderings": {"type": "object", "properties": {"multiple": {"type": "boolean"}, "type": {"type": "string"}}, "required": ["multiple", "type"]}, "page": {"type": "object", "properties": {"default": {"type": "string"}, "multiple": {"type": "boolean"}, "type": {"type": "string"}}, "required": ["default", "multiple", "type"]}, "pageSize": {"type": "object", "properties": {"default": {"type": "string"}, "multiple": {"type": "boolean"}, "type": {"type": "string"}}, "required": ["default", "multiple", "type"]}, "q": {"type": "object", "properties": {"multiple": {"type": "boolean"}, "type": {"type": "string"}}, "required": ["multiple", "type"]}, "ref": {"type": "object", "properties": {"multiple": {"type": "boolean"}, "type": {"type": "string"}}, "required": ["multiple", "type"]}, "referer": {"type": "object", "properties": {"multiple": {"type": "boolean"}, "type": {"type": "string"}}, "required": ["multiple", "type"]}}, "required": ["access_token", "after", "fetch", "fetchLinks", "graphQuery", "lang", "orderings", "page", "pageSize", "q", "ref", "referer"]}, "method": {"type": "string"}}, "required": ["action", "enctype", "fields", "method"]}}, "required": ["everything"]}, "integrationFieldsRef": {"type": "null"}, "languages": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}}, "required": ["id", "name"]}}, "license": {"type": "string"}, "oauth_initiate": {"type": "string"}, "oauth_token": {"type": "string"}, "refs": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "isMasterRef": {"type": "boolean"}, "label": {"type": "string"}, "ref": {"type": "string"}}, "required": ["id", "isMasterRef", "label", "ref"]}}, "tags": {"type": "array", "items": {"type": "string"}}, "types": {"type": "object", "properties": {"7_day_program": {"type": "string"}, "achievement": {"type": "string"}, "article": {"type": "string"}, "blog": {"type": "string"}, "contentcategory": {"type": "string"}, "courses": {"type": "string"}, "dailyquote": {"type": "string"}, "dashboard-content": {"type": "string"}, "dashboardbanner": {"type": "string"}, "footer": {"type": "string"}, "goalcategories": {"type": "string"}, "goals": {"type": "string"}, "header": {"type": "string"}, "lessons": {"type": "string"}, "meditation": {"type": "string"}, "mental_health_disclaimer": {"type": "string"}, "pages": {"type": "string"}, "posts": {"type": "string"}, "privacy_policy": {"type": "string"}, "product": {"type": "string"}, "program": {"type": "string"}, "questionnaire": {"type": "string"}, "quiz-ta": {"type": "string"}, "quiz-tag": {"type": "string"}, "quotes": {"type": "string"}, "reminders": {"type": "string"}, "results-explainer-1": {"type": "string"}, "results-explainer-2": {"type": "string"}, "section-banner": {"type": "string"}, "sidemenu": {"type": "string"}, "sub-section": {"type": "string"}, "test-ctype": {"type": "string"}, "thanks": {"type": "string"}, "topic": {"type": "string"}, "your_results_1": {"type": "string"}, "your_wellbeing_results_2": {"type": "string"}}, "required": ["7_day_program", "achievement", "article", "blog", "contentcategory", "courses", "dailyquote", "dashboard-content", "dashboardbanner", "footer", "goalcategories", "goals", "header", "lessons", "meditation", "mental_health_disclaimer", "pages", "posts", "privacy_policy", "product", "program", "questionnaire", "quiz-ta", "quiz-tag", "quotes", "reminders", "results-explainer-1", "results-explainer-2", "section-banner", "sidemenu", "sub-section", "test-ctype", "thanks", "topic", "your_results_1", "your_wellbeing_results_2"]}, "version": {"type": "string"}}, "required": ["bookmarks", "experiments", "forms", "integrationFieldsRef", "languages", "license", "oauth_initiate", "oauth_token", "refs", "tags", "types", "version"]}
af6ee38a-59d6-4f54-9d13-ffba7764e5c7/c719d9dc-fbe7-40ba-bdca-f4fb1056f608/0/0
ExerciseDB
The ExerciseDB gives you access to over 1300 exercises with individual exercise data and animated demonstrations. Please visit https://v2.exercisedb.io/docs for full API documentation. For purchase options visit https://www.exercisedb.io/ Backend status page https://status.exercisedb.io/
9.8
/status
200
null
{"success": true}
{"type": "object", "properties": {"success": {"type": "boolean"}}}
af6ee38a-59d6-4f54-9d13-ffba7764e5c7/8ae18d70-75aa-4164-b4ef-0afde01402c2/0/0
ExerciseDB
The ExerciseDB gives you access to over 1300 exercises with individual exercise data and animated demonstrations. Please visit https://v2.exercisedb.io/docs for full API documentation. For purchase options visit https://www.exercisedb.io/ Backend status page https://status.exercisedb.io/
9.8
/exercises/bodyPart/{bodyPart}
Return list of exercises based on body part
200
null
[{"bodyPart": "", "equipment": "", "gifUrl": "", "id": "", "name": "", "target": "", "secondaryMuscles": [], "instructions": []}]
{"type": "array", "items": {"type": "object", "properties": {"bodyPart": {"type": "string"}, "equipment": {"type": "string"}, "gifUrl": {"type": "string"}, "id": {"type": "string"}, "name": {"type": "string"}, "target": {"type": "string"}, "secondaryMuscles": {"type": "array", "items": {"type": "string"}}, "instructions": {"type": "array", "items": {"type": "string"}}}, "required": ["bodyPart", "equipment", "gifUrl", "id", "name", "target", "secondaryMuscles", "instructions"]}}
af6ee38a-59d6-4f54-9d13-ffba7764e5c7/9165f1c8-3066-40ed-8ca1-c66c9118db89/0/0
ExerciseDB
The ExerciseDB gives you access to over 1300 exercises with individual exercise data and animated demonstrations. Please visit https://v2.exercisedb.io/docs for full API documentation. For purchase options visit https://www.exercisedb.io/ Backend status page https://status.exercisedb.io/
9.8
/exercises/equipment/{type}
Return list of exercises based on equipment type
200
null
[{"bodyPart": "", "equipment": "", "gifUrl": "", "id": "", "name": "", "target": "", "secondaryMuscles": [], "instructions": []}]
{"type": "array", "items": {"type": "object", "properties": {"bodyPart": {"type": "string"}, "equipment": {"type": "string"}, "gifUrl": {"type": "string"}, "id": {"type": "string"}, "name": {"type": "string"}, "target": {"type": "string"}, "secondaryMuscles": {"type": "array", "items": {"type": "string"}}, "instructions": {"type": "array", "items": {"type": "string"}}}, "required": ["bodyPart", "equipment", "gifUrl", "id", "name", "target", "secondaryMuscles", "instructions"]}}
af6ee38a-59d6-4f54-9d13-ffba7764e5c7/05d7a0a9-d8db-43fc-9258-c6e9d5e102c4/0/0
ExerciseDB
The ExerciseDB gives you access to over 1300 exercises with individual exercise data and animated demonstrations. Please visit https://v2.exercisedb.io/docs for full API documentation. For purchase options visit https://www.exercisedb.io/ Backend status page https://status.exercisedb.io/
9.8
/exercises/target/{target}
Return list of exercises by target muscle
200
null
[{"bodyPart": "", "equipment": "", "gifUrl": "", "id": "", "name": "", "target": "", "secondaryMuscles": [], "instructions": []}]
{"type": "array", "items": {"type": "object", "properties": {"bodyPart": {"type": "string"}, "equipment": {"type": "string"}, "gifUrl": {"type": "string"}, "id": {"type": "string"}, "name": {"type": "string"}, "target": {"type": "string"}, "secondaryMuscles": {"type": "array", "items": {"type": "string"}}, "instructions": {"type": "array", "items": {"type": "string"}}}, "required": ["bodyPart", "equipment", "gifUrl", "id", "name", "target", "secondaryMuscles", "instructions"]}}
af6ee38a-59d6-4f54-9d13-ffba7764e5c7/a4034d70-d2c1-4c90-afbe-b3c1abf70c28/0/0
ExerciseDB
The ExerciseDB gives you access to over 1300 exercises with individual exercise data and animated demonstrations. Please visit https://v2.exercisedb.io/docs for full API documentation. For purchase options visit https://www.exercisedb.io/ Backend status page https://status.exercisedb.io/
9.8
/exercises/exercise/{id}
Return an exercise by it's id
200
null
{"bodyPart": "", "equipment": "", "gifUrl": "", "id": "", "name": "", "target": "", "secondaryMuscles": [], "instructions": []}
{"type": "object", "properties": {"bodyPart": {"type": "string"}, "equipment": {"type": "string"}, "gifUrl": {"type": "string"}, "id": {"type": "string"}, "name": {"type": "string"}, "target": {"type": "string"}, "secondaryMuscles": {"type": "array", "items": {"type": "string"}}, "instructions": {"type": "array", "items": {"type": "string"}}}, "required": ["bodyPart", "equipment", "gifUrl", "id", "name", "target", "secondaryMuscles", "instructions"]}
af6ee38a-59d6-4f54-9d13-ffba7764e5c7/e2b389b7-c39c-453b-8fbb-c141c74848fd/0/0
ExerciseDB
The ExerciseDB gives you access to over 1300 exercises with individual exercise data and animated demonstrations. Please visit https://v2.exercisedb.io/docs for full API documentation. For purchase options visit https://www.exercisedb.io/ Backend status page https://status.exercisedb.io/
9.8
/exercises/name/{name}
Return list of exercises by name
200
null
[{"bodyPart": "", "equipment": "", "gifUrl": "", "id": "", "name": "", "target": "", "secondaryMuscles": [], "instructions": []}]
{"type": "array", "items": {"type": "object", "properties": {"bodyPart": {"type": "string"}, "equipment": {"type": "string"}, "gifUrl": {"type": "string"}, "id": {"type": "string"}, "name": {"type": "string"}, "target": {"type": "string"}, "secondaryMuscles": {"type": "array", "items": {"type": "string"}}, "instructions": {"type": "array", "items": {"type": "string"}}}, "required": ["bodyPart", "equipment", "gifUrl", "id", "name", "target", "secondaryMuscles", "instructions"]}}
af6ee38a-59d6-4f54-9d13-ffba7764e5c7/469311fa-a2c7-4541-9e6d-c7432e546f19/0/0
ExerciseDB
The ExerciseDB gives you access to over 1300 exercises with individual exercise data and animated demonstrations. Please visit https://v2.exercisedb.io/docs for full API documentation. For purchase options visit https://www.exercisedb.io/ Backend status page https://status.exercisedb.io/
9.8
/exercises
Return list of all exercises
200
null
[{"bodyPart": "", "equipment": "", "gifUrl": "", "id": "", "name": "", "target": "", "secondaryMuscles": [], "instructions": []}]
{"type": "array", "items": {"type": "object", "properties": {"bodyPart": {"type": "string"}, "equipment": {"type": "string"}, "gifUrl": {"type": "string"}, "id": {"type": "string"}, "name": {"type": "string"}, "target": {"type": "string"}, "secondaryMuscles": {"type": "array", "items": {"type": "string"}}, "instructions": {"type": "array", "items": {"type": "string"}}}, "required": ["bodyPart", "equipment", "gifUrl", "id", "name", "target", "secondaryMuscles", "instructions"]}}
d258f8ed-8eb0-46d3-b0f4-0b17d324ceaf/3a2d30cc-bdaf-4ffe-90e8-565f5f742fdc/0/0
Body Mass Index (BMI) Calculator
Use this API to calculate the Body Mass Index of an individual based on their height and weight.
9.3
Metric [Kilograms]
This endpoint will calculate the BMI of an individual using the imperial measurement system.
200
Response
{"bmi": 44.790826838663435, "height": "1.83", "weight": "150", "weightCategory": ""}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"bmi": {"type": "number"}, "height": {"type": "string"}, "weight": {"type": "string"}, "weightCategory": {"type": "string"}}, "required": ["bmi", "height", "weight", "weightCategory"]}
d258f8ed-8eb0-46d3-b0f4-0b17d324ceaf/d4b98b5c-629d-4c47-a9e4-f499c9064305/0/0
Body Mass Index (BMI) Calculator
Use this API to calculate the Body Mass Index of an individual based on their height and weight.
9.3
Imperial [Pounds]
This endpoint will calculate the BMI of an individual using the imperial measurement system.
200
Response
{"bmi": 22.80493079584775, "height": "68", "weight": "150", "weightCategory": ""}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"bmi": {"type": "number"}, "height": {"type": "string"}, "weight": {"type": "string"}, "weightCategory": {"type": "string"}}, "required": ["bmi", "height", "weight", "weightCategory"]}
d258f8ed-8eb0-46d3-b0f4-0b17d324ceaf/febca87e-30ce-4f0b-be87-9b9d7ce8a281/0/0
Body Mass Index (BMI) Calculator
Use this API to calculate the Body Mass Index of an individual based on their height and weight.
9.3
Weight Category
Retrieve the weight category of an individual based on their BMI
200
Response
{"bmi": "19.2", "weightCategory": "Normal Weight"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"bmi": {"type": "string"}, "weightCategory": {"type": "string"}}, "required": ["bmi", "weightCategory"]}
67ab9653-0c72-4d12-9e62-7e5210c327bc/830fd0a0-1a3a-4e17-842d-a18e7d8877c9/0/0
Fitness Content
Provide interactive health, wellness and fitness video content in any type of apps or digital products using the Hyperhuman API.
7.3
getWorkoutExercises
401
null
{"error": {"code": "", "message": "", "target": "", "details": [{"code": "", "message": "", "target": ""}]}}
{"type": "object", "properties": {"error": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}, "target": {"type": "string"}, "details": {"type": "array", "items": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}, "target": {"type": "string"}}, "required": ["code", "message"]}}}, "required": ["code", "message"]}}, "required": ["error"]}
67ab9653-0c72-4d12-9e62-7e5210c327bc/830fd0a0-1a3a-4e17-842d-a18e7d8877c9/1/0
Fitness Content
Provide interactive health, wellness and fitness video content in any type of apps or digital products using the Hyperhuman API.
7.3
getWorkoutExercises
200
null
{"links": {"next": "https://api.hyperhuman.cc/resource/?limit=10&offset=10"}, "data": [{"id": "", "createdAt": "", "trainer": {"id": "", "name": ""}, "name": "", "kind": "single-exercise", "playsInLoop": true, "muscleGroups": [{"id": "", "name": ""}], "equipment": [{"id": "", "name": ""}], "audio": [{"url": ""}], "preview": {"url": "", "poster": "", "thumbnail": "", "loop": 0}}]}
{"type": "object", "properties": {"links": {"description": "Pagination links", "allOf": [{"type": "object", "properties": {"next": {"type": "string", "description": "URL of the next page. Missing if there is no next page."}}}]}, "data": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "createdAt": {"format": "date-time", "type": "string"}, "trainer": {"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}}, "required": ["id", "name"]}, "name": {"type": "string"}, "kind": {"type": "string", "enum": ["single-exercise", "multi-exercise", "class", "promo", "educational"]}, "playsInLoop": {"type": "boolean"}, "muscleGroups": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}}, "required": ["id", "name"]}}, "equipment": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}}, "required": ["id", "name"]}}, "audio": {"type": "array", "items": {"type": "object", "properties": {"url": {"type": "string"}}, "required": ["url"]}}, "preview": {"description": "Preview video stream", "allOf": [{"type": "object", "properties": {"url": {"type": "string"}, "poster": {"type": "string", "description": "URL of the poster image."}, "thumbnail": {"type": "string", "description": "URL of the video thumbnail."}, "loop": {"type": "number", "description": "Number of times the stream shall be looped.\nLoop 0 means no loop, loop -1 means infinite loop."}}, "required": ["url"]}]}}, "required": ["id", "createdAt", "trainer", "name", "kind", "playsInLoop", "muscleGroups", "equipment", "audio"]}}}, "required": ["links", "data"]}
67ab9653-0c72-4d12-9e62-7e5210c327bc/5277e670-61d9-4974-ac14-e256c259ef0c/0/0
Fitness Content
Provide interactive health, wellness and fitness video content in any type of apps or digital products using the Hyperhuman API.
7.3
getTrendingTrainers
200
null
{"data": {"id": "", "name": "", "profileImage": {"url": "", "thumbnail": ""}, "organization": {"id": "", "name": "", "logo": {"url": "", "thumbnail": ""}}}}
{"type": "object", "properties": {"data": {"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "profileImage": {"type": "object", "properties": {"url": {"type": "string"}, "thumbnail": {"type": "string", "description": "URL of the small (thumbnail) version."}}, "required": ["url"]}, "organization": {"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "logo": {"type": "object", "properties": {"url": {"type": "string"}, "thumbnail": {"type": "string", "description": "URL of the small (thumbnail) version."}}, "required": ["url"]}}, "required": ["id", "name"]}}, "required": ["id", "name"]}}, "required": ["data"]}
67ab9653-0c72-4d12-9e62-7e5210c327bc/5277e670-61d9-4974-ac14-e256c259ef0c/1/0
Fitness Content
Provide interactive health, wellness and fitness video content in any type of apps or digital products using the Hyperhuman API.
7.3
getTrendingTrainers
401
null
{"error": {"code": "", "message": "", "target": "", "details": [{"code": "", "message": "", "target": ""}]}}
{"type": "object", "properties": {"error": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}, "target": {"type": "string"}, "details": {"type": "array", "items": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}, "target": {"type": "string"}}, "required": ["code", "message"]}}}, "required": ["code", "message"]}}, "required": ["error"]}
67ab9653-0c72-4d12-9e62-7e5210c327bc/5692d158-c823-47eb-b13e-3e90534a9970/0/0
Fitness Content
Provide interactive health, wellness and fitness video content in any type of apps or digital products using the Hyperhuman API.
7.3
startWorkoutSession
401
null
{"error": {"code": "", "message": "", "target": "", "details": [{"code": "", "message": "", "target": ""}]}}
{"type": "object", "properties": {"error": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}, "target": {"type": "string"}, "details": {"type": "array", "items": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}, "target": {"type": "string"}}, "required": ["code", "message"]}}}, "required": ["code", "message"]}}, "required": ["error"]}
67ab9653-0c72-4d12-9e62-7e5210c327bc/5692d158-c823-47eb-b13e-3e90534a9970/1/0
Fitness Content
Provide interactive health, wellness and fitness video content in any type of apps or digital products using the Hyperhuman API.
7.3
startWorkoutSession
200
null
{"data": {"id": "", "createdAt": "", "updatedAt": "", "workoutId": "", "workoutSegmentId": ""}}
{"type": "object", "properties": {"data": {"type": "object", "properties": {"id": {"type": "string"}, "createdAt": {"format": "date-time", "type": "string"}, "updatedAt": {"format": "date-time", "type": "string"}, "workoutId": {"type": "string"}, "workoutSegmentId": {"type": "string", "description": "Current workout segment viewed by the user"}}, "required": ["id", "createdAt", "updatedAt", "workoutId", "workoutSegmentId"]}}, "required": ["data"]}
67ab9653-0c72-4d12-9e62-7e5210c327bc/8d9bb01d-1b75-4d61-a104-a34b932b2a5d/0/0
Fitness Content
Provide interactive health, wellness and fitness video content in any type of apps or digital products using the Hyperhuman API.
7.3
getRecentWorkoutSession
401
null
{"error": {"code": "", "message": "", "target": "", "details": [{"code": "", "message": "", "target": ""}]}}
{"type": "object", "properties": {"error": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}, "target": {"type": "string"}, "details": {"type": "array", "items": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}, "target": {"type": "string"}}, "required": ["code", "message"]}}}, "required": ["code", "message"]}}, "required": ["error"]}
67ab9653-0c72-4d12-9e62-7e5210c327bc/8d9bb01d-1b75-4d61-a104-a34b932b2a5d/1/0
Fitness Content
Provide interactive health, wellness and fitness video content in any type of apps or digital products using the Hyperhuman API.
7.3
getRecentWorkoutSession
200
null
{"data": {"id": "", "createdAt": "", "updatedAt": "", "workoutId": "", "workoutSegmentId": ""}}
{"type": "object", "properties": {"data": {"type": "object", "properties": {"id": {"type": "string"}, "createdAt": {"format": "date-time", "type": "string"}, "updatedAt": {"format": "date-time", "type": "string"}, "workoutId": {"type": "string"}, "workoutSegmentId": {"type": "string", "description": "Current workout segment viewed by the user"}}, "required": ["id", "createdAt", "updatedAt", "workoutId", "workoutSegmentId"]}}, "required": ["data"]}
67ab9653-0c72-4d12-9e62-7e5210c327bc/570e1353-196e-45f2-845f-891f71b3a63b/0/0
Fitness Content
Provide interactive health, wellness and fitness video content in any type of apps or digital products using the Hyperhuman API.
7.3
getFeaturedTrainers
200
null
{"data": {"id": "", "name": "", "profileImage": {"url": "", "thumbnail": ""}, "organization": {"id": "", "name": "", "logo": {"url": "", "thumbnail": ""}}}}
{"type": "object", "properties": {"data": {"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "profileImage": {"type": "object", "properties": {"url": {"type": "string"}, "thumbnail": {"type": "string", "description": "URL of the small (thumbnail) version."}}, "required": ["url"]}, "organization": {"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "logo": {"type": "object", "properties": {"url": {"type": "string"}, "thumbnail": {"type": "string", "description": "URL of the small (thumbnail) version."}}, "required": ["url"]}}, "required": ["id", "name"]}}, "required": ["id", "name"]}}, "required": ["data"]}
67ab9653-0c72-4d12-9e62-7e5210c327bc/570e1353-196e-45f2-845f-891f71b3a63b/1/0
Fitness Content
Provide interactive health, wellness and fitness video content in any type of apps or digital products using the Hyperhuman API.
7.3
getFeaturedTrainers
401
null
{"error": {"code": "", "message": "", "target": "", "details": [{"code": "", "message": "", "target": ""}]}}
{"type": "object", "properties": {"error": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}, "target": {"type": "string"}, "details": {"type": "array", "items": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}, "target": {"type": "string"}}, "required": ["code", "message"]}}}, "required": ["code", "message"]}}, "required": ["error"]}
67ab9653-0c72-4d12-9e62-7e5210c327bc/8190390a-0d7d-4d7a-bc8a-3ec4a0e2cf07/0/0
Fitness Content
Provide interactive health, wellness and fitness video content in any type of apps or digital products using the Hyperhuman API.
7.3
patchWorkoutSession
200
null
{"data": {"id": "", "createdAt": "", "updatedAt": "", "workoutId": "", "workoutSegmentId": ""}}
{"type": "object", "properties": {"data": {"type": "object", "properties": {"id": {"type": "string"}, "createdAt": {"format": "date-time", "type": "string"}, "updatedAt": {"format": "date-time", "type": "string"}, "workoutId": {"type": "string"}, "workoutSegmentId": {"type": "string", "description": "Current workout segment viewed by the user"}}, "required": ["id", "createdAt", "updatedAt", "workoutId", "workoutSegmentId"]}}, "required": ["data"]}
67ab9653-0c72-4d12-9e62-7e5210c327bc/8190390a-0d7d-4d7a-bc8a-3ec4a0e2cf07/1/0
Fitness Content
Provide interactive health, wellness and fitness video content in any type of apps or digital products using the Hyperhuman API.
7.3
patchWorkoutSession
401
null
{"error": {"code": "", "message": "", "target": "", "details": [{"code": "", "message": "", "target": ""}]}}
{"type": "object", "properties": {"error": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}, "target": {"type": "string"}, "details": {"type": "array", "items": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}, "target": {"type": "string"}}, "required": ["code", "message"]}}}, "required": ["code", "message"]}}, "required": ["error"]}
67ab9653-0c72-4d12-9e62-7e5210c327bc/42c9cb8c-8837-46c6-920e-4d0d84080e32/0/0
Fitness Content
Provide interactive health, wellness and fitness video content in any type of apps or digital products using the Hyperhuman API.
7.3
getTrainer
401
null
{"error": {"code": "", "message": "", "target": "", "details": [{"code": "", "message": "", "target": ""}]}}
{"type": "object", "properties": {"error": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}, "target": {"type": "string"}, "details": {"type": "array", "items": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}, "target": {"type": "string"}}, "required": ["code", "message"]}}}, "required": ["code", "message"]}}, "required": ["error"]}
67ab9653-0c72-4d12-9e62-7e5210c327bc/42c9cb8c-8837-46c6-920e-4d0d84080e32/1/0
Fitness Content
Provide interactive health, wellness and fitness video content in any type of apps or digital products using the Hyperhuman API.
7.3
getTrainer
200
null
{"data": {"id": "", "name": "", "profileImage": {"url": "", "thumbnail": ""}, "organization": {"id": "", "name": "", "logo": {"url": "", "thumbnail": ""}}}}
{"type": "object", "properties": {"data": {"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "profileImage": {"type": "object", "properties": {"url": {"type": "string"}, "thumbnail": {"type": "string", "description": "URL of the small (thumbnail) version."}}, "required": ["url"]}, "organization": {"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "logo": {"type": "object", "properties": {"url": {"type": "string"}, "thumbnail": {"type": "string", "description": "URL of the small (thumbnail) version."}}, "required": ["url"]}}, "required": ["id", "name"]}}, "required": ["id", "name"]}}, "required": ["data"]}
67ab9653-0c72-4d12-9e62-7e5210c327bc/da50c6d7-d9e6-4614-83e6-faa36fb08511/0/0
Fitness Content
Provide interactive health, wellness and fitness video content in any type of apps or digital products using the Hyperhuman API.
7.3
getWorkoutFeedbackOptions
200
null
{"data": {"rating": [{"id": "", "label": "", "value": 0}], "difficulty": [{"id": "", "label": "", "value": 0}]}}
{"type": "object", "properties": {"data": {"type": "object", "properties": {"rating": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "label": {"type": "string"}, "value": {"type": "number"}}, "required": ["id", "label", "value"]}}, "difficulty": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "label": {"type": "string"}, "value": {"type": "number"}}, "required": ["id", "label", "value"]}}}, "required": ["rating", "difficulty"]}}, "required": ["data"]}
67ab9653-0c72-4d12-9e62-7e5210c327bc/da50c6d7-d9e6-4614-83e6-faa36fb08511/1/0
Fitness Content
Provide interactive health, wellness and fitness video content in any type of apps or digital products using the Hyperhuman API.
7.3
getWorkoutFeedbackOptions
401
null
{"error": {"code": "", "message": "", "target": "", "details": [{"code": "", "message": "", "target": ""}]}}
{"type": "object", "properties": {"error": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}, "target": {"type": "string"}, "details": {"type": "array", "items": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}, "target": {"type": "string"}}, "required": ["code", "message"]}}}, "required": ["code", "message"]}}, "required": ["error"]}
67ab9653-0c72-4d12-9e62-7e5210c327bc/5a601899-6e2e-49de-8c1d-e2c9b8f03859/0/0
Fitness Content
Provide interactive health, wellness and fitness video content in any type of apps or digital products using the Hyperhuman API.
7.3
getPlan
401
null
{"error": {"code": "", "message": "", "target": "", "details": [{"code": "", "message": "", "target": ""}]}}
{"type": "object", "properties": {"error": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}, "target": {"type": "string"}, "details": {"type": "array", "items": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}, "target": {"type": "string"}}, "required": ["code", "message"]}}}, "required": ["code", "message"]}}, "required": ["error"]}
67ab9653-0c72-4d12-9e62-7e5210c327bc/5a601899-6e2e-49de-8c1d-e2c9b8f03859/1/0
Fitness Content
Provide interactive health, wellness and fitness video content in any type of apps or digital products using the Hyperhuman API.
7.3
getPlan
200
null
{"data": {"id": "", "createdAt": "", "updatedAt": "", "trainer": {"id": "", "name": ""}, "name": "", "description": "", "duration": 0, "difficulty": "beginner", "preview": {"url": "", "poster": "", "thumbnail": "", "loop": 0}, "rating": 0, "locked": true, "categories": [{"id": "", "name": ""}], "equipment": [{"id": "", "name": ""}], "musicPlaylists": {"spotify": {"url": ""}, "youtube": {"url": ""}, "appleMusic": {"url": ""}, "amazonMusic": {"url": ""}}, "shareLink": {"url": ""}, "organization": {"id": "", "name": "", "logo": {"url": "", "thumbnail": ""}}}}
{"type": "object", "properties": {"data": {"type": "object", "properties": {"id": {"type": "string"}, "createdAt": {"format": "date-time", "type": "string"}, "updatedAt": {"format": "date-time", "type": "string"}, "trainer": {"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}}, "required": ["id", "name"]}, "name": {"type": "string"}, "description": {"type": "string"}, "duration": {"type": "number", "description": "Workout duration (in seconds)"}, "difficulty": {"type": "string", "enum": ["beginner", "intermediate", "advanced"]}, "preview": {"description": "Preview video stream", "allOf": [{"type": "object", "properties": {"url": {"type": "string"}, "poster": {"type": "string", "description": "URL of the poster image."}, "thumbnail": {"type": "string", "description": "URL of the video thumbnail."}, "loop": {"type": "number", "description": "Number of times the stream shall be looped.\nLoop 0 means no loop, loop -1 means infinite loop."}}, "required": ["url"]}]}, "rating": {"type": "number"}, "locked": {"type": "boolean"}, "categories": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}}, "required": ["id", "name"]}}, "equipment": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}}, "required": ["id", "name"]}}, "musicPlaylists": {"description": "Music playlists", "allOf": [{"type": "object", "properties": {"spotify": {"description": "Spotify music playlist", "allOf": [{"type": "object", "properties": {"url": {"type": "string"}}, "required": ["url"]}]}, "youtube": {"description": "Youtube music playlist", "allOf": [{"type": "object", "properties": {"url": {"type": "string"}}, "required": ["url"]}]}, "appleMusic": {"description": "Apple Music playlist", "allOf": [{"type": "object", "properties": {"url": {"type": "string"}}, "required": ["url"]}]}, "amazonMusic": {"description": "Amazon Music playlist", "allOf": [{"type": "object", "properties": {"url": {"type": "string"}}, "required": ["url"]}]}}}]}, "shareLink": {"description": "Share link", "allOf": [{"type": "object", "properties": {"url": {"type": "string"}}, "required": ["url"]}]}, "organization": {"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "logo": {"type": "object", "properties": {"url": {"type": "string"}, "thumbnail": {"type": "string", "description": "URL of the small (thumbnail) version."}}, "required": ["url"]}}, "required": ["id", "name"]}}, "required": ["id", "createdAt", "updatedAt", "trainer", "name", "description", "duration", "locked", "categories", "equipment", "shareLink"]}}, "required": ["data"]}
67ab9653-0c72-4d12-9e62-7e5210c327bc/5aa96eca-ffcb-4e08-b6d7-e68a3267e587/0/0
Fitness Content
Provide interactive health, wellness and fitness video content in any type of apps or digital products using the Hyperhuman API.
7.3
submitWorkoutFeedback
401
null
{"error": {"code": "", "message": "", "target": "", "details": [{"code": "", "message": "", "target": ""}]}}
{"type": "object", "properties": {"error": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}, "target": {"type": "string"}, "details": {"type": "array", "items": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}, "target": {"type": "string"}}, "required": ["code", "message"]}}}, "required": ["code", "message"]}}, "required": ["error"]}
67ab9653-0c72-4d12-9e62-7e5210c327bc/5aa96eca-ffcb-4e08-b6d7-e68a3267e587/1/0
Fitness Content
Provide interactive health, wellness and fitness video content in any type of apps or digital products using the Hyperhuman API.
7.3
submitWorkoutFeedback
200
null
{"data": {"id": "", "createdAt": "", "updatedAt": "", "workoutId": "", "workoutSessionId": "", "rating": {"id": "", "label": "", "value": 0}, "difficulty": {"id": "", "label": "", "value": 0}, "comment": ""}}
{"type": "object", "properties": {"data": {"type": "object", "properties": {"id": {"type": "string"}, "createdAt": {"format": "date-time", "type": "string"}, "updatedAt": {"format": "date-time", "type": "string"}, "workoutId": {"type": "string"}, "workoutSessionId": {"type": "string"}, "rating": {"type": "object", "properties": {"id": {"type": "string"}, "label": {"type": "string"}, "value": {"type": "number"}}, "required": ["id", "label", "value"]}, "difficulty": {"type": "object", "properties": {"id": {"type": "string"}, "label": {"type": "string"}, "value": {"type": "number"}}, "required": ["id", "label", "value"]}, "comment": {"type": "string"}}, "required": ["id", "createdAt", "updatedAt", "workoutId", "workoutSessionId", "rating", "difficulty"]}}, "required": ["data"]}
67ab9653-0c72-4d12-9e62-7e5210c327bc/2c226a9c-d0e7-4be1-8878-f46f85517354/0/0
Fitness Content
Provide interactive health, wellness and fitness video content in any type of apps or digital products using the Hyperhuman API.
7.3
getWorkoutsByTrainerId
200
null
{"links": {"next": "https://api.hyperhuman.cc/resource/?limit=10&offset=10"}, "data": [{"id": "", "createdAt": "", "updatedAt": "", "trainer": {"id": "", "name": ""}, "name": "", "description": "", "duration": 0, "difficulty": "beginner", "preview": {"url": "", "poster": "", "thumbnail": "", "loop": 0}, "rating": 0, "locked": true, "categories": [{"id": "", "name": ""}]}]}
{"type": "object", "properties": {"links": {"description": "Pagination links", "allOf": [{"type": "object", "properties": {"next": {"type": "string", "description": "URL of the next page. Missing if there is no next page."}}}]}, "data": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "createdAt": {"format": "date-time", "type": "string"}, "updatedAt": {"format": "date-time", "type": "string"}, "trainer": {"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}}, "required": ["id", "name"]}, "name": {"type": "string"}, "description": {"type": "string"}, "duration": {"type": "number", "description": "Workout duration (in seconds)"}, "difficulty": {"type": "string", "enum": ["beginner", "intermediate", "advanced"]}, "preview": {"description": "Preview video stream", "allOf": [{"type": "object", "properties": {"url": {"type": "string"}, "poster": {"type": "string", "description": "URL of the poster image."}, "thumbnail": {"type": "string", "description": "URL of the video thumbnail."}, "loop": {"type": "number", "description": "Number of times the stream shall be looped.\nLoop 0 means no loop, loop -1 means infinite loop."}}, "required": ["url"]}]}, "rating": {"type": "number"}, "locked": {"type": "boolean"}, "categories": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}}, "required": ["id", "name"]}}}, "required": ["id", "createdAt", "updatedAt", "trainer", "name", "description", "duration", "locked", "categories"]}}}, "required": ["links", "data"]}
67ab9653-0c72-4d12-9e62-7e5210c327bc/2c226a9c-d0e7-4be1-8878-f46f85517354/1/0
Fitness Content
Provide interactive health, wellness and fitness video content in any type of apps or digital products using the Hyperhuman API.
7.3
getWorkoutsByTrainerId
401
null
{"error": {"code": "", "message": "", "target": "", "details": [{"code": "", "message": "", "target": ""}]}}
{"type": "object", "properties": {"error": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}, "target": {"type": "string"}, "details": {"type": "array", "items": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}, "target": {"type": "string"}}, "required": ["code", "message"]}}}, "required": ["code", "message"]}}, "required": ["error"]}
67ab9653-0c72-4d12-9e62-7e5210c327bc/8a9a26cc-ee3a-4bbd-afaf-5d06e4183d18/0/0
Fitness Content
Provide interactive health, wellness and fitness video content in any type of apps or digital products using the Hyperhuman API.
7.3
getPlanWorkouts
401
null
{"error": {"code": "", "message": "", "target": "", "details": [{"code": "", "message": "", "target": ""}]}}
{"type": "object", "properties": {"error": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}, "target": {"type": "string"}, "details": {"type": "array", "items": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}, "target": {"type": "string"}}, "required": ["code", "message"]}}}, "required": ["code", "message"]}}, "required": ["error"]}