curl --request GET \
--url https://api.getoneprofile.ai/find-leads/enrichment-options/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.getoneprofile.ai/find-leads/enrichment-options/"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.getoneprofile.ai/find-leads/enrichment-options/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getoneprofile.ai/find-leads/enrichment-options/",
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>"
],
]);
$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.getoneprofile.ai/find-leads/enrichment-options/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-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.getoneprofile.ai/find-leads/enrichment-options/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/find-leads/enrichment-options/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"options": [
{
"already_covered": true,
"column_display_name": "<string>",
"credits_per_row": 123,
"description": "<string>",
"display_name": "<string>",
"key": "find_email",
"max_credits_per_row": 123,
"credits_for_rows": 123
}
],
"row_cost": {
"credits_per_row": 123,
"credits_for_rows": 123,
"credits_per_request": 0,
"rows_per_request": 1000
},
"unavailable_options": [
{
"display_name": "<string>",
"key": "find_email"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}List the enrichments offered at import
The enrichments a lead import can run, with the exact per-row credit price of each and whether its column already exists in the search’s own column plan (already_covered); unavailable_options, the ones that apply to this search but are not available right now and cannot be chosen; and row_cost: what the rows themselves cost before any enrichment. An import’s total is row_cost plus the chosen options, each counted once. Free to call.
curl --request GET \
--url https://api.getoneprofile.ai/find-leads/enrichment-options/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.getoneprofile.ai/find-leads/enrichment-options/"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.getoneprofile.ai/find-leads/enrichment-options/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getoneprofile.ai/find-leads/enrichment-options/",
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>"
],
]);
$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.getoneprofile.ai/find-leads/enrichment-options/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-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.getoneprofile.ai/find-leads/enrichment-options/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/find-leads/enrichment-options/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"options": [
{
"already_covered": true,
"column_display_name": "<string>",
"credits_per_row": 123,
"description": "<string>",
"display_name": "<string>",
"key": "find_email",
"max_credits_per_row": 123,
"credits_for_rows": 123
}
],
"row_cost": {
"credits_per_row": 123,
"credits_for_rows": 123,
"credits_per_request": 0,
"rows_per_request": 1000
},
"unavailable_options": [
{
"display_name": "<string>",
"key": "find_email"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
Query Parameters
Which dataset a search runs against, and so which provider serves it.
Values are persisted in String(16) columns, so every member must stay within 16 characters.
people, companies, signal_companies, signal_people, lookalikes, local_businesses, hiring_companies, backlinks, search_results, post_authors For a buying-signal search, the one signal it looks for. Ignored for every other search. Read only so already_covered also checks that signal's own columns.
64Response
Successful Response
The enrichments offered for one record type, and what the rows themselves cost.
Show child attributes
Show child attributes
What the rows cost on top of the enrichments chosen for them. Add it to the ticked options to quote an import: before this existed the screen quoted an enrichment subtotal and called it the total, which under-quoted every buying-signal and lookalike import by the larger half.
Show child attributes
Show child attributes
Enrichments that apply to this search but are not available right now, for any workspace. Listed so a picker can show them in their place, disabled, rather than drop them. None can be chosen: an import that asks for one is refused.
Show child attributes
Show child attributes
Was this page helpful?