curl --request POST \
--url https://api.enrik.ai/v1/export-jobs/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"objectType": "company",
"source": {
"sourceType": "selected_rows",
"recordIds": [
"0199bbbb-0000-7000-8000-000000000001"
],
"fieldKeys": [
"fixed.name"
]
}
}
'import requests
url = "https://api.enrik.ai/v1/export-jobs/preview"
payload = {
"objectType": "company",
"source": {
"sourceType": "selected_rows",
"recordIds": ["0199bbbb-0000-7000-8000-000000000001"],
"fieldKeys": ["fixed.name"]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
objectType: 'company',
source: {
sourceType: 'selected_rows',
recordIds: ['0199bbbb-0000-7000-8000-000000000001'],
fieldKeys: ['fixed.name']
}
})
};
fetch('https://api.enrik.ai/v1/export-jobs/preview', 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.enrik.ai/v1/export-jobs/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'objectType' => 'company',
'source' => [
'sourceType' => 'selected_rows',
'recordIds' => [
'0199bbbb-0000-7000-8000-000000000001'
],
'fieldKeys' => [
'fixed.name'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.enrik.ai/v1/export-jobs/preview"
payload := strings.NewReader("{\n \"objectType\": \"company\",\n \"source\": {\n \"sourceType\": \"selected_rows\",\n \"recordIds\": [\n \"0199bbbb-0000-7000-8000-000000000001\"\n ],\n \"fieldKeys\": [\n \"fixed.name\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.enrik.ai/v1/export-jobs/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"objectType\": \"company\",\n \"source\": {\n \"sourceType\": \"selected_rows\",\n \"recordIds\": [\n \"0199bbbb-0000-7000-8000-000000000001\"\n ],\n \"fieldKeys\": [\n \"fixed.name\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.enrik.ai/v1/export-jobs/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"objectType\": \"company\",\n \"source\": {\n \"sourceType\": \"selected_rows\",\n \"recordIds\": [\n \"0199bbbb-0000-7000-8000-000000000001\"\n ],\n \"fieldKeys\": [\n \"fixed.name\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"columns": [
"fixed.name"
],
"sampleRows": [
[
"Example"
]
],
"recordCount": 1,
"warnings": []
}{
"error": {
"code": "malformed_json",
"message": "Bad Request",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "unauthenticated",
"message": "Unauthorized",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "insufficient_scope",
"message": "Forbidden",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "payload_too_large",
"message": "Payload Too Large",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "unsupported_media_type",
"message": "Unsupported Media Type",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "validation_error",
"message": "Unprocessable Entity",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "internal_error",
"message": "Internal Server Error",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "service_unavailable",
"message": "Service Unavailable",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "not_found",
"message": "Not found",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}Preview an export
Resolves up to 10 records of a source and escapes them as the CSV file would. Creates no job, file or delivery, and counts against no quota.
curl --request POST \
--url https://api.enrik.ai/v1/export-jobs/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"objectType": "company",
"source": {
"sourceType": "selected_rows",
"recordIds": [
"0199bbbb-0000-7000-8000-000000000001"
],
"fieldKeys": [
"fixed.name"
]
}
}
'import requests
url = "https://api.enrik.ai/v1/export-jobs/preview"
payload = {
"objectType": "company",
"source": {
"sourceType": "selected_rows",
"recordIds": ["0199bbbb-0000-7000-8000-000000000001"],
"fieldKeys": ["fixed.name"]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
objectType: 'company',
source: {
sourceType: 'selected_rows',
recordIds: ['0199bbbb-0000-7000-8000-000000000001'],
fieldKeys: ['fixed.name']
}
})
};
fetch('https://api.enrik.ai/v1/export-jobs/preview', 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.enrik.ai/v1/export-jobs/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'objectType' => 'company',
'source' => [
'sourceType' => 'selected_rows',
'recordIds' => [
'0199bbbb-0000-7000-8000-000000000001'
],
'fieldKeys' => [
'fixed.name'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.enrik.ai/v1/export-jobs/preview"
payload := strings.NewReader("{\n \"objectType\": \"company\",\n \"source\": {\n \"sourceType\": \"selected_rows\",\n \"recordIds\": [\n \"0199bbbb-0000-7000-8000-000000000001\"\n ],\n \"fieldKeys\": [\n \"fixed.name\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.enrik.ai/v1/export-jobs/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"objectType\": \"company\",\n \"source\": {\n \"sourceType\": \"selected_rows\",\n \"recordIds\": [\n \"0199bbbb-0000-7000-8000-000000000001\"\n ],\n \"fieldKeys\": [\n \"fixed.name\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.enrik.ai/v1/export-jobs/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"objectType\": \"company\",\n \"source\": {\n \"sourceType\": \"selected_rows\",\n \"recordIds\": [\n \"0199bbbb-0000-7000-8000-000000000001\"\n ],\n \"fieldKeys\": [\n \"fixed.name\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"columns": [
"fixed.name"
],
"sampleRows": [
[
"Example"
]
],
"recordCount": 1,
"warnings": []
}{
"error": {
"code": "malformed_json",
"message": "Bad Request",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "unauthenticated",
"message": "Unauthorized",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "insufficient_scope",
"message": "Forbidden",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "payload_too_large",
"message": "Payload Too Large",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "unsupported_media_type",
"message": "Unsupported Media Type",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "validation_error",
"message": "Unprocessable Entity",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "internal_error",
"message": "Internal Server Error",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "service_unavailable",
"message": "Service Unavailable",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}{
"error": {
"code": "not_found",
"message": "Not found",
"requestId": "5b1d3c1e-8d6f-4f2a-9a57-3a9b1f2c7d10"
}
}Authorizations
An Enrik API key, sent as Authorization: Bearer <key>. A key reaches public operations only, and only those whose scopes it holds. A few parameters need a scope beyond their operation’s, which the parameter names. The scopes:
setup:read: Read the workspace setup and its company profile.setup:run: Change the setup: confirm the company profile, authorize sponsored drafting and background company research, choose what to set up and complete setup.workspace:read: Read the workspace’s own profile: its health summary and setup state.crm:read: Read companies with their signals, contacts and the saved views over them.crm:write: Create, update and restore companies and contacts, and create, update and delete saved views.crm:delete: Delete companies and contacts.twin:read: Read the Company Twin: structured company knowledge and its signals.discovery:read: Read ICP profiles, ICP assessments, discovery briefs, discovery jobs, candidates and the signal library.discovery:write: Create and change ICP profiles, discovery briefs and signal-definition drafts, and review discovery candidates.discovery:run: Create, start and cancel discovery jobs, and edit a draft one. Uses provider budget.enrichment:read: Read the enrichment configuration and its results, including a record’s enrichment, formula and custom-API cells.enrichment:run: Launch and cancel enrichment. Spends enrichment credits.automation:read: Read workflows and agents with their run history, including a record’s agent cells.automation:run: Run existing workflows and agents.exports:read: Read export jobs and the fields an export can carry.exports:run: Create, preview, start, cancel and archive CSV exports of companies, contacts and candidates, and download the file. Also needscrm:read. Delivering an export to a webhook destination stays in the app.integrations:read: Read connections, field mappings, CRM sync jobs and webhook destinations.webhooks:read: Read webhook subscriptions, the event types they can name and their delivery log.webhooks:write: Subscribe a receiver URL to webhook events; edit, test, pause, resume and archive a subscription and rotate its signing secret; redeliver an event. Only workspace owners and admins can grant it.reporting:read: Read analytics and dashboards.assistant:read: Read the Assistant: its threads, messages and pending approvals.assistant:run: Converse with the Assistant. Uses the workspace’s AI quota.assistant:write: Approve or reject the changes the Assistant proposes.
Body
The record type and source to sample.
The record type to preview.
company, contact, company_candidate Which records and fields to export, validated against objectType: fieldKeys (1 to 100 keys from exportFields.getCatalogue) and sourceType, one of selected_rows with recordIds (up to 5000), saved_view with savedViewId (companies and contacts), table_filter with an optional filter, or discovery_job with discoveryJobId (candidates). Optional: maxRows (1 to 5000, the default), includeHeaders and includeProvenance (both true by default). An invalid source is 422 validation_error with details.code export_invalid_config, an unknown field export_invalid_field.
Response
Bounded escaped export sample; no write or delivery.
Bounded escaped export sample; no write or delivery.
The CSV columns: the field keys, in order.
Up to 10 rows, each cell escaped exactly as the CSV file would hold it.
How many records the sample was drawn from: the selection, or the first page.
empty_result when no record matches.
Was this page helpful?