Skip to main content
POST
/
v2
/
link
/
bulk_export
Bulk Export Connections
curl --request POST \
  --url https://api.tryvital.io/v2/link/bulk_export \
  --header 'Content-Type: application/json' \
  --header 'x-vital-api-key: <api-key>' \
  --data '{
  "user_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "provider": "oura",
  "next_token": "<string>"
}'
{
  "data": [
    {
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "access_token": "<string>",
      "refresh_token": "<string>",
      "provider_id": "<string>",
      "expires_at": 123,
      "oauth_scopes": [
        "<string>"
      ]
    }
  ],
  "next_token": "<string>"
}
If you are planning to migrate connections, please chat with us through support channels. Link Migration endpoints are disabled by default.
You should pause the connections before bulk exporting them. Pausing stops Vital systems from refreshing the connections, ensuring the exported data are most up-to-date.

Authorizations

​
x-vital-api-key
string
header
required

Vital Team API Key

Query Parameters

​
team_id
default:infer_from_context

Body

application/json
​
provider
enum<string>
required

ℹ️ This enum is non-exhaustive.

Available options:
oura,
fitbit,
garmin,
strava,
wahoo,
ihealth,
withings,
google_fit,
dexcom_v3,
polar,
cronometer,
omron,
whoop_v2,
my_fitness_pal_v2,
ultrahuman,
runkeeper
​
user_ids
string<uuid>[] | null
​
next_token
string | null

Response

Successful Response

​
data
ConnectionRecipe · object[]
required
​
next_token
string | null
required