curl --request GET \
--url {{BASE_URL}}/v2/user/ \
--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.getAll();
from junction import Junction
from junction.environment import JunctionEnvironment
client = Junction(
api_key="YOUR_API_KEY",
environment=JunctionEnvironment.SANDBOX,
)
data = client.user.get_all()
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().getAll();
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.GetAll(context.TODO(), nil)
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
{
"users": [
{
"client_user_id": "ZTEwZjNjMjctOTI2ZS00M2Vm",
"connected_sources": [
{
"created_on": "2026-06-17T19:51:36+00:00",
"source": {
"logo": "logo_url",
"name": "Oura",
"slug": "oura"
}
}
],
"created_on": "2026-06-17T19:51:36+00:00",
"fallback_birth_date": {
"source_slug": "manual",
"updated_at": "2026-06-17T19:51:36+00:00",
"value": "1989-09-12"
},
"fallback_time_zone": {
"id": "Europe/London",
"source_slug": "manual",
"updated_at": "2026-06-17T19:51:36+00:00"
},
"team_id": "56bd81c9-6219-4000-a775-ae85526eba18",
"user_id": "56bd81c9-6219-4000-a775-ae85526eba18"
}
],
"total": 123,
"offset": 123,
"limit": 123
}{
"detail": "<unknown>"
}User Management
Get users
Retrieve users via the Junction API. Requires authentication with your team API key.
GET
/
v2
/
user
curl --request GET \
--url {{BASE_URL}}/v2/user/ \
--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.getAll();
from junction import Junction
from junction.environment import JunctionEnvironment
client = Junction(
api_key="YOUR_API_KEY",
environment=JunctionEnvironment.SANDBOX,
)
data = client.user.get_all()
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().getAll();
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.GetAll(context.TODO(), nil)
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
{
"users": [
{
"client_user_id": "ZTEwZjNjMjctOTI2ZS00M2Vm",
"connected_sources": [
{
"created_on": "2026-06-17T19:51:36+00:00",
"source": {
"logo": "logo_url",
"name": "Oura",
"slug": "oura"
}
}
],
"created_on": "2026-06-17T19:51:36+00:00",
"fallback_birth_date": {
"source_slug": "manual",
"updated_at": "2026-06-17T19:51:36+00:00",
"value": "1989-09-12"
},
"fallback_time_zone": {
"id": "Europe/London",
"source_slug": "manual",
"updated_at": "2026-06-17T19:51:36+00:00"
},
"team_id": "56bd81c9-6219-4000-a775-ae85526eba18",
"user_id": "56bd81c9-6219-4000-a775-ae85526eba18"
}
],
"total": 123,
"offset": 123,
"limit": 123
}{
"detail": "<unknown>"
}curl --request GET \
--url {{BASE_URL}}/v2/user/ \
--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.getAll();
from junction import Junction
from junction.environment import JunctionEnvironment
client = Junction(
api_key="YOUR_API_KEY",
environment=JunctionEnvironment.SANDBOX,
)
data = client.user.get_all()
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().getAll();
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.GetAll(context.TODO(), nil)
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
Was this page helpful?
⌘I