Skip to main content
POST
/
v2
/
link
/
code
/
create
curl --request POST \
     --url {{BASE_URL}}/v2/link/code/create\?user_id\=1875c190-0cd6-46c1-8670-5b56a7794b78 \
     --header 'Accept: application/json' \
     --header 'Content-Type: 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.link.codeCreate({ userId: "<user_id>" });
from junction import Junction
from junction.environment import JunctionEnvironment

client = Junction(
    api_key="YOUR_API_KEY",
    environment=JunctionEnvironment.SANDBOX,
)

data = client.link.code_create(user_id="<user_id>")
import com.junction.api.Junction;
import com.junction.api.core.Environment;
import com.junction.api.resources.link.requests.CodeCreateLinkRequest;

Junction client = Junction.builder()
    .apiKey("YOUR_API_KEY")
    .environment(Environment.SANDBOX)
    .build();

var data = client.link().codeCreate(
    CodeCreateLinkRequest.builder()
        .userId("<user_id>")
        .build()
);
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.Link.CodeCreate(context.TODO(), &junction.CodeCreateLinkRequest{
    UserId: "<user_id>",
})
if err != nil {
    return err
}
fmt.Printf("Received data %s\n", response)
{
  "code": "<string>",
  "exchange_url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z"
}
{
"detail": "<unknown>"
}
Used for Junction iOS apps to share Apple HealthKit with you. Please refer here for more information.
curl --request POST \
     --url {{BASE_URL}}/v2/link/code/create\?user_id\=1875c190-0cd6-46c1-8670-5b56a7794b78 \
     --header 'Accept: application/json' \
     --header 'Content-Type: 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.link.codeCreate({ userId: "<user_id>" });
from junction import Junction
from junction.environment import JunctionEnvironment

client = Junction(
    api_key="YOUR_API_KEY",
    environment=JunctionEnvironment.SANDBOX,
)

data = client.link.code_create(user_id="<user_id>")
import com.junction.api.Junction;
import com.junction.api.core.Environment;
import com.junction.api.resources.link.requests.CodeCreateLinkRequest;

Junction client = Junction.builder()
    .apiKey("YOUR_API_KEY")
    .environment(Environment.SANDBOX)
    .build();

var data = client.link().codeCreate(
    CodeCreateLinkRequest.builder()
        .userId("<user_id>")
        .build()
);
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.Link.CodeCreate(context.TODO(), &junction.CodeCreateLinkRequest{
    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

Query Parameters

user_id
string<uuid>
required
expires_at
string<date-time> | null

When the link code should expire. Defaults to server time plus 1 hour.

Response

Successful Response

code
string
required
Pattern: ^(sk|pk)(eu|us)([\da-f]{8})
exchange_url
string
required
Pattern: ^tryvital\:\/\/tryvital\?code\=(sk|pk)(eu|us)([\da-f]{8})$
expires_at
string<date-time>
required