Skip to main content
GET
Get a company’s ICP assessment

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.

Headers

If-None-Match
string

The ETag of an answer you kept. While the answer is still the same, the API answers 304 Not Modified with no body. Several tags, separated by commas, a weak tag (W/"…") and * are accepted.

Path Parameters

companyId
string<uuid>
required

The company’s id.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Query Parameters

icpProfileId
string<uuid>

Assess against this ICP profile. Without it, the workspace’s one active profile.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
icpProfileVersionId
string<uuid>

Assess against this exact version of the profile. Without it, the profile’s current version.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Response

A company’s stored ICP assessment, or the news that there is none yet.

A company’s stored ICP assessment, or the news that there is none yet.

status
string
required

The company has been assessed.

Allowed value: "ok"
evaluatedAt
string<date-time>
required

When the assessment was made.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
companyId
string
required

The company assessed.

companyName
string
required

The company’s name.

icpProfileId
string
required

The ICP profile it was assessed against.

icpProfileName
string
required

The profile’s name.

icpProfileVersionId
string
required

The exact version of the profile.

versionNumber
integer
required

That version’s number.

Required range: -9007199254740991 <= x <= 9007199254740991
score
number | null
required

The fit score, 0 to 100; null when none can be given.

verdict
enum<string>
required

How well the company fits.

Available options:
strong_fit,
possible_fit,
weak_fit,
disqualified,
insufficient_data
coverage
number
required

How much of the profile could be assessed, 0 to 1.

coverageNote
string
required

What the coverage means, in words.

criteriaAssessed
integer
required

How many criteria could be assessed.

Required range: -9007199254740991 <= x <= 9007199254740991
criteriaTotal
integer
required

How many criteria the profile version has.

Required range: -9007199254740991 <= x <= 9007199254740991
breakdown
object[]
required

How the company fared on each criterion.

unknowns
object[]
required

The criteria that could not be assessed.

disqualifiedBy
string[]
required

What disqualified the company, if anything.

qualitativeFollowUp
string | null
required

What a person should check by hand; null when nothing.

rights
object
required

Whether the evidence may still be shown in full.