Endpoints

Person records

Fetch full person records by internal id, or resolve LinkedIn URLs and names.

POST/v1/entities/persons

Look up persons by id

Scope: dsp.entities.read

Use it when you already know which people you want (by internal id, LinkedIn URL or name) and need their full records. Outcome: one result per id you sent, in order. Found records sit under matches; misses are reported as found: false with an empty list rather than dropped. Worked use cases: Record Lookup guide.

How ids are read depends on by:

byids are
omittedThe platform's own internal (prism) ids
li_urlLinkedIn profile URLs
namePerson names
autoClassified entry by entry (the same detection /v1/similar applies to anchors)

There is no by: "domain" here: a person has no domain, so it is refused with a 422. For companies, see Company records.

The id on a search hit or an agent-run row is not an internal id: for a person it is an opaque hash, so it does not resolve with by omitted. Send the hit's linkedin_url with "by": "li_url" instead. See Chaining from search.

Request#

by"auto" | "li_url" | "name" | null

When set, ids are raw identifier values instead of prism's internal id: auto classifies each one independently (mirrors the anchor detection /v1/similar uses); any other value forces every entry to that one kind. Omit for the default: ids are prism ids. The id on a search or similar hit is not a prism id (it is the company's domain or an opaque 16-hex hash), so look a hit up by its own fields instead: a company with by: domain and its domain, a person with by: li_url and its linkedin_url.

fieldsarray of string | null

Restrict the returned fields. Omit for the full record.

idsarray of string, ≥ 1, ≤ 1000required

Headers

Idempotency-Keystring

Makes a retry safe. Send a unique value per request and reuse it when you retry that same request: with the same body and credential, on the same UTC day, rows already charged are not charged again.

Idempotency-Key is optional. Send it when you might retry: the same key, on the same request, from the same credential, on the same UTC day is not charged again for records already paid for. See Retries.

Response#

Each results[] row is an EntityHit: the echoed input (id), whether it resolved (found), and the person record under matches, restricted to your fields projection when you sent one, the full record otherwise.

matches is always a list, so a caller reads one field whatever it asked for. A person lookup puts at most one record in it: an internal id or a LinkedIn URL identifies one person, and by: "name" returns the best-ranked match for each name. A name is not a unique key, so check the record you get back (title, company, location) before you rely on it.

attributionarray of Attribution
as_ofstring | null
domainstring | null
quotestring | null

RESERVED for per-fact citation. Always null in v1.

source_corpusSourceCorpus

Where content came from. Closed set — it appears in attribution[]. The first four are the GTM entity graph. The rest are the document corpora behind the non-entity categories, each a distinct index with its own refresh cadence — which is the reason they are named separately rather than lumped under one label: attribution[].as_of means nothing if two corpora updated a month apart share a name.

urlstring | null

RESERVED for per-fact citation. Always null in v1.

columnsarray of object | null

The answer table's columns, in order, when a run carries extra columns beyond the entity's own fields -- a job-opening link, a value joined from another dataset. Each entry is {name, description, source}; the value for each sits on every row in results keyed by the column name. Null means a plain entity table. Additive, so it breaks no existing client.

coverageCoverage | null

How much of the addressable set this answer represents. Null means coverage was not measured for this request -- fast and auto do not enumerate -- and never that coverage was zero. Additive, so it breaks no existing client.

auditedbooleandefault: false

Whether the query was checked against the executed filter for dropped requirements. Reported because an empty constraints_unmet only means something if something looked.

constraints_unmetarray of string

Requirements in your query that the search could not express, in your own words. Non-empty means part of the question was not answered -- most often because it needs a dataset this search cannot reach (job postings, employment history, patents, news, funding dates). When this is non-empty, universe_exhausted is withheld: 'we returned everything that matches' cannot be true of a question that was never asked.

criteriaarray of object

Per criterion: evaluated, passed, success_rate, and whether it was *proven* by the query or *judged* by a model. Without this a thin result leaves the caller guessing which requirement thinned it.

enumeratedinteger

How many of them this answer carries. ≥ 0.

enumeration_recallnumber | null

enumerated / universe. Null when the universe was not exact, because a ratio over an estimate is not a recall figure. Note this measures coverage of the *resolved query*, not of the user's intent -- a wrong predicate can be exhaustively enumerated. ≥ 0, ≤ 1.

linkagearray of object

One entry per other dataset this answer joined against: corpus, join_key, observable, of_constrained, ratio, is_lower_bound. ratio is the fraction of your matching accounts that dataset can even see -- measured at 5-60% depending on the dataset and how large the companies are, and never 100%. Non-empty therefore means universe_exhausted is withheld by construction: we returned everything reachable, and a dataset cannot see the rest.

linkage_coveragenumber | null

The joins combined, as a product rather than a minimum: two datasets seeing 27% and 24% of your accounts jointly see about 6.5%, not 24%. Null when no join was performed or when any leg's coverage is unknown.

linkage_coverage_is_lower_boundbooleandefault: false

True when a key set was capped or coverage was estimated rather than measured, making linkage_coverage a floor. Narrowing the question makes it exact.

similarityarray of object

Narrowings done by ranking rather than by predicate. Each entry carries the concept, how many ids it resolved to, the k asked for, whether the list was cut at that ceiling, and the fraction of candidates that could be compared at all. Non-empty means universe_exhausted is withheld on purpose: a cosine is a degree, so a top-k ranking has no complete state, and 2.9% of companies carry no embedding to compare.

truncated_bystring | null

Which limit stopped the enumeration short, when one did.

universeinteger

Records matching the resolved query, counted, not sampled. ≥ 0.

universe_exhaustedbooleandefault: false

Every matching record was returned and the count agrees. The claim an unbounded-corpus search engine cannot make.

universe_is_exactboolean

False when the count hit a cap. Always serialized: a capped count presented as exact is the same lie as an unmeasured one.

degradationarray of Degradation
detailstring
impact"recall" | "precision" | "freshness" | "fields"
reasonDegradationReason

Why an answer is less than it should be. Closed, because a client that cannot branch on the reason can only show the user a shrug. These are the honest constraints — partial vector coverage, smry mapped as keyword so it cannot be scored lexically, a federated corpus being unreachable — surfaced at runtime instead of in a footnote.

source_corpusSourceCorpus | null
has_moreboolean
metaResponseMeta

Present on every 2xx, including the ones that are not paginated.

as_ofstring
credential"api_key" | "session"default: api_key

Which credential produced this response. session means the dashboard playground ran it as the signed-in user rather than as an API key — so it is billed to the user, subject to interactive rate limits, and carries no integration compatibility guarantee. Additive and defaulted, so it breaks no existing client.

credits_chargednumber | null

What this request cost, in credits, to at most three decimals. 0 when it cost nothing: a Basic or AI search that found nothing, rows this search already paid for (a cursor sent again, or a request repeated with the same Idempotency-Key on the same UTC day), or a test key. A request without a cursor or a repeated key is a new search, so keep the first page rather than asking for it again. null on a free endpoint.

environment"live" | "test"

Echoed on every response so a developer can never mistake a test-key result for a live one.

request_idstring
next_cursorstring | null

Opaque and signed. Invariant: has_more == (next_cursor is not None). There is no page or offset parameter — not accepted, not deprecated, never present.

resolved_searchResolvedSearch | null
categoryEntityCategory

*What* to search, and what a returned row is. One parameter carries both, because they are the same fact: a search of patent returns patents. The alternative — a source/vertical selector beside a narrower category — lets a caller ask for patents from the people index, a combination that has no meaning and would need rejecting at runtime. A closed set that cannot express the contradiction is better than a validator that catches it. Values are exactly prism's own row types, so category in the request and results[].category in the response are always the same string. company and person are the GTM index; the rest are separate corpora with their own filters, freshness and coverage. Not everything applies everywhere: see SearchRequest, which rejects the GTM-only parameters rather than ignoring them. job_opening is a document corpus like patent/news_article/etc — a posting, not an entity — but its records carry a domain (the posting company's) all the same. It is deliberately not in GTM_CATEGORIES (that set is about the entity/document distinction, and a job posting is still a document), but it *is* in DOMAIN_FILTERABLE_CATEGORIES, which exists specifically to separate those two axes.

conflictsarray of object
filtersFilters
filters_source"caller" | "parser" | "caller+parser" | "none"default: none
mode"fast" | "auto" | "deep"

How hard to work on the query. The distinction is *what the words mean*, not how many results come back: - fast — match my words. The query is matched by meaning (vector retrieval, falling back to keywords where vectors are unavailable); no LLM in the path, so nothing is extracted into filters. - auto — understand my intent. The parser extracts filters. - deep — reason about it. Multi-step, slowest, most expensive. fast was very nearly defined as "filters only, no LLM", which would have made query — the primary parameter — silently inert. A parameter that does nothing is worse than one that is missing.

overridesarray of object
parser_versionstring
querystring | null
semantic_querystring | null
semantic_scope"company" | "person" | null
sortarray of object
resultsarray of EntityHit[PersonRecord]
categoryEntityCategory

*What* to search, and what a returned row is. One parameter carries both, because they are the same fact: a search of patent returns patents. The alternative — a source/vertical selector beside a narrower category — lets a caller ask for patents from the people index, a combination that has no meaning and would need rejecting at runtime. A closed set that cannot express the contradiction is better than a validator that catches it. Values are exactly prism's own row types, so category in the request and results[].category in the response are always the same string. company and person are the GTM index; the rest are separate corpora with their own filters, freshness and coverage. Not everything applies everywhere: see SearchRequest, which rejects the GTM-only parameters rather than ignoring them. job_opening is a document corpus like patent/news_article/etc — a posting, not an entity — but its records carry a domain (the posting company's) all the same. It is deliberately not in GTM_CATEGORIES (that set is about the entity/document distinction, and a job posting is still a document), but it *is* in DOMAIN_FILTERABLE_CATEGORIES, which exists specifically to separate those two axes.

foundboolean
idstring
matchesarray of PersonRecord
account_citystring | null
account_countrystring | null
account_locationstring | null
account_namestring | null
account_regionarray of string
account_statestring | null
avatarstring | null
biostring | null
business_classificationstring | null
certification_detailsarray of CertificationDetail
datestring | null
issuerstring | null
namestring | null
certificationsarray of string
citystring | null
cmp_idstring | null
companyCompanyRecord | null
account_namestring | null
acquired_byarray of Deal
amount_usdnumber | null
announced_onstring | null
companystring | null
acquisitionsarray of Deal
amount_usdnumber | null
announced_onstring | null
companystring | null
business_classificationstring | null
business_modelsarray of string
citystring | null
clientsarray of string
company_keywordarray of string
company_typesarray of string
countrystring | null
department_headcountobject | null
descriptionstring | null
domainstring | null
employee_countinteger | null
employee_rangeEmployeeRange | null
maxinteger | null
mininteger | null
employees_by_countryobject | null
facebook_urlstring | null
founded_yearinteger | null
funding_roundsarray of FundingRound
amount_usdnumber | null
announced_onstring | null
investorsarray of string
typestring | null
funding_stagestring | null
global_presenceGlobalPresence | null
countriesarray of string
country_countintegerdefault: 0
hq_countrystring | null
govt_non_govtstring | null
growth_stagestring | null
idstring | null
industrystring | null
investorsarray of string
ipo_statusstring | null
job_openingsstring | integer | null
last_funding_amountnumber | null
last_funding_datestring | null
latitudenumber | null
legal_namestring | null
linkedin_followersinteger | null
linkedin_urlstring | null
locationstring | null
logostring | null
longitudenumber | null
naicsarray of string
office_locationsarray of OfficeLocation
addressstring | null
citystring | null
countrystring | null
operating_statusstring | null
other_industriesarray of string
ownershipstring | null
parent_organizationOrganisation | null
namestring | null
typestring | null
partnershipsarray of string
postal_codestring | null
productsarray of Product
descriptionstring | null
namestring | null
profit_non_profitstring | null
regionarray of string
revenuenumber | null
revenue_rangeRevenueRange | null
maxnumber | null
minnumber | null
short_descriptionstring | null
sicarray of string
statestring | null
street_addressstring | null
sub_industrystring | null
subsidiariesarray of Organisation
namestring | null
typestring | null
suppliersarray of string
technologyarray of string
total_fundingnumber | null
twitter_urlstring | null
websitestring | null
company_keywordarray of string
company_linkedin_urlstring | null
contact_namestring | null
countrystring | null
departmentstring | null
descriptionstring | null
domainstring | null
educationarray of EducationEntry
degreestring | null
descriptionstring | null
end_datestring | null
schoolstring | null
start_datestring | null
employee_countinteger | null
employee_rangeEmployeeRange | null
maxinteger | null
mininteger | null
employment_historyarray of EmploymentEntry
company_domainstring | null
company_linkedin_urlstring | null
company_namestring | null
descriptionstring | null
end_datestring | null
is_primarybooleandefault: false
start_datestring | null
titlestring | null
employment_typestring | null
first_namestring | null
founded_yearinteger | null
funding_stagestring | null
global_presenceGlobalPresence | null
countriesarray of string
country_countintegerdefault: 0
hq_countrystring | null
governance_levelstring | null
govt_non_govtstring | null
has_direct_access_to_c_suiteboolean | null
idstring | null
industrystring | null
job_openingsstring | integer | null
last_funding_amountnumber | null
last_funding_datestring | null
last_namestring | null
linkedin_connectionsinteger | null
linkedin_followersinteger | null
linkedin_urlstring | null
locationstring | null
naicsarray of string
other_industriesarray of string
ownershipstring | null
person_idstring | null
position_start_datestring | null
postal_codestring | null
prior_companyarray of string
profit_non_profitstring | null
regionarray of string
revenuenumber | null
senioritystring | null
sicarray of string
skillsarray of string
statestring | null
sub_departmentstring | null
sub_industrystring | null
technologyarray of string
titlestring | null
total_fundingnumber | null
universityarray of string
suggestionSearchSuggestion | null

A better way to have asked this question -- a different category (kind: search), or agentic search via POST /v1/agents (kind: agentic). Advisory: these results came from the search that was asked for, whatever this says. Null when there is nothing worth suggesting, which is the common case. Additive, so it breaks no existing client.

categoryEntityCategory | null

The category to search instead. Set iff kind is search.

kind"search" | "agentic"

search — a different category fits. agentic — no single search fits; use POST /v1/agents.

messagestring

One ready-to-show sentence.

totalinteger

≥ 0.

total_is_estimateboolean

Always serialized, never defaulted away. A field clients can forget exists is a field that renders an estimate as exact.

Errors#

StatusCodeSummary
401auth.unauthorizedNo usable credential (cause deliberately unspecified)
402credits.insufficientThe allocation cannot fund this action
403auth.browser_originA secret key was used from a browser
403auth.insufficient_scopeThe credential does not hold the required scope
422pagination.cursor_invalidThe cursor could not be read (e.g. a filter changed mid-pagination)
422request.invalidA field failed validation (extra.errors has the detail)
429quota.burst_exceededInteractive burst limit hit — wait Retry-After seconds
503credits.unavailableThe billing service could not confirm the charge; retry with the same Idempotency-Key
503upstream.unavailableThe retrieval engine is unreachable (not charged)
504upstream.timeoutThe retrieval engine did not answer in time (not charged)