Apollo People Search
anyapi_post_v1_run_apollo_people_searchSearch people by title, seniority, name, location, employer domain or id, email status, and employer revenue, technology, hiring, and headcount growth, with normalized profile summaries. Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| jq | No | 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. | |
| page | No | One-based result page. | |
| limit | No | Maximum people returned on this page. | |
| fields | No | Optional. Comma-separated keys (dotted paths like `author.name` descend into nested objects) to keep on each result item: each row of the API's result list, or the `data` object itself for an API that returns one record. Keys are matched relative to that item, not against the top-level response envelope, so use `jq` to reshape the whole envelope. Shrinks the response without changing cost. | |
| source | No | 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`. | |
| titles | No | Job titles to match. | |
| maxJobs | No | Maximum number of active job postings at the organization. | |
| minJobs | No | Minimum number of active job postings at the organization. | |
| summary | No | 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. | |
| keywords | No | Keywords to match across people records. | |
| max_items | No | 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`. An API that returns one record is not trimmed. Does not change cost. | |
| personName | No | Person name to match; results include people whose name contains every word. | |
| seniorities | No | Seniority levels to match. | |
| max_cost_usd | No | Optional. The most you are willing to pay for this one request, in US dollars (for example 0.05). Any route that would charge more than this is not used, so a request only ever runs on something you can afford. If nothing is available at or below your amount, the request is refused before it runs, nothing is charged, and the message tells you the cheapest price per request so you can raise it. Leave it out to accept the normal price. | |
| emailStatuses | No | Email statuses to match. | |
| ignoreSources | No | 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. | |
| maxRevenueUsd | No | Maximum organization annual revenue, in whole USD with no symbols. | |
| minRevenueUsd | No | Minimum organization annual revenue, in whole USD with no symbols. | |
| allowFallbacks | No | 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. | |
| employeeRanges | No | Organization employee-count ranges in Apollo notation, such as 51,200. | |
| jobPostedAtGte | No | Only organizations with a job posted on or after this date. Format: YYYY-MM-DD. | |
| jobPostedAtLte | No | Only organizations with a job posted on or before this date. Format: YYYY-MM-DD. | |
| Idempotency-Key | No | 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. | |
| organizationIds | No | Apollo identifiers of the person's current employer. | |
| personLocations | No | Person locations to match. | |
| jobPostingTitles | No | Job titles listed in the organization's active job postings, such as sales manager. | |
| technologySlugOr | No | Only people whose current employer uses ANY of these technologies. Apollo technology identifiers, such as salesforce or google_analytics (spaces and periods become underscores). The technologies output of the Apollo organization SKUs returns them as id. | |
| technologySlugAnd | No | Only people whose current employer uses ALL of these technologies. Apollo technology identifiers, such as salesforce or google_analytics (spaces and periods become underscores). The technologies output of the Apollo organization SKUs returns them as id. | |
| technologySlugNot | No | Exclude people whose current employer uses any of these technologies. Apollo technology identifiers, such as salesforce or google_analytics (spaces and periods become underscores). The technologies output of the Apollo organization SKUs returns them as id. | |
| jobPostingLocations | No | Locations of the organization's active job postings, such as japan. | |
| organizationDomains | No | Domains of the person's current or previous employer, without www, at most 1000. | |
| includeSimilarTitles | No | Whether titles similar to the ones in titles also match. Set false for strict title matches only. | |
| preferLatencyUnderMs | No | 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. | |
| headcountGrowthMonths | No | Trailing window in months for the headcount growth filter. Takes effect only together with minHeadcountGrowthPercent or maxHeadcountGrowthPercent. | |
| organizationLocations | No | Organization headquarters locations to match. | |
| lookalikeOrganizationIds | No | Apollo organization identifiers to use as lookalike seeds, at most five. Results are narrowed to organizations similar to the seeds, and the seeds themselves are excluded. A seed Apollo holds no lookalike data for returns no results. | |
| maxHeadcountGrowthPercent | No | Maximum organization headcount growth over headcountGrowthMonths, as a whole percentage such as 100 for 100%. | |
| minHeadcountGrowthPercent | No | Minimum organization headcount growth over headcountGrowthMonths, as a whole percentage such as 10 for 10%. Negative values are accepted. | |
| excludeOrganizationDomains | No | Exclude people whose current employer matches any of these domains. Every domain Apollo holds for that employer is excluded. |