curl --request GET \
--url {{BASE_URL}}/v2/user/providers/{user_id} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: API_KEY'
{
"providers": [
{
"name": "Fitbit",
"slug": "fitbit",
"logo": "https://example.com/fitbit.png",
"status": "connected",
"created_on": "2010-01-23T12:34:56+00:00",
"resource_availability": {
"body": {
"status": "available",
"scope_requirements": {
"user_granted": {
"required": [
"weight"
],
"optional": []
},
"user_denied": {
"required": [],
"optional": []
}
}
},
"sleep": {
"status": "unavailable",
"scope_requirements": {
"user_granted": {
"required": [],
"optional": []
},
"user_denied": {
"required": [
"sleep"
],
"optional": [
"heartrate",
"oxygen_saturation",
"respiratory_rate"
]
}
}
}
},
"error_details": null
}
]
}
GET Users connected providers
curl --request GET \
--url {{BASE_URL}}/v2/user/providers/{user_id} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: API_KEY'
{
"providers": [
{
"name": "Fitbit",
"slug": "fitbit",
"logo": "https://example.com/fitbit.png",
"status": "connected",
"created_on": "2010-01-23T12:34:56+00:00",
"resource_availability": {
"body": {
"status": "available",
"scope_requirements": {
"user_granted": {
"required": [
"weight"
],
"optional": []
},
"user_denied": {
"required": [],
"optional": []
}
}
},
"sleep": {
"status": "unavailable",
"scope_requirements": {
"user_granted": {
"required": [],
"optional": []
},
"user_denied": {
"required": [
"sleep"
],
"optional": [
"heartrate",
"oxygen_saturation",
"respiratory_rate"
]
}
}
}
},
"error_details": null
}
]
}
curl --request GET \
--url {{BASE_URL}}/v2/user/providers/{user_id} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: API_KEY'
{
"providers": [
{
"name": "Fitbit",
"slug": "fitbit",
"logo": "https://example.com/fitbit.png",
"status": "connected",
"created_on": "2010-01-23T12:34:56+00:00",
"resource_availability": {
"body": {
"status": "available",
"scope_requirements": {
"user_granted": {
"required": [
"weight"
],
"optional": []
},
"user_denied": {
"required": [],
"optional": []
}
}
},
"sleep": {
"status": "unavailable",
"scope_requirements": {
"user_granted": {
"required": [],
"optional": []
},
"user_denied": {
"required": [
"sleep"
],
"optional": [
"heartrate",
"oxygen_saturation",
"respiratory_rate"
]
}
}
}
},
"error_details": null
}
]
}
Vital Team API Key
Successful Response
Show child attributes
Name of source of information
Slug for designated source
URL for source logo
Status of source, either error or connected
Show child attributes
Show child attributes
ℹ️ This enum is non-exhaustive.
available, unavailable Show child attributes
The unique identifier of the associated external data provider user.
null (not available)Details of the terminal connection error — populated only when the status is error.
Show child attributes
ℹ️ This enum is non-exhaustive.
token_refresh_failed, webhook_registration_failed, user_not_found, deregistered_per_provider, required_scopes_not_granted, provider_credential_error, provider_password_expired, unknown Was this page helpful?