AnyAPI apollo.person_enrich (Apollo Person Enrichment)

{ "bodyFields": { "allowFallbacks": { "default": true, "description": "Optional, default true. When false, only the sources listed in `source` may serve; the request is refused with no charge if none of them can. When true, the listed sources are tried first and any other source may serve after them, at the normal price.", "type": "boolean" }, "domain": { "description": "Organization domain used with the person's name.", "minLength": 1, "type": "string" }, "email": { "description": "Work or personal email used to identify the person.", "format": "email", "type": "string" }, "firstName": { "description": "Person first name, used with lastName and an organization identifier.", "minLength": 1, "type": "string" }, "ignoreSources": { "description": "Optional. Source ids to skip for this request, taken from this endpoint's `lanes[].source.id`. The cheapest remaining source serves and the price is that of the dearest remaining source. An id that does not serve this endpoint, or that is also in `source`, is rejected as invalid input with no charge; skipping every source is rejected the same way.", "items": { "minLength": 1, "type": "string" }, "type": "array", "uniqueItems": true }, "lastName": { "description": "Person last name, used with firstName and an organization identifier.", "minLength": 1, "type": "string" }, "linkedinUrl": { "description": "LinkedIn profile URL used to identify the person.", "format": "uri", "type": "string" }, "organizationName": { "description": "Organization name used with the person's name.", "minLength": 1, "type": "string" }, "preferLatencyUnderMs": { "description": "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.", "minimum": 1, "type": "integer" }, "source": { "description": "Optional. Source ids to prefer, in order, taken from this endpoint's `lanes[].source.id` in /catalog or /apis. Omit it and the cheapest source serves, with automatic failover. Listed sources are tried first in the order given, then the others, unless `allowFallbacks` is false. A single source with `allowFallbacks` false is served only by that source at its price, quoted and charged exactly, with no failover. The price is that of the dearest source that may serve. An id that does not serve this endpoint is rejected as invalid input with no charge; a listed source that is not serving right now is refused with no charge, so omit `source` to be served by another. On a paginated walk, later pages must include the source that served page one, or omit `source`.", "items": { "minLength": 1, "type": "string" }, "type": "array", "uniqueItems": true } }, "bodyType": "json", "discoverable": true, "method": "POST", "type": "http" }

{ "properties": { "costUsd": { "description": "USD charged on the original run. On a replay this value is echoed for parity; the replay itself is free.", "type": "number" }, "hint": { "description": "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 `requireFields: [\"nextCursor\"]` to be served only by a source that can page, which may cost more per request.", "type": "string" }, "items": { "description": "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.", "type": "integer" }, "jqError": { "description": "Present only when a `jq` expression failed; `output` then carries the full unshaped result and this explains why the reshape did not apply.", "type": "string" }, "output": { "anyOf": [ { "additionalProperties": false, "properties": { "data": { "oneOf": [ { "type": "null" }, { "properties": { "address": { "description": "Full address as one display string.", "type": "string" }, "catchAll": { "description": "Domain accepts all addresses.", "type": "boolean" }, "city": { "description": "City.", "type": "string" }, "confidence": { "description": "Apollo match confidence for this person: high, medium or low.", "type": "string" }, "country": { "description": "Country.", "type": "string" }, "departments": { "description": "Current departments.", "items": { "type": "string" }, "type": "array" }, "email": { "description": "Available work email.", "format": "email", "type": "string" }, "emailStatus": { "description": "Verification status of the work email.", "type": "string" }, "employmentHistory": { "description": "Known employment history.", "items": { "properties": { "current": { "description": "Whether this is a current role.", "type": "boolean" }, "endUtc": { "description": "UTC epoch timestamp in seconds (Unix time). Multiply by 1000 for a JS Date in milliseconds.", "type": "number" }, "id": { "description": "Stable employment record identifier.", "type": "string" }, "organizationId": { "description": "Organization identifier.", "type": "string" }, "organizationName": { "description": "Organization name.", "type": "string" }, "startUtc": { "description": "UTC epoch timestamp in seconds (Unix time). Multiply by 1000 for a JS Date in milliseconds.", "type": "number" }, "title": { "description": "Role title.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "type": "array" }, "facebookUrl": { "description": "Canonical Facebook profile URL.", "format": "uri", "type": "string" }, "firstName": { "description": "Person first name.", "type": "string" }, "functions": { "description": "Current business functions.", "items": { "type": "string" }, "type": "array" }, "githubUrl": { "description": "Canonical GitHub profile URL.", "format": "uri", "type": "string" }, "headline": { "description": "Professional headline.", "type": "string" }, "id": { "description": "Stable person identifier.", "type": "string" }, "image": { "description": "Profile image URL.", "format": "uri", "type": "string" }, "lastName": { "description": "Person last name.", "type": "string" }, "linkedinUrl": { "description": "Canonical LinkedIn profile URL.", "format": "uri", "type": "string" }, "name": { "description": "Full person name.", "type": "string" }, "organization": { "description": "Current organization summary.", "properties": { "alexaRanking": { "description": "Alexa global traffic rank of the organization website.", "type": "integer" }, "annualRevenue": { "description": "Estimated annual revenue in USD.", "minimum": 0, "type": "number" }, "annualRevenueDisplay": { "description": "Human-readable estimated annual revenue.", "type": "string" }, "city": { "description": "Headquarters city.", "type": "string" }, "country": { "description": "Headquarters country.", "type": "string" }, "description": { "description": "Organization summary.", "type": "string" }, "domain": { "description": "Primary organization domain.", "type": "string" }, "employeeCount": { "description": "Estimated employee count.", "minimum": 0, "type": "integer" }, "facebookUrl": { "description": "Canonical Facebook page URL.", "format": "uri", "type": "string" }, "foundedYear": { "description": "Year the organization was founded.", "type": "integer" }, "id": { "description": "Stable organization identifier.", "type": "string" }, "image": { "description": "Organization logo URL.", "format": "uri", "type": "string" }, "industries": { "description": "Industries associated with the organization.", "items": { "type": "string" }, "type": "array" }, "industry": { "description": "Primary industry.", "type": "string" }, "keywords": { "description": "Keywords associated with the organization.", "items": { "type": "string" }, "type": "array" }, "latestFundingStage": { "description": "Latest disclosed funding stage.", "type": "string" }, "latestFundingUtc": { "description": "UTC epoch timestamp in seconds (Unix time). Multiply by 1000 for a JS Date in milliseconds.", "type": "number" }, "linkedinId": { "description": "Organization LinkedIn numeric id.", "type": "string" }, "linkedinUrl": { "description": "Canonical LinkedIn company URL.", "format": "uri", "type": "string" }, "naicsCodes": { "description": "NAICS industry codes.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Organization name.", "type": "string" }, "phone": { "description": "Organization phone number in international format.", "type": "string" }, "postalCode": { "description": "Headquarters postal code.", "type": "string" }, "rawAddress": { "description": "Headquarters address as one display string.", "type": "string" }, "sicCodes": { "description": "SIC industry codes.", "items": { "type": "string" }, "type": "array" }, "state": { "description": "Headquarters state or region.", "type": "string" }, "streetAddress": { "description": "Street address.", "type": "string" }, "technologyNames": { "description": "Technologies detected at the organization.", "items": { "type": "string" }, "type": "array" }, "totalFunding": { "description": "Total disclosed funding in USD.", "minimum": 0, "type": "number" }, "totalFundingDisplay": { "description": "Human-readable total disclosed funding.", "type": "string" }, "twitterUrl": { "description": "Canonical X or Twitter profile URL.", "format": "uri", "type": "string" }, "websiteUrl": { "description": "Canonical organization website URL.", "format": "uri", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "personalEmails": { "description": "Available personal email addresses, included automatically.", "items": { "format": "email", "type": "string" }, "type": "array" }, "postalCode": { "description": "Postal code.", "type": "string" }, "seniority": { "description": "Current seniority classification.", "type": "string" }, "state": { "description": "State or region.", "type": "string" }, "streetAddress": { "description": "Street address.", "type": "string" }, "subdepartments": { "description": "Current subdepartments.", "items": { "type": "string" }, "type": "array" }, "timeZone": { "description": "IANA time-zone identifier.", "type": "string" }, "title": { "description": "Current job title.", "type": "string" }, "twitterUrl": { "description": "Canonical X or Twitter profile URL.", "format": "uri", "type": "string" } }, "required": [ "id", "name", "firstName", "lastName" ], "type": "object" } ] }, "found": { "description": "Whether a matching person was found.", "type": "boolean" }, "reason": { "description": "Present only when `found` is false, and says why there is no result. `not_found`: the source states the target does not exist, or returned nothing for it. A `found: false` answer is a successful call, not an error, and `costUsd` is what it actually cost.", "enum": [ "not_found" ], "type": "string" } }, "required": [ "found", "data" ], "title": "Apollo Person Enrichment output", "type": "object" }, { "type": "null" } ], "description": "Normalized output, or null when the replay payload was not retained." }, "provider": { "description": "Always \"AnyAPI\".", "type": "string" }, "replayed": { "description": "True when this response replays the durable result of an earlier run without billing or upstream execution.", "type": "boolean" }, "resultId": { "description": "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.", "type": "string" }, "source": { "description": "The source that served this run. Pass its `id` back as `source` to prefer it again, or as `ignoreSources` to avoid it. Absent when no source identity applies to the run.", "properties": { "artworkKey": { "description": "Key for this source's artwork.", "type": "string" }, "id": { "description": "Stable identifier for this source.", "type": "string" }, "kind": { "description": "anonymous is a stable identity for an unattributed source; brand names the dataset that supplies the data.", "enum": [ "anonymous", "brand" ], "type": "string" }, "name": { "description": "Display name for this source.", "type": "string" } }, "required": [ "id", "name", "kind", "artworkKey" ], "type": "object" } }, "required": [ "output", "provider", "costUsd", "items", "replayed" ], "type": "object" }