cURL
pcall GET "/api/v1/partner/enrichments?status=active&limit=25"const res = await call("GET", "/api/v1/partner/enrichments?status=active&limit=25");
const { data } = await res.json();res = call("GET", "/api/v1/partner/enrichments?status=active&limit=25")
data = res.json()["data"]<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-bc.userecord.io/api/v1/partner/enrichments",
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/enrichments"
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/enrichments")
.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/enrichments")
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": [
{
"enrichment_id": "WF_EN_261121094822026AEDRUB86TQVSML",
"external_id": "enr-chennai-warehouse",
"name": "Warehouse talent pool - Chennai",
"description": "",
"status": "active",
"questions_status": "pending",
"delivery": {
"whatsapp": true,
"voice_call": true,
"sms": true
},
"schedule": {
"language": "english",
"start_time": "10:00",
"end_time": "18:00",
"days": [
"mon",
"tue",
"wed",
"thu",
"fri",
"sat"
],
"timezone": "Asia/Kolkata",
"max_retries": 3,
"retry_after_hours": 4
},
"question_count": 2,
"counts": {
"campaigns": 0,
"candidates": 0,
"sent": 0,
"completed": 0
},
"is_external": true,
"created_at": "2026-11-10T10:15:30.000Z",
"updated_at": "2026-11-10T10:15:30.000Z"
}
],
"count": 1,
"total": 1,
"next_cursor": null,
"has_more": false
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}Enrichments
List enrichments
List your organisation’s enrichments, made here or on the Enrichment page of the playground (is_external says which), newest first.
Scope: enrichment:read or enrichment:write or enrichment:campaigns
GET
/
enrichments
cURL
pcall GET "/api/v1/partner/enrichments?status=active&limit=25"const res = await call("GET", "/api/v1/partner/enrichments?status=active&limit=25");
const { data } = await res.json();res = call("GET", "/api/v1/partner/enrichments?status=active&limit=25")
data = res.json()["data"]<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-bc.userecord.io/api/v1/partner/enrichments",
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/enrichments"
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/enrichments")
.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/enrichments")
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": [
{
"enrichment_id": "WF_EN_261121094822026AEDRUB86TQVSML",
"external_id": "enr-chennai-warehouse",
"name": "Warehouse talent pool - Chennai",
"description": "",
"status": "active",
"questions_status": "pending",
"delivery": {
"whatsapp": true,
"voice_call": true,
"sms": true
},
"schedule": {
"language": "english",
"start_time": "10:00",
"end_time": "18:00",
"days": [
"mon",
"tue",
"wed",
"thu",
"fri",
"sat"
],
"timezone": "Asia/Kolkata",
"max_retries": 3,
"retry_after_hours": 4
},
"question_count": 2,
"counts": {
"campaigns": 0,
"candidates": 0,
"sent": 0,
"completed": 0
},
"is_external": true,
"created_at": "2026-11-10T10:15:30.000Z",
"updated_at": "2026-11-10T10:15:30.000Z"
}
],
"count": 1,
"total": 1,
"next_cursor": null,
"has_more": false
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}Authorizations
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).

