Skip to main content
POST
Preview an export

Authorizations

Authorization
string
header
required

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 needs crm: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

application/json

The record type and source to sample.

objectType
enum<string>
required

The record type to preview.

Available options:
company,
contact,
company_candidate
source
any

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.

columns
string[]
required

The CSV columns: the field keys, in order.

sampleRows
string[][]
required

Up to 10 rows, each cell escaped exactly as the CSV file would hold it.

recordCount
number
required

How many records the sample was drawn from: the selection, or the first page.

warnings
string[]
required

empty_result when no record matches.