curl --request GET \
--url https://vanguard.profilebehavior.com/api/v4/profile/{profileId}/invite/link \
--header 'Authorization: Bearer <token>'import requests
url = "https://vanguard.profilebehavior.com/api/v4/profile/{profileId}/invite/link"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://vanguard.profilebehavior.com/api/v4/profile/{profileId}/invite/link', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://vanguard.profilebehavior.com/api/v4/profile/{profileId}/invite/link",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://vanguard.profilebehavior.com/api/v4/profile/{profileId}/invite/link"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://vanguard.profilebehavior.com/api/v4/profile/{profileId}/invite/link")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://vanguard.profilebehavior.com/api/v4/profile/{profileId}/invite/link")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"code": 200,
"link": "https://next.profilebehavior.com/assessment/60e9ca73c500a9001534ad84",
"status": "success"
}{
"code": 400,
"error": {
"message": "Invalid request body",
"timestamp": "2025-01-01T09:42:52.329056-05:00"
},
"status": "error"
}{
"code": 401,
"error": {
"message": "Invalid token",
"timestamp": "2025-01-01T09:42:52.329056-05:00"
},
"status": "error"
}{
"code": 402,
"error": {
"message": "Maximum reports reached for trial account",
"timestamp": "2025-01-01T09:42:52.329056-05:00"
},
"status": "error"
}{
"code": 403,
"error": {
"message": "Access denied",
"timestamp": "2025-01-01T09:42:52.329056-05:00"
},
"status": "error"
}{
"code": 421,
"error": {
"message": "This account is served from another region",
"timestamp": "2025-01-01T09:42:52.329056-05:00"
},
"region": {
"zone": "EU",
"apiUrl": "https://vanguard-eu.profilebehavior.com/api"
},
"status": "error"
}{
"code": 500,
"error": {
"message": "Internal error",
"timestamp": "2025-01-01T09:42:52.329056-05:00"
},
"status": "error"
}Get Assessment Link
Returns the URL of the assessment for the profile so you can deliver it through your own channels, such as an onboarding email, a chat message, or a QR code. Nothing is sent to the individual by this endpoint.
Unlike the email and SMS invites, this URL is not a one-time magic link and does not expire. Opening it does not sign the individual in: they are shown a masked version of the email address or phone number on their profile and must request a one-time sign-in link to that contact before starting. Sharing the URL therefore exposes no profile data.
curl --request GET \
--url https://vanguard.profilebehavior.com/api/v4/profile/{profileId}/invite/link \
--header 'Authorization: Bearer <token>'import requests
url = "https://vanguard.profilebehavior.com/api/v4/profile/{profileId}/invite/link"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://vanguard.profilebehavior.com/api/v4/profile/{profileId}/invite/link', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://vanguard.profilebehavior.com/api/v4/profile/{profileId}/invite/link",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://vanguard.profilebehavior.com/api/v4/profile/{profileId}/invite/link"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://vanguard.profilebehavior.com/api/v4/profile/{profileId}/invite/link")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://vanguard.profilebehavior.com/api/v4/profile/{profileId}/invite/link")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"code": 200,
"link": "https://next.profilebehavior.com/assessment/60e9ca73c500a9001534ad84",
"status": "success"
}{
"code": 400,
"error": {
"message": "Invalid request body",
"timestamp": "2025-01-01T09:42:52.329056-05:00"
},
"status": "error"
}{
"code": 401,
"error": {
"message": "Invalid token",
"timestamp": "2025-01-01T09:42:52.329056-05:00"
},
"status": "error"
}{
"code": 402,
"error": {
"message": "Maximum reports reached for trial account",
"timestamp": "2025-01-01T09:42:52.329056-05:00"
},
"status": "error"
}{
"code": 403,
"error": {
"message": "Access denied",
"timestamp": "2025-01-01T09:42:52.329056-05:00"
},
"status": "error"
}{
"code": 421,
"error": {
"message": "This account is served from another region",
"timestamp": "2025-01-01T09:42:52.329056-05:00"
},
"region": {
"zone": "EU",
"apiUrl": "https://vanguard-eu.profilebehavior.com/api"
},
"status": "error"
}{
"code": 500,
"error": {
"message": "Internal error",
"timestamp": "2025-01-01T09:42:52.329056-05:00"
},
"status": "error"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the profile to get the assessment link for.
Response
Success
Standard response object for successful single-resource requests in the Profile Behavior API. Contains an HTTP status code, the returned resource data, and a status indicator.
Was this page helpful?