Find candidate identities in the people index for 1 ACU
Return up to 10 basic indexed profiles matching all name terms plus optional company, location, and title filters. Requires people:search; legacy full-access keys with both people:enrich and agent:chat are accepted. Costs 1 ACU per completed search, including zero matches; failed searches are not charged. Never starts research or enrichment. Normal account billing, auto-recharge settings, and API-key spending caps apply. Send an Idempotency-Key to replay a request without another charge. Indexed identities and employment are unverified. Ask the user to choose before POST /v1/person, which costs 25 ACU unless the workspace already has active access. One bounded index request; no exhaustive count or pagination. Workspace limits: 30 requests/minute and 300/hour across keys. Active account eligibility still applies.
Request
- Base URL: https://api.ploid.com
- URL: https://api.ploid.com/v1/search/candidates
- Auth: one of:
- HTTP bearer
- API key in header x-api-key
Headers
Reuse for retries of the same request to prevent duplicate charges.
Request body
Response
Matching indexed profiles, possibly empty. Costs 1 ACU per completed search.
Changes
No recorded changes to this operation across all 1 revision of this API.