cURL
pcall GET "/api/v1/partner/enrichment-credits/usage?enrichment_id=WF_EN_261121094822026AEDRUB86TQVSML&campaign_id=EC_261121095438377TFUX07WN2XT42V&from=2026-11-01T00%3A00%3A00.000Z&limit=25"const res = await call("GET", "/api/v1/partner/enrichment-credits/usage?enrichment_id=WF_EN_261121094822026AEDRUB86TQVSML&campaign_id=EC_261121095438377TFUX07WN2XT42V&from=2026-11-01T00%3A00%3A00.000Z&limit=25");
const { data } = await res.json();res = call("GET", "/api/v1/partner/enrichment-credits/usage?enrichment_id=WF_EN_261121094822026AEDRUB86TQVSML&campaign_id=EC_261121095438377TFUX07WN2XT42V&from=2026-11-01T00%3A00%3A00.000Z&limit=25")
data = res.json()["data"]<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-bc.userecord.io/api/v1/partner/enrichment-credits/usage",
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/enrichment-credits/usage"
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/enrichment-credits/usage")
.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/enrichment-credits/usage")
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": [
{
"usage_id": "LGR_0f1c2d3e4a5b6c7d",
"type": "debit",
"description": "Enrichment assigned",
"credits": -8,
"quantity": 1,
"unit_price": 8,
"balance_after": 492,
"enrichment_id": "WF_EN_261121094822026AEDRUB86TQVSML",
"campaign_id": "EC_261121095438377TFUX07WN2XT42V",
"candidate_id": "6f1d2c3e-8a4b-4c57-9d10-2b7e5a9c1f33",
"mode": "live",
"created_at": "2026-11-10T11:00:30.000Z",
"effective_at": "2026-11-10T11:00:30.000Z"
}
],
"count": 1,
"total": 1,
"next_cursor": null,
"has_more": false,
"summary": {
"net_credits": -8
}
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}Credits
Where your enrichment credits were used
One row for every candidate added to an enrichment campaign, newest first, in the wallet of the key you signed with. credits is negative when credits were spent and positive when they were given back. summary.net_credits adds up every row that matches your filters, not only the page you are on. An id from another organisation returns an empty list. This call changes nothing.
Scope: enrichment:credits
GET
/
enrichment-credits
/
usage
cURL
pcall GET "/api/v1/partner/enrichment-credits/usage?enrichment_id=WF_EN_261121094822026AEDRUB86TQVSML&campaign_id=EC_261121095438377TFUX07WN2XT42V&from=2026-11-01T00%3A00%3A00.000Z&limit=25"const res = await call("GET", "/api/v1/partner/enrichment-credits/usage?enrichment_id=WF_EN_261121094822026AEDRUB86TQVSML&campaign_id=EC_261121095438377TFUX07WN2XT42V&from=2026-11-01T00%3A00%3A00.000Z&limit=25");
const { data } = await res.json();res = call("GET", "/api/v1/partner/enrichment-credits/usage?enrichment_id=WF_EN_261121094822026AEDRUB86TQVSML&campaign_id=EC_261121095438377TFUX07WN2XT42V&from=2026-11-01T00%3A00%3A00.000Z&limit=25")
data = res.json()["data"]<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-bc.userecord.io/api/v1/partner/enrichment-credits/usage",
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/enrichment-credits/usage"
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/enrichment-credits/usage")
.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/enrichment-credits/usage")
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": [
{
"usage_id": "LGR_0f1c2d3e4a5b6c7d",
"type": "debit",
"description": "Enrichment assigned",
"credits": -8,
"quantity": 1,
"unit_price": 8,
"balance_after": 492,
"enrichment_id": "WF_EN_261121094822026AEDRUB86TQVSML",
"campaign_id": "EC_261121095438377TFUX07WN2XT42V",
"candidate_id": "6f1d2c3e-8a4b-4c57-9d10-2b7e5a9c1f33",
"mode": "live",
"created_at": "2026-11-10T11:00:30.000Z",
"effective_at": "2026-11-10T11:00:30.000Z"
}
],
"count": 1,
"total": 1,
"next_cursor": null,
"has_more": false,
"summary": {
"net_credits": -8
}
}
}{
"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).

