pcall GET "/api/v1/partner/campaigns/asmnt_9f2c41d7a8b3e65f?candidates_limit=100"const res = await call("GET", "/api/v1/partner/campaigns/asmnt_9f2c41d7a8b3e65f?candidates_limit=100");
const { data } = await res.json();res = call("GET", "/api/v1/partner/campaigns/asmnt_9f2c41d7a8b3e65f?candidates_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}",
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}"
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}")
.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}")
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": {
"campaign_id": "asmnt_9f2c41d7a8b3e65f",
"external_id": "ats-campaign-5521",
"mandate_id": "JM_261009101612456H3N8W2L5C9V1Z4",
"job_id": "job-10452",
"name": "Warehouse Associate - October batch",
"status": "sending",
"blocked": null,
"language": "english",
"candidates": {
"total": 3,
"sent": 3,
"queued": 0,
"failed": 0
},
"created_at": "2026-10-05T09:12:44.000Z",
"started_at": "2026-10-05T09:12:45.000Z",
"sent_at": "2026-10-05T09:30:00.000Z",
"paused_at": null,
"candidate_list": {
"items": [
{
"candidate_id": "a3f1c9d2-7b44-4e0a-9c1d-5e6f7a8b9c01",
"external_id": "cand-88231",
"name": "Ravi Kumar",
"sent_at": "2026-10-05T09:30:00.000Z",
"delivery": "sent",
"can_resend": true
}
],
"has_more": false
}
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}Get a campaign
See whether it has gone out, is waiting for the job’s questions, is paused or stuck, and how many are contacted. candidate_list holds its first candidates (100 by default; candidates_limit up to 200, or 0 to leave it out) with their candidate_id, delivery and can_resend; has_more says there are more. For all of them, with verdicts and answers, call GET /campaigns/{campaign_id}/candidates.
Scope: campaigns:write or results:read
pcall GET "/api/v1/partner/campaigns/asmnt_9f2c41d7a8b3e65f?candidates_limit=100"const res = await call("GET", "/api/v1/partner/campaigns/asmnt_9f2c41d7a8b3e65f?candidates_limit=100");
const { data } = await res.json();res = call("GET", "/api/v1/partner/campaigns/asmnt_9f2c41d7a8b3e65f?candidates_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}",
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}"
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}")
.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}")
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": {
"campaign_id": "asmnt_9f2c41d7a8b3e65f",
"external_id": "ats-campaign-5521",
"mandate_id": "JM_261009101612456H3N8W2L5C9V1Z4",
"job_id": "job-10452",
"name": "Warehouse Associate - October batch",
"status": "sending",
"blocked": null,
"language": "english",
"candidates": {
"total": 3,
"sent": 3,
"queued": 0,
"failed": 0
},
"created_at": "2026-10-05T09:12:44.000Z",
"started_at": "2026-10-05T09:12:45.000Z",
"sent_at": "2026-10-05T09:30:00.000Z",
"paused_at": null,
"candidate_list": {
"items": [
{
"candidate_id": "a3f1c9d2-7b44-4e0a-9c1d-5e6f7a8b9c01",
"external_id": "cand-88231",
"name": "Ravi Kumar",
"sent_at": "2026-10-05T09:30:00.000Z",
"delivery": "sent",
"can_resend": true
}
],
"has_more": 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
^[A-Za-z0-9_-]{4,64}$Query Parameters
How many candidates to list in candidate_list; 0 for none
0 <= x <= 200
