cURL
pcall GET "/api/v1/partner/candidates/a3f1c9d2-7b44-4e0a-9c1d-5e6f7a8b9c01/journey"const res = await call("GET", "/api/v1/partner/candidates/a3f1c9d2-7b44-4e0a-9c1d-5e6f7a8b9c01/journey");
const { data } = await res.json();res = call("GET", "/api/v1/partner/candidates/a3f1c9d2-7b44-4e0a-9c1d-5e6f7a8b9c01/journey")
data = res.json()["data"]<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-bc.userecord.io/api/v1/partner/candidates/{candidate_id}/journey",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>",
"x-secret-key: <api-key>"
],
]);
$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://api-bc.userecord.io/api/v1/partner/candidates/{candidate_id}/journey"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-secret-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-bc.userecord.io/api/v1/partner/candidates/{candidate_id}/journey")
.header("x-api-key", "<api-key>")
.header("x-secret-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-bc.userecord.io/api/v1/partner/candidates/{candidate_id}/journey")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-secret-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"candidate_id": "a3f1c9d2-7b44-4e0a-9c1d-5e6f7a8b9c01",
"campaign_id": "asmnt_9f2c41d7a8b3e65f",
"status": "pending",
"reason": null,
"steps": [
{
"key": "whatsapp_sent",
"label": "WhatsApp message sent",
"state": "done",
"at": "2026-10-05T09:30:00.000Z",
"detail": null
},
{
"key": "whatsapp_delivered",
"label": "Delivered",
"state": "done",
"at": "2026-10-05T09:30:00.000Z",
"detail": null
},
{
"key": "tapped_yes",
"label": "Tapped Yes",
"state": "done",
"at": "2026-10-05T09:41:00.000Z",
"detail": "link sent in the next message"
},
{
"key": "link_not_opened",
"label": "Link not opened yet",
"state": "pending",
"at": "2026-10-05T13:30:00.000Z",
"detail": "Reminder 1 goes out"
},
{
"key": "call",
"label": "Call not answered",
"state": "failed",
"at": "2026-10-05T10:00:00.000Z",
"detail": "Attempt 1 of 3"
},
{
"key": "call_queued",
"label": "Voice call queued",
"state": "pending",
"at": "2026-10-05T14:00:00.000Z",
"detail": "Attempt 2 of 3"
},
{
"key": "call_next",
"label": "Next call, if no answer",
"state": "scheduled",
"at": "2026-10-05T18:00:00.000Z",
"detail": null
}
],
"last_activity_at": "2026-10-05T09:41:00.000Z",
"responded_at": "2026-10-05T09:41:00.000Z",
"next_step": "voice_call",
"link_opened": false
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}Results
Get a candidate journey
What Record has done with this candidate so far: invite, reply, reminders, SMS and each voice call, then what is waiting.
Scope: results:read
GET
/
candidates
/
{candidate_id}
/
journey
cURL
pcall GET "/api/v1/partner/candidates/a3f1c9d2-7b44-4e0a-9c1d-5e6f7a8b9c01/journey"const res = await call("GET", "/api/v1/partner/candidates/a3f1c9d2-7b44-4e0a-9c1d-5e6f7a8b9c01/journey");
const { data } = await res.json();res = call("GET", "/api/v1/partner/candidates/a3f1c9d2-7b44-4e0a-9c1d-5e6f7a8b9c01/journey")
data = res.json()["data"]<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-bc.userecord.io/api/v1/partner/candidates/{candidate_id}/journey",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>",
"x-secret-key: <api-key>"
],
]);
$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://api-bc.userecord.io/api/v1/partner/candidates/{candidate_id}/journey"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-secret-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-bc.userecord.io/api/v1/partner/candidates/{candidate_id}/journey")
.header("x-api-key", "<api-key>")
.header("x-secret-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-bc.userecord.io/api/v1/partner/candidates/{candidate_id}/journey")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-secret-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"candidate_id": "a3f1c9d2-7b44-4e0a-9c1d-5e6f7a8b9c01",
"campaign_id": "asmnt_9f2c41d7a8b3e65f",
"status": "pending",
"reason": null,
"steps": [
{
"key": "whatsapp_sent",
"label": "WhatsApp message sent",
"state": "done",
"at": "2026-10-05T09:30:00.000Z",
"detail": null
},
{
"key": "whatsapp_delivered",
"label": "Delivered",
"state": "done",
"at": "2026-10-05T09:30:00.000Z",
"detail": null
},
{
"key": "tapped_yes",
"label": "Tapped Yes",
"state": "done",
"at": "2026-10-05T09:41:00.000Z",
"detail": "link sent in the next message"
},
{
"key": "link_not_opened",
"label": "Link not opened yet",
"state": "pending",
"at": "2026-10-05T13:30:00.000Z",
"detail": "Reminder 1 goes out"
},
{
"key": "call",
"label": "Call not answered",
"state": "failed",
"at": "2026-10-05T10:00:00.000Z",
"detail": "Attempt 1 of 3"
},
{
"key": "call_queued",
"label": "Voice call queued",
"state": "pending",
"at": "2026-10-05T14:00:00.000Z",
"detail": "Attempt 2 of 3"
},
{
"key": "call_next",
"label": "Next call, if no answer",
"state": "scheduled",
"at": "2026-10-05T18:00:00.000Z",
"detail": null
}
],
"last_activity_at": "2026-10-05T09:41:00.000Z",
"responded_at": "2026-10-05T09:41:00.000Z",
"next_step": "voice_call",
"link_opened": false
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}Authorizations
Your key id, VFN_TEST_… or VFN_LIVE_…. Sent on every request.
Your secret, VFN_SK_…. Not a real header, and never sent to the API. It is only a form field for Try it, which uses it to sign your request in your browser. In your own code you sign each request with the secret and send x-api-key, x-timestamp and x-signature (see Authentication).
Path Parameters
Pattern:
^[A-Za-z0-9_-]{4,64}$
