POST
/
v1
/
org
/
{org_id}
/
team_data_pull_preferences
/
{env}
/
{region}
curl --request POST \
  --url https://api.tryvital.io/management/v1/org/{org_id}/team_data_pull_preferences/{env}/{region} \
  --header 'X-Vital-Org-Key: <api-key>'
  --data '{
    "team_ids": [
        "<uuid>"
    ],
    "providers": {
        "oura": {
            "default": {
                "historical_days_to_pull": 120
            },
            "resource_overrides": {
                "sleep": {
                    "historical_days_to_pull": 180
                }
            }
        }
    }
}'

{
  "data_pull_preferences": [
    {
      "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "providers": {}
    }
  ],
  "next_cursor": "<string>"
}
Junction Management API is available for the Scale plan.
The base URL of this endpoint is https://api.tryvital.io/management/.The endpoint accepts only Management Key (X-Management-Key). Team API Key is not accepted.
curl --request POST \
  --url https://api.tryvital.io/management/v1/org/{org_id}/team_data_pull_preferences/{env}/{region} \
  --header 'X-Vital-Org-Key: <api-key>'
  --data '{
    "team_ids": [
        "<uuid>"
    ],
    "providers": {
        "oura": {
            "default": {
                "historical_days_to_pull": 120
            },
            "resource_overrides": {
                "sleep": {
                    "historical_days_to_pull": 180
                }
            }
        }
    }
}'
By setting a higher value, you acknowledge your awareness of the facts of API life that:
  1. historical pulls may take longer to complete;
  2. historical pulls may run into provider rate limiting; and
  3. regular data polling may consequentially be delayed as a knock-on effect.
Provider rate limiting typically happens at OAuth application level.Therefore, Vital recommends Bring Your Own OAuth if you want to set an extended historical pull range. This creates a rate limit quota dedicated to your Vital Team, not being shared with other Vital customers.
The Team Data Pull Preferences you specified is advisory. There are scenarios in which Vital systems may not adhere strictly to your stated preferences.

​
Supported Providers

ProviderDefaultConfigurableRemarks
Abbott LibreView90 days❌-
Fitbit90 days⚠️Activity and heartrate timeseries data are fixed to 14 days.
Garmin90 days✅-
Google Fit90 days✅-
Oura180 days✅-
Peloton180 days✅-
Strava14 days✅-
Wahoo180 days✅-
WHOOP180 days✅-
Zwift270 days✅-
Withings90 days✅-
8Sleep90 days✅-
Apple HealthKit (SDK)30 days✅-
Android Health Connect (SDK)30 days❌Google restricts access to historical data to 30 days before the first successful permission request.
Hammerhead30 days✅-
Dexcom30 days✅-
Dexcom (G6 And Older)1 day❌-
MyFitnessPal14 days✅-
Polar28 days❌Polar only supports historical backfill for Sleep and Sleep Stream resources.
Cronometer28 days✅-
The configurable maximum is 365 days at this time.

Authorizations

​
X-Management-Key
string
header
required

Path Parameters

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

Body

application/json

Response

200
application/json

Successful Response

The response is of type object.