pcall GET "/api/v1/partner/campaigns/asmnt_9f2c41d7a8b3e65f/candidates?status=interested&limit=100"const res = await call("GET", "/api/v1/partner/campaigns/asmnt_9f2c41d7a8b3e65f/candidates?status=interested&limit=100");
const { data } = await res.json();res = call("GET", "/api/v1/partner/campaigns/asmnt_9f2c41d7a8b3e65f/candidates?status=interested&limit=100")
data = res.json()["data"]<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-bc.userecord.io/api/v1/partner/campaigns/{campaign_id}/candidates",
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/campaigns/{campaign_id}/candidates"
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/campaigns/{campaign_id}/candidates")
.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/campaigns/{campaign_id}/candidates")
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": {
"items": [
{
"candidate_id": "a3f1c9d2-7b44-4e0a-9c1d-5e6f7a8b9c01",
"external_id": "cand-88231",
"name": "Ravi Kumar",
"status": "interested",
"progress": "completed",
"verdict": "Good Fit",
"total_score": 78,
"language": "ta",
"sent_at": "2026-10-05T09:30:00.000Z",
"completed_at": "2026-10-05T12:41:10.000Z",
"updated_at": "2026-10-05T12:41:10.000Z",
"report_url": "https://example.com/r/7Hk2p9",
"delivery": "sent",
"can_resend": false
}
],
"count": 1,
"total": 240,
"next_cursor": "eyJpZCI6IjY2YTEifQ",
"has_more": true
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}List campaign candidates
One row per candidate: candidate_id, interested or not, progress, verdict and score, plus delivery (queued, sent, failed) and can_resend, so you can see who needs their link sent again. Phone numbers are never returned. A key with only campaigns:write gets the rows with verdict, total_score and report_url left null.
Scope: results:read or campaigns:write
pcall GET "/api/v1/partner/campaigns/asmnt_9f2c41d7a8b3e65f/candidates?status=interested&limit=100"const res = await call("GET", "/api/v1/partner/campaigns/asmnt_9f2c41d7a8b3e65f/candidates?status=interested&limit=100");
const { data } = await res.json();res = call("GET", "/api/v1/partner/campaigns/asmnt_9f2c41d7a8b3e65f/candidates?status=interested&limit=100")
data = res.json()["data"]<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-bc.userecord.io/api/v1/partner/campaigns/{campaign_id}/candidates",
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/campaigns/{campaign_id}/candidates"
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/campaigns/{campaign_id}/candidates")
.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/campaigns/{campaign_id}/candidates")
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": {
"items": [
{
"candidate_id": "a3f1c9d2-7b44-4e0a-9c1d-5e6f7a8b9c01",
"external_id": "cand-88231",
"name": "Ravi Kumar",
"status": "interested",
"progress": "completed",
"verdict": "Good Fit",
"total_score": 78,
"language": "ta",
"sent_at": "2026-10-05T09:30:00.000Z",
"completed_at": "2026-10-05T12:41:10.000Z",
"updated_at": "2026-10-05T12:41:10.000Z",
"report_url": "https://example.com/r/7Hk2p9",
"delivery": "sent",
"can_resend": false
}
],
"count": 1,
"total": 240,
"next_cursor": "eyJpZCI6IjY2YTEifQ",
"has_more": true
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}{
"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
^[A-Za-z0-9_-]{4,64}$Query Parameters
interested, not_interested, no_answer_yet, unreachable not_yet_started, in_progress, completed ISO 8601 date-time
1 to 200, default 100
1 <= x <= 200The next_cursor of the previous page
512
