Junction

Junction User API

The user API from Vital — 16 operation(s) for user.

GitHub OpenAPI

Operations 19

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v2/user List my team's users · Get Teams Users #
Ask an LLM
“Can I list every user on my team?”
“Is the team user list paginated with offset and limit?”
Tell an agent
List my team's users.
Get {limit} team users starting at offset {offset}.
POST /v2/user Create a user · Create User #
Ask an LLM
“How do I create a Vital user for someone in my app?”
“Can I set a fallback time zone when creating a user?”
Tell an agent
Create a user with client user ID {client_user_id}.
Create user {client_user_id} with fallback time zone {tz}.
GET /v2/user/metrics Get my team's metrics · Get Teams Metrics #
Ask an LLM
“What usage metrics are available for my team?”
“Can I pull team-level metrics in one call?”
Tell an agent
Get my team's metrics.
Show the current metrics for my team.
GET /v2/user/providers/{user_id} List a user's connected providers · Get Connected Providers #
Ask an LLM
“Which providers has a user connected?”
“Can I check whether a user's wearable is still linked?”
Tell an agent
List connected providers for {user}.
Show which providers {user} has linked.
GET /v2/user/{user_id}/info/latest Get a user's latest demographics · Get User Demographcis #
Ask an LLM
“What demographic info is on file for a user?”
“Can I fetch a user's most recent name, birth date and address?”
Tell an agent
Get the latest demographics for {user}.
Show {user}'s current patient info.
POST /v2/user/{user_id}/insurance Add health insurance to a user · Create Insurance #
Ask an LLM
“How do I add health insurance to a user?”
“Can I mark an insurance plan as the user's primary?”
Tell an agent
Add insurance for {user} with payor {payor_code}, member ID {member_id}, relationship {relationship}, insured {insured}.
Attach payor {payor_code} coverage with member ID {member_id} to {user} as primary.
GET /v2/user/{user_id}/insurance/latest Get a user's latest insurance · Get Latest Insurance #
Ask an LLM
“What insurance is currently on file for a user?”
“Can I get just the user's primary insurance?”
Tell an agent
Get the latest insurance for {user}.
Get {user}'s most recent insurance where primary is {is_primary}.
PATCH /v2/user/{user_id}/info Save a user's demographic details · Create User Demographics #
Ask an LLM
“How do I save a user's name, contact details and address?”
“Can I record race, ethnicity and gender identity for a user?”
Tell an agent
Set demographics for {user}: {first_name} {last_name}, {email}, {phone}, gender {gender}, born {dob}, address {address}.
Update {user}'s patient info with email {email} and date of birth {dob}.
GET /v2/user/resolve/{client_user_id} Resolve a client user ID to a user · Get User By Client User Id #
Ask an LLM
“How do I find the Vital user ID for one of my client user IDs?”
“Can I resolve my own user identifier to a user?”
Tell an agent
Resolve client user ID {path_client_user_id}.
Get the user for my ID {path_client_user_id}.
DELETE /v2/user/{user_id}/{provider} Disconnect a provider from a user · Deregister Provider #
Ask an LLM
“How do I disconnect a provider from a user?”
“Can I remove one wearable connection without deleting the user?”
Tell an agent destructive · confirm first
Deregister {provider} from user {user}.
Disconnect {user}'s {provider} connection.
PATCH /v2/user/{user_id} Update a user's settings · Patch User #
Ask an LLM
“Can I change a user's fallback time zone or birth date?”
“Can I adjust a user's data ingestion window after creating them?”
Tell an agent
Update {user}'s fallback time zone to {tz}.
Set ingestion for {user} from {ingestion_start} to {ingestion_end}.
DELETE /v2/user/{user_id} Delete a user · Delete User #
Ask an LLM
“How do I delete a user?”
“Can I permanently remove a user from my team?”
Tell an agent destructive · confirm first
Delete user {user}.
Remove user {user} from my team.
GET /v2/user/{user_id} Get a user · Get User #
Ask an LLM
“Can I look up a user by user ID?”
“What details are stored for a single user?”
Tell an agent
Get user {user}.
Show the record for user {user}.
POST /v2/user/undo_delete Restore a deleted user · Undo User Delete #
Ask an LLM
“Can I restore a user I deleted by mistake?”
“Is it possible to undo a user deletion using my client user ID?”
Tell an agent
Undo the deletion of user {q_user}.
Restore the deleted user with client ID {q_client_user_id}.
POST /v2/user/refresh/{user_id} Trigger a manual data refresh for a user · Refresh User Id #
Ask an LLM
“Can I force a manual data refresh for a user?”
“How do I trigger an immediate sync for one user?”
Tell an agent
Refresh data for user {user}.
Trigger a manual refresh for {user} with timeout {timeout}.
GET /v2/user/{user_id}/device List a user's devices · Get User Devices #
Ask an LLM
“Which devices are registered to a user?”
“Can I see all devices tied to one user?”
Tell an agent
List devices for {user}.
Show every device registered to {user}.
GET /v2/user/{user_id}/device/{device_id} Get one of a user's devices · Get User Device #
Ask an LLM
“Can I get the details of one specific device for a user?”
“What does a single device record contain?”
Tell an agent
Get device {device_id} for user {user}.
Show {user}'s device {device_id}.
POST /v2/user/{user_id}/sign_in_token Issue a sign-in token for a user · Get User Sign In Token #
Ask an LLM
“How do I get a sign-in token for a user?”
“Can I issue a sign-in token for a single user?”
Tell an agent
Create a sign-in token for {user}.
Issue {user} a sign-in token.
POST /v2/user/{user_id}/create_portal_url Create a user portal link · Create User Portal Url #
Ask an LLM
“Can I create a portal link for a user?”
“Can a user portal link deep-link to a specific order?”
Tell an agent
Create a portal URL for {user} with context {context}.
Generate a portal link for {user} in context {context} that opens order {order_id}.

Documentation

📖
Documentation
https://docs.junction.com/api-details/junction-api
📖
Documentation
https://docs.junction.com/wearables/providers/introduction
📖
Documentation
https://docs.junction.com/api-details/junction-management-api

Specifications

⚙
OpenAPI
https://artifacts.apis.io/junction-com/openapi/junction-com-user-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/junction-com/json-schema/vital-user-schema.json
📊
JSONSchema
https://artifacts.apis.io/junction-com/json-schema/vital-provider-schema.json
📊
JSONSchema
https://artifacts.apis.io/junction-com/json-schema/vital-sleep-summary-schema.json
📊
JSONSchema
https://artifacts.apis.io/junction-com/json-schema/vital-activity-summary-schema.json
📊
JSONSchema
https://artifacts.apis.io/junction-com/json-schema/vital-heart-rate-timeseries-schema.json
📊
JSONSchema
https://artifacts.apis.io/junction-com/json-schema/vital-lab-order-schema.json
📊
JSONSchema
https://artifacts.apis.io/junction-com/json-schema/vital-lab-result-schema.json

Other Resources

🔗
Examples
https://artifacts.apis.io/junction-com/examples/vital-create-user-example.json
🔗
Examples
https://artifacts.apis.io/junction-com/examples/vital-link-token-example.json
🔗
Examples
https://artifacts.apis.io/junction-com/examples/vital-sleep-summary-example.json
🔗
Examples
https://artifacts.apis.io/junction-com/examples/vital-heart-rate-timeseries-example.json
🔗
Examples
https://artifacts.apis.io/junction-com/examples/vital-create-order-example.json
🔗
Examples
https://artifacts.apis.io/junction-com/examples/vital-lab-result-example.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/junction-com:junction-com-user-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

junction-com-user-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Junction User API
  version: '1.0'
  description: 'Operations tagged user across 2 of this provider''s published API definitions: junction-openapi-live-2026-10-12.json, vital-openapi-original.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.us.junction.com
  x-fern-server-name: Production
- url: https://api.eu.junction.com
  x-fern-server-name: ProductionEU
- url: https://api.sandbox.us.junction.com
  x-fern-server-name: Sandbox
- url: https://api.sandbox.eu.junction.com
  x-fern-server-name: SandboxEU
security:
- apiKeyAuth: []
tags:


# --- truncated at 32 KB (66 KB total) ---
# Full source: https://artifacts.apis.io/junction-com/openapi/junction-com-user-api-openapi.yml