Team Scope Requirements
Set Team Scope Requirements
- Home
- Wearables
- Lab Testing
- API Reference
- Event Catalog
- Changelog
- Users
- Debugging
- Orders
- Area Info
- At-home Phlebotomy
- Tests
- Results
- Health Insurance
- Sleep
- Meal
- Workouts
- Profile
- Activity
- Body
- Menstrual Cycle
- Vitals
- Body
- Activity
- Wellness
- Nutrition
- Team
- Member
- Invite
- Org
- Team API Keys
- Team Custom Credentials
- Team Data Pull Preferences
- Team ETL Pipeline
- Team Scope Requirements
Core
Lab Testing
Summary Data
Timeseries Data
Org Management
Team Scope Requirements
Set Team Scope Requirements
POST
/
v1
/
org
/
{org_id}
/
team
/
{team_id}
/
scope_requirements
X-Vital-Org-Key
string
*
X-Vital-Org-Key
Required
string
org_id
Org Id · string
*
org_id
Required
string
team_id
Team Id · string
*
team_id
Required
string
UpsertTeamScopeRequirementsBody · object
*
fitbit
TeamScopeRequirementsBase[FitbitScope] · object
fitbit
object
user_must_grant
array
*
user_must_grant
Required
array
user_may_grant
array
*
user_may_grant
Required
array
google_fit
TeamScopeRequirementsBase[GoogleFitScope] · object
google_fit
object
user_must_grant
array
*
user_must_grant
Required
array
user_may_grant
array
*
user_may_grant
Required
array
oura
TeamScopeRequirementsBase[OuraScope] · object
oura
object
user_must_grant
array
*
user_must_grant
Required
array
user_may_grant
array
*
user_may_grant
Required
array
strava
TeamScopeRequirementsBase[StravaScope] · object
strava
object
user_must_grant
array
*
user_must_grant
Required
array
user_may_grant
array
*
user_may_grant
Required
array
withings
TeamScopeRequirementsBase[WithingsScope] · object
withings
object
user_must_grant
array
*
user_must_grant
Required
array
user_may_grant
array
*
user_may_grant
Required
array
wahoo
TeamScopeRequirementsBase[WahooScope] · object
wahoo
object
user_must_grant
array
*
user_must_grant
Required
array
user_may_grant
array
*
user_may_grant
Required
array
whoop_v2
TeamScopeRequirementsBase[WhoopScope] · object
whoop_v2
object
user_must_grant
array
*
user_must_grant
Required
array
user_may_grant
array
*
user_may_grant
Required
array
Org Management API is available for the Scale plan.
The base URL of this endpoint is https://api.tryvital.io/management/
.
The endpoint accepts only Org Key (X-Vital-Org-Key
). Team API Key is not applicable.
Authorizations
X-Vital-Org-Key
string
headerrequiredPath Parameters
org_id
string
requiredteam_id
string
requiredBody
application/json
fitbit
object
fitbit.user_must_grant
enum<string>[]
requiredAvailable options:
heartrate
, oxygen_saturation
, cardio_fitness
, respiratory_rate
, activity
, location
, nutrition
, profile
, settings
, sleep
, social
, weight
, temperature
fitbit.user_may_grant
enum<string>[]
requiredAvailable options:
heartrate
, oxygen_saturation
, cardio_fitness
, respiratory_rate
, activity
, location
, nutrition
, profile
, settings
, sleep
, social
, weight
, temperature
google_fit
object
google_fit.user_must_grant
enum<string>[]
requiredAvailable options:
openid
, email
, https://www.googleapis.com/auth/fitness.activity.read
, https://www.googleapis.com/auth/fitness.body.read
, https://www.googleapis.com/auth/fitness.sleep.read
, https://www.googleapis.com/auth/fitness.blood_glucose.read
, https://www.googleapis.com/auth/fitness.blood_pressure.read
, https://www.googleapis.com/auth/fitness.heart_rate.read
, https://www.googleapis.com/auth/fitness.nutrition.read
, https://www.googleapis.com/auth/fitness.location.read
google_fit.user_may_grant
enum<string>[]
requiredAvailable options:
openid
, email
, https://www.googleapis.com/auth/fitness.activity.read
, https://www.googleapis.com/auth/fitness.body.read
, https://www.googleapis.com/auth/fitness.sleep.read
, https://www.googleapis.com/auth/fitness.blood_glucose.read
, https://www.googleapis.com/auth/fitness.blood_pressure.read
, https://www.googleapis.com/auth/fitness.heart_rate.read
, https://www.googleapis.com/auth/fitness.nutrition.read
, https://www.googleapis.com/auth/fitness.location.read
oura
object
oura.user_must_grant
enum<string>[]
requiredAvailable options:
email
, personal
, daily
, heartrate
, workout
, tag
, session
oura.user_may_grant
enum<string>[]
requiredAvailable options:
email
, personal
, daily
, heartrate
, workout
, tag
, session
strava
object
strava.user_must_grant
enum<string>[]
requiredAvailable options:
activity:read_all
, activity:write
, profile:write
, profile:read_all
strava.user_may_grant
enum<string>[]
requiredAvailable options:
activity:read_all
, activity:write
, profile:write
, profile:read_all
withings
object
withings.user_must_grant
enum<string>[]
requiredAvailable options:
user.activity
, user.metrics
, user.sleepevents
withings.user_may_grant
enum<string>[]
requiredAvailable options:
user.activity
, user.metrics
, user.sleepevents
wahoo
object
wahoo.user_must_grant
enum<string>[]
requiredAvailable options:
email
, user_read
, workouts_read
, offline_data
wahoo.user_may_grant
enum<string>[]
requiredAvailable options:
email
, user_read
, workouts_read
, offline_data
whoop_v2
object
whoop_v2.user_must_grant
enum<string>[]
requiredAvailable options:
read:recovery
, read:cycles
, read:workout
, read:sleep
, read:profile
, read:body_measurement
, offline
whoop_v2.user_may_grant
enum<string>[]
requiredAvailable options:
read:recovery
, read:cycles
, read:workout
, read:sleep
, read:profile
, read:body_measurement
, offline
Response
200 - application/json
The response is of type any
.