List Lookup

Append current employee headcount to every company in a Parvenu list. Asynchronous, writes results back into the list.

POST /headcount_list

This is an asynchronous endpoint. It returns a job acknowledgement, not data. Poll /check_list_status until the list reports done, then fetch the rows with /download_list. Costs 0.2 credits per company, charged once however many rows share the company, and only when a headcount or size range is found. The exact employee count is written to the headcount column and the size range to the company_size column; when only a range is known, only company_size is filled.

Use this to look up headcount for every company in a list in one call, rather than looping over Individual Lookup per row.

When two sources disagree, the more trusted one is kept. A headcount or size already filled from the company's LinkedIn page is not replaced; the row's log then says the existing value was kept, and the lookup is still charged because it ran.

Headers

Name	Value
Content-Type	application/json

Body

Name	Type	Description
api_key	string	Your API Key.
listname	string	Name of the existing Parvenu list to enrich.
view	string	Optional. Which rows of the list to process. all (default) processes every contact in the list; verified restricts the run to contacts whose email address is verified.
saved_view	string	Optional. Name of a saved view on this list. Runs only on the contacts in that view. Don't combine with view, filter_stack or search.

Saved views. To run only on the contacts in a saved view, send its name as saved_view. See List Saved Views.

View values

Value	Processes
all	Every row in the list (default).
verified	Only rows whose email address is verified.

Response

The acknowledgement reports the job's status, which is one of queued, processing, done, not_found, cancelled or error. done means the job has finished. See Response Format for the fields every endpoint returns.

Field	Description
status	Job status at the moment of the acknowledgement.
job_id	Handle for the run, returned as a string.
view	Which rows were selected, all or verified.
fetched_count	Rows read from the list.
server_filtered_total	Rows left after the view filter.
truncated	true when the list was larger than max_rows.
credits_used	Credits charged by the acknowledgement itself, always 0 here.

Example

Input

{
  "api_key": "your_api_key",
  "listname": "my_list",
  "view": "all"
}

Output

{
  "ok": true,
  "status": "queued",
  "job_id": "401269ea-c329-495f-a8d4-a1e87b645f56",
  "server_filtered_total": 10,
  "fetched_count": 10,
  "max_rows": 5000,
  "truncated": false,
  "filter_stack_active": false,
  "search_active": false,
  "message": "queued",
  "view": "all",
  "credits_used": 0,
  "success": true
}

Error

{
  "status": "error",
  "error": {
    "code": "not_found",
    "message": "list not found"
  },
  "success": false
}

Retrieving results

• Check List Status

• Download List Data