Skip to main content

Choose the right operation

Network candidates are not automatically saved. Only save selected records after reviewing them. Missing names, emails, dates and domains must remain missing rather than being inferred.

Targeting fields

POST /prospects/search accepts a JSON object; undeclared fields are rejected. At least one of query, job_title, industry, company, company_domain, job_titles, industries or companies must contain a targeting value. A country or page size alone is insufficient. Use explicit title, industry and geography fields rather than expecting a sentence in query to encode every constraint. Set relax only if the user permits broader matches.

Results and continuation

Inspect error and error_code before consuming leads, even on HTTP 200. Candidate fields can include contact_name, company_name, job_title, company_domain, business_email, linkedin_url and scores. Provider fields and verification labels can vary; an absent email is not a successful reveal. Pass next_cursor as cursor with the same targeting fields. Do not construct or decode the cursor. Stop when continuation is absent, results are empty, or the user has enough candidates. Never repeatedly broaden an empty search without approval.

Company autocomplete

query requires 2–500 characters. Returns up to eight company candidates. Autocomplete does not save companies, reveal a person or consume reveal credits; account/API request limits still apply.

Known-person lookup

Use one identification form: a LinkedIn profile URL, a work email, or full_name with company or company_domain.
The result includes person, found_fields and optional existing_lead comparison metadata. An existing lead ID identifies an already-saved match, not a newly created record. Review contributed fields before overwriting CRM data. No-match lookup follows the app’s refund behavior; a failure is not proof the person does not exist.

Limits and saving

Paid searches consume the daily search meter, not reveal credits. Person lookup and enrichment reserve one credit under app rules. API/MCP request allowances are separate. See usage limits. Map a search candidate’s business_email to contact_email and company_domain to company_website. Person lookup already returns contact-style fields. Save with POST /leads or create_lead, then use the returned saved UUID for intelligence actions.