ReplySparrow Docs

Directory

Reveal full leads (1 credit per lead)

Return the full data of the leads with the given ids (from POST /api/v1/directory/leads/search). Each revealed lead costs 1 credit the first time; revealing it again is free. If the credit balance cannot cover all requested ids, only the first affordable leads are revealed and charged, and the rest are listed in not_revealed_ids. Needs the contacts:write scope.

When list_id is provided, the revealed leads are also saved as contacts into that list (no extra credit cost): leads already in the workspace, excluded, or missing a first/last name are skipped. The save is synchronous, so a large reveal with list_id can take noticeably longer — configure your HTTP client timeout accordingly.

posthttps://app.replysparrow.com/api/v1/directory/leads/reveal

Authorizations

Authorizationstringheaderrequired

Your API key from Settings → API, sent as Bearer <token>.

Body

application/json

Ids of the leads to reveal (max 100 per request).

idsstring[]required

Lead ids returned by the search endpoint

Example: ["dl_3f9a0c2b7d1e4f5a6b7c8d9e","dl_7c2e9b1a0f3d4e5c6b7a8d9f"]

list_idstring

Optional id of one of your lists. When provided, the revealed leads are also saved as contacts into this list (free of extra charge).

Example: "9f8e7d6c-0000-4000-8000-000000000002"

Response

application/json

Full leads and credit usage summary

leadsobject[]required

Revealed leads

requestednumberrequired

Number of distinct ids requested

revealednumberrequired

Number of records actually returned

credits_usednumberrequired

Credits spent by this call

Ids that are not results of one of your searches

Ids skipped because the credit balance ran out

Only present when list_id was provided: number of leads saved as contacts into the list (already-existing/excluded leads are skipped)

Only with list_id: leads already in your workspace

Only with list_id: leads on your exclusion list

Only with list_id: leads without a first or last name

Reveal full leads (1 credit per lead)
curl --request POST \  --url https://app.replysparrow.com/api/v1/directory/leads/reveal \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{  "ids": [    "dl_3f9a0c2b7d1e4f5a6b7c8d9e",    "dl_7c2e9b1a0f3d4e5c6b7a8d9f"  ],  "list_id": "9f8e7d6c-0000-4000-8000-000000000002"}'
{  "leads": [    {      "id": "string",      "first_name": "string",      "last_name": "string",      "full_name": "string",      "job_title": "string",      "headline": "string",      "location": "string",      "industry": "string",      "company": "string",      "company_size": "string",      "linkedin_url": "string",      "employee_count": 0,      "company_website": "string",      "company_linkedin_url": "string",      "summary": "string"    }  ],  "requested": 0,  "revealed": 0,  "credits_used": 0,  "not_found_ids": [    "string"  ],  "not_revealed_ids": [    "string"  ],  "saved_to_list": 0,  "skipped_existing": 0,  "skipped_excluded": 0,  "skipped_missing_name": 0}