curl --request GET \
--url {{BASE_URL}}/v2/summary/profile/{user_id} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
from junction import Junction
from junction.environment import JunctionEnvironment
client = Junction(
api_key="YOUR_API_KEY",
environment=JunctionEnvironment.SANDBOX,
)
data = client.profile.get("<user_id>")
import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";
const client = new JunctionClient({
apiKey: "YOUR_API_KEY",
environment: JunctionEnvironment.Sandbox,
});
const data = await client.profile.get({ userId: "<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.profile().get("<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.Profile.Get(context.TODO(), &junction.GetProfileRequest{
UserId: "<user_id>",
})
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
{
"created_at": "2023-02-27T20:31:24+00:00",
"height": 183,
"id": "ceb39d90-5ba6-472b-9cb8-b5c128da5038",
"source": {
"logo": "https://logo_url.com",
"name": "Oura",
"slug": "oura"
},
"updated_at": "2023-02-28T01:22:38+00:00",
"user_id": "1449752e-0d8a-40e0-9206-91ab099b2537"
}{
"detail": "<unknown>"
}Profile
Summary
Retrieve the processed user profile data from their connected wearable provider, including demographics and preferences.
GET
/
v2
/
summary
/
profile
/
{user_id}
curl --request GET \
--url {{BASE_URL}}/v2/summary/profile/{user_id} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
from junction import Junction
from junction.environment import JunctionEnvironment
client = Junction(
api_key="YOUR_API_KEY",
environment=JunctionEnvironment.SANDBOX,
)
data = client.profile.get("<user_id>")
import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";
const client = new JunctionClient({
apiKey: "YOUR_API_KEY",
environment: JunctionEnvironment.Sandbox,
});
const data = await client.profile.get({ userId: "<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.profile().get("<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.Profile.Get(context.TODO(), &junction.GetProfileRequest{
UserId: "<user_id>",
})
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
{
"created_at": "2023-02-27T20:31:24+00:00",
"height": 183,
"id": "ceb39d90-5ba6-472b-9cb8-b5c128da5038",
"source": {
"logo": "https://logo_url.com",
"name": "Oura",
"slug": "oura"
},
"updated_at": "2023-02-28T01:22:38+00:00",
"user_id": "1449752e-0d8a-40e0-9206-91ab099b2537"
}{
"detail": "<unknown>"
}curl --request GET \
--url {{BASE_URL}}/v2/summary/profile/{user_id} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
from junction import Junction
from junction.environment import JunctionEnvironment
client = Junction(
api_key="YOUR_API_KEY",
environment=JunctionEnvironment.SANDBOX,
)
data = client.profile.get("<user_id>")
import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";
const client = new JunctionClient({
apiKey: "YOUR_API_KEY",
environment: JunctionEnvironment.Sandbox,
});
const data = await client.profile.get({ userId: "<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.profile().get("<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.Profile.Get(context.TODO(), &junction.GetProfileRequest{
UserId: "<user_id>",
})
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
Authorizations
Vital Team API Key
Path Parameters
Query Parameters
Provider oura/strava etc
Response
Successful Response
User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api.
Source summarizes where a sample or a summary is sourced from. At minimum, the source provider is always included.
Show child attributes
Show child attributes
Example:
{ "provider": "oura", "type": "ring" }
ℹ️ This enum is non-exhaustive.
Available options:
female, male, other, unknown ℹ️ This enum is non-exhaustive.
Available options:
female, male, other Was this page helpful?