curl --request POST \
--url {{BASE_URL}}/v2/user/refresh/{user_id} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";
const client = new JunctionClient({
apiKey: "YOUR_API_KEY",
environment: JunctionEnvironment.Sandbox,
});
const data = await client.user.refresh({ userId: "<user_id>" });
from junction import Junction
from junction.environment import JunctionEnvironment
client = Junction(
api_key="YOUR_API_KEY",
environment=JunctionEnvironment.SANDBOX,
)
data = client.user.refresh("<user_id>")
import com.junction.api.Junction;
import com.junction.api.core.Environment;
Junction client = Junction.builder()
.apiKey("YOUR_API_KEY")
.environment(Environment.SANDBOX)
.build();
var data = client.user().refresh("<user_id>");
import (
"context"
junction "github.com/junction-api/junction-go"
"github.com/junction-api/junction-go/client"
"github.com/junction-api/junction-go/option"
)
c := client.NewClient(
option.WithApiKey("YOUR_API_KEY"),
option.WithBaseURL(junction.Environments.Sandbox),
)
response, err := c.User.Refresh(context.TODO(), &junction.RefreshUserRequest{
UserId: "<user_id>",
})
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
{
"failed_sources": [
"oura/sleep"
],
"in_progress_sources": [],
"refreshed_sources": [
"withings/workouts",
"withings/sleep",
"withings/body",
"withings/vitals/blood_pressure",
"withings/activity"
],
"success": true,
"user_id": "1449752e-0d8a-40e0-9206-91ab099b2537"
}{
"failed_sources": [
"oura/sleep"
],
"in_progress_sources": [],
"refreshed_sources": [
"withings/workouts",
"withings/sleep",
"withings/body",
"withings/vitals/blood_pressure",
"withings/activity"
],
"success": true,
"user_id": "1449752e-0d8a-40e0-9206-91ab099b2537"
}{
"error": "user has no connected sources",
"failed_sources": [],
"success": false,
"user_id": "1449752e-0d8a-40e0-9206-91ab099b2537"
}{
"detail": "<unknown>"
}Device Connections
Refresh User Data
Create or submit user refresh via the Junction API. Requires authentication with your team API key.
POST
/
v2
/
user
/
refresh
/
{user_id}
curl --request POST \
--url {{BASE_URL}}/v2/user/refresh/{user_id} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";
const client = new JunctionClient({
apiKey: "YOUR_API_KEY",
environment: JunctionEnvironment.Sandbox,
});
const data = await client.user.refresh({ userId: "<user_id>" });
from junction import Junction
from junction.environment import JunctionEnvironment
client = Junction(
api_key="YOUR_API_KEY",
environment=JunctionEnvironment.SANDBOX,
)
data = client.user.refresh("<user_id>")
import com.junction.api.Junction;
import com.junction.api.core.Environment;
Junction client = Junction.builder()
.apiKey("YOUR_API_KEY")
.environment(Environment.SANDBOX)
.build();
var data = client.user().refresh("<user_id>");
import (
"context"
junction "github.com/junction-api/junction-go"
"github.com/junction-api/junction-go/client"
"github.com/junction-api/junction-go/option"
)
c := client.NewClient(
option.WithApiKey("YOUR_API_KEY"),
option.WithBaseURL(junction.Environments.Sandbox),
)
response, err := c.User.Refresh(context.TODO(), &junction.RefreshUserRequest{
UserId: "<user_id>",
})
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
{
"failed_sources": [
"oura/sleep"
],
"in_progress_sources": [],
"refreshed_sources": [
"withings/workouts",
"withings/sleep",
"withings/body",
"withings/vitals/blood_pressure",
"withings/activity"
],
"success": true,
"user_id": "1449752e-0d8a-40e0-9206-91ab099b2537"
}{
"failed_sources": [
"oura/sleep"
],
"in_progress_sources": [],
"refreshed_sources": [
"withings/workouts",
"withings/sleep",
"withings/body",
"withings/vitals/blood_pressure",
"withings/activity"
],
"success": true,
"user_id": "1449752e-0d8a-40e0-9206-91ab099b2537"
}{
"error": "user has no connected sources",
"failed_sources": [],
"success": false,
"user_id": "1449752e-0d8a-40e0-9206-91ab099b2537"
}{
"detail": "<unknown>"
}curl --request POST \
--url {{BASE_URL}}/v2/user/refresh/{user_id} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";
const client = new JunctionClient({
apiKey: "YOUR_API_KEY",
environment: JunctionEnvironment.Sandbox,
});
const data = await client.user.refresh({ userId: "<user_id>" });
from junction import Junction
from junction.environment import JunctionEnvironment
client = Junction(
api_key="YOUR_API_KEY",
environment=JunctionEnvironment.SANDBOX,
)
data = client.user.refresh("<user_id>")
import com.junction.api.Junction;
import com.junction.api.core.Environment;
Junction client = Junction.builder()
.apiKey("YOUR_API_KEY")
.environment(Environment.SANDBOX)
.build();
var data = client.user().refresh("<user_id>");
import (
"context"
junction "github.com/junction-api/junction-go"
"github.com/junction-api/junction-go/client"
"github.com/junction-api/junction-go/option"
)
c := client.NewClient(
option.WithApiKey("YOUR_API_KEY"),
option.WithBaseURL(junction.Environments.Sandbox),
)
response, err := c.User.Refresh(context.TODO(), &junction.RefreshUserRequest{
UserId: "<user_id>",
})
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
Authorizations
Vital Team API Key
Path Parameters
Query Parameters
Required range:
5 <= x <= 60Response
Successful Response
Whether operation was successful or not
A unique ID representing the end user. Typically this will be a user ID from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.
Was this page helpful?
⌘I