Skip to main content
POST
Company Search - FullEnrich

Authorizations

Authorization
string
header
default:YOUR_ANYAPI_KEY
required

Your AnyAPI key as a Bearer token.

Headers

Idempotency-Key
string

Optional wallet idempotency key, scoped to this customer for 24 hours. When the gateway honors the key, this synchronous in-process execution can continue after the caller disconnects, bounded by its execution deadline. A completed replayable result charges normally exactly once and can be replayed without another provider run or charge. A pending duplicate returns 409 idempotency_in_progress; reuse with different request semantics returns 409 idempotency_conflict.

Required string length: 1 - 255

Query Parameters

fields
string

Optional. Comma-separated keys (dotted paths like author.name descend into nested objects) to keep on each result item. Keys are matched relative to each result item after the data/items envelope is unwrapped, not against the top-level response envelope, so use jq to reshape the whole envelope. Shrinks the response without changing cost.

max_items
integer

Optional. Cap the number of result rows returned; a _truncated note reports how many were withheld so you can page via the API's own limit. Does not change cost.

Required range: x >= 0
summary
boolean

Optional. Return only a structural outline (top-level keys, item counts, and per-field byte sizes) instead of the full data. Does not change cost.

jq
string

Optional. A jq expression applied to the result envelope; its output replaces output (multiple outputs collect into an array). Reshape freely, e.g. jq=.data | {title, description, md: .markdown[:3500]}. Runs sandboxed with a 250ms / 2MB budget; on failure the full result is returned with a jqError. Does not change cost.

Body

application/json
companyIds
object[]

Filter by FullEnrich company id. Each entry is an object taking a value string and an optional exact_match boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected.

cursor
string

Cursor from a previous response's nextCursor. Works at any depth, including past the 10000 offset ceiling.

domains
object[]

Filter by company domain, e.g. stripe.com. Each entry is an object taking a value string and an optional exact_match boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected.

foundedYears
object[]

Filter by founding year. Each entry is an object taking a value string and an optional exact_match boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected.

headcounts
object[]

Filter by employee headcount band. Each entry is an object taking a value string and an optional exact_match boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected.

headquartersLocations
object[]

Filter by headquarters city, region or country. Each entry is an object taking a value string and an optional exact_match boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected.

industries
object[]

Filter by company industry, e.g. Software Development. Each entry is an object taking a value string and an optional exact_match boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected.

keywords
object[]

Filter by words in the company description. Each entry is an object taking a value string and an optional exact_match boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected.

limit
integer
default:10

Rows to return on this page, up to FullEnrich's maximum of 100. Every row returned is billed.

Required range: 1 <= x <= 100
linkedinUrls
object[]

Filter by company LinkedIn URL. Each entry is an object taking a value string and an optional exact_match boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected.

names
object[]

Filter by company name. Each entry is an object taking a value string and an optional exact_match boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected.

offset
integer
default:0

Rows to skip. FullEnrich caps offset at 10000; past that, page with cursor.

Required range: x >= 0
preferLatencyUnderMs
integer

Optional; omit it and routing is unchanged, with the cheapest source serving. Prefer sources whose typical response time (median over the trailing 30 days, as published on this endpoint's lane health) is under this many milliseconds; among those, the cheapest serves. This can raise your price: when the cheapest source misses the target, a faster and dearer one serves, and you are quoted and charged its price. If no source is that fast the request is still served, by whichever source offers the best speed for its price - it is never refused for being slow. Sources we have not timed are tried last. This is a preference, not a guarantee: the median describes past requests and is not a ceiling on this one, and it excludes any wait this request itself asks for. On a paginated walk it applies to the first page only: later pages stay with the source that page chose, at the price it was quoted.

Required range: x >= 1
specialties
object[]

Filter by company specialty. Each entry is an object taking a value string and an optional exact_match boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected.

types
object[]

Filter by ownership type, e.g. Public Company, Privately Held, Nonprofit. Each entry is an object taking a value string and an optional exact_match boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected.

Response

Normalized result.

costUsd
number
required

USD charged on the original run. On a replay this value is echoed for parity; the replay itself is free.

items
integer
required

Number of result rows returned. For per-result SKUs the per-item cost is charged against this count; for input-priced SKUs the charge is per submitted input, independent of this count.

output
Company Search - FullEnrich output · object | null
required

Normalized output, or null when the replay payload was not retained.

provider
string
required

Always "AnyAPI".

replayed
boolean
required

True when this response replays the durable result of an earlier run without billing or upstream execution.

hint
string

Optional one-line nudge, absent when there is nothing to say. large_result: suggests the fields/max_items/summary/jq controls for a big response. paging_unavailable: means this result came from a source that cannot return a nextCursor, so it may be INCOMPLETE and cannot be continued - re-run with requireCursor: true to be served only by a source that can page, which may cost more per request.

jqError
string

Present only when a jq expression failed; output then carries the full unshaped result and this explains why the reshape did not apply.

resultId
string

Opaque handle to the full unshaped result, cached ~15 min. Re-shape it for free (fields/max_items/summary/jq) via GET /v1/results/{id}, no re-billing. Absent when the result was too large to cache.