Get User Connections

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

GET /v2/user/providers/{user_id}

cURL

curl --request GET \
     --url {{BASE_URL}}/v2/user/providers/{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.getConnectedProviders({ 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.get_connected_providers("<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().getConnectedProviders("<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.GetConnectedProviders(context.TODO(), &junction.GetConnectedProvidersUserRequest{
    UserId: "<user_id>",
})
if err != nil {
    return err
}
fmt.Printf("Received data %s\n", response)

Response

{
    "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

curl --request GET \
     --url {{BASE_URL}}/v2/user/providers/{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.getConnectedProviders({ 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.get_connected_providers("<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().getConnectedProviders("<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.GetConnectedProviders(context.TODO(), &junction.GetConnectedProvidersUserRequest{
    UserId: "<user_id>",
})
if err != nil {
    return err
}
fmt.Printf("Received data %s\n", response)

Response

{
    "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
        }
    ]
}

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

{key} · Provider · object[]

Show child attributes