POST
/
v1
/
org
/
{org_id}
/
prepare_team_custom_credentials
/
{env}
/
{region}
curl --request GET \
  --url https://api.tryvital.io/management/v1/org/{org_id}/prepare_team_custom_credentials/{env}/{region} \
  --header 'X-Vital-Org-Key: <api-key>'

{
  "status": "no_action_needed",
  "preparation_steps": [
    {
      "type": "redirect_uri",
      "key": "<string>",
      "value": "<string>",
      "description": "<string>"
    }
  ]
}

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.

curl --request GET \
  --url https://api.tryvital.io/management/v1/org/{org_id}/prepare_team_custom_credentials/{env}/{region} \
  --header 'X-Vital-Org-Key: <api-key>'

Authorizations

​
X-Vital-Org-Key
string
header
required

Path Parameters

​
org_id
string
required
​
env
enum<string>
required
Available options:
production,
sandbox
​
region
enum<string>
required
Available options:
us,
eu

Body

application/json
​
team_id
string
required
​
provider
required
Available options:
oura,
fitbit,
garmin,
whoop,
strava,
renpho,
peloton,
wahoo,
zwift,
freestyle_libre,
abbott_libreview,
freestyle_libre_ble,
eight_sleep,
withings,
apple_health_kit,
manual,
ihealth,
google_fit,
beurer_api,
beurer_ble,
omron,
omron_ble,
onetouch_ble,
accuchek_ble,
contour_ble,
dexcom,
dexcom_v3,
hammerhead,
my_fitness_pal,
health_connect,
polar,
cronometer,
kardia,
whoop_v2,
ultrahuman,
my_fitness_pal_v2,
map_my_fitness

Response

200
application/json
Successful Response
​
status
enum<string>
required

no_action_needed

No preparation needs to be done. You can apply the custom credential using the Set Team Custom Credentials API right away.

preparations_required

You should configure your OAuth application in accordance to the preparation steps provided, before calling the Set Team Custom Credentials API to apply the custom credential to your team.

Available options:
no_action_needed,
preparations_required
​
preparation_steps
object[]

A list of steps which must be completed before applying the custom credential to your team through the Set Team Custom Credentials API.

Delete Team Custom CredentialsGet Team Data Pull Preferences