List Lookup

Resolve a company website for every row in a Parvenu list. Asynchronous, writes results back into the list.

POST /website_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.5 credits per company, charged only when a website is found. Each company name in the list is looked up once, and every contact at that company gets the website. Results are written to the company_website column.

Use this to resolve a website for every row in a list in one call, rather than looping over Individual Lookup per row.

How companies are counted. Contacts are grouped by their exact company name, so ten contacts at Acme cost 0.5, not 5. Different spellings count as different companies: "ServiceTitan" and "Service Titan" are two lookups. In each contact's log, one contact at the company shows 0.5 Credits and the others show Website updated (same company) at 0 Credits. The acknowledgement's credits_estimated is rows x 0.5, the most the run can cost.

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.

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"
}

Output

{
  "ok": true,
  "status": "queued",
  "job_id": "4e49f907-a667-4e64-b197-7ac6f809c16f",
  "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": "validation_error",
    "message": "state: Extra inputs are not permitted"
  },
  "success": false
}

A single call processes at most 5000 rows (max_rows). If truncated comes back true, the list was larger than the cap and you will need to run the job again to cover the remaining rows.

Retrieving results

• Check List Status

• Download List Data