Get User Devices

Retrieve user devices via the Junction API. Requires authentication with your team API key.

GET /v2/user/{user_id}/device

Shell

curl --request GET \
     --url {{BASE_URL}}/v2/user/{user_id}/device \
     --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.user.get_devices("<user_id>")

import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";

const client = new JunctionClient({
    apiKey: "YOUR_API_KEY",
    environment: JunctionEnvironment.Sandbox,
});

const data = await client.user.getDevices({ 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.user().getDevices("<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.GetDevices(context.TODO(), &junction.GetDevicesUserRequest{
    UserId: "<user_id>",
})
if err != nil {
    return err
}
fmt.Printf("Received data %s\n", response)

200

[
  {
    "device_id": "F-31-A4C138BB9EF5",
    "device_manufacturer": "Fitbit",
    "device_model": "Aria Air",
    "device_version": "1.0",
    "id": "00000000-0000-0000-0000-000000000000",
    "provider": "fitbit",
    "source_type": "scale",
    "user_id": "00000000-0000-0000-0000-000000000000"
  }
]

{
  "detail": "<unknown>"
}

Shell

curl --request GET \
     --url {{BASE_URL}}/v2/user/{user_id}/device \
     --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.user.get_devices("<user_id>")

import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";

const client = new JunctionClient({
    apiKey: "YOUR_API_KEY",
    environment: JunctionEnvironment.Sandbox,
});

const data = await client.user.getDevices({ 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.user().getDevices("<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.GetDevices(context.TODO(), &junction.GetDevicesUserRequest{
    UserId: "<user_id>",
})
if err != nil {
    return err
}
fmt.Printf("Received data %s\n", response)

Authorizations

x-vital-api-key · string · header · required

Vital Team API Key

Path Parameters

user_id · string<uuid> · required

Response

200

application/json

Successful Response

id · string<uuid> · required

user_id · string<uuid> · required

provider · string · required

source_type · enum<string> · required

ℹ️ This enum is non-exhaustive.

Available options: unknown, phone, watch, app, multiple_sources, fingerprick, cuff, manual_scan, automatic, insulin_pump, scale, chest_strap, ring, lab, exercise_machine, earphone

app_id · string | null

device_manufacturer · string | null

device_model · string | null

device_version · string | null

device_id · string | null