List Lookup

Flag every contact in a Parvenu list who has the Open to Work badge set. Asynchronous, writes results back into the list.

POST /open_to_work_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.3 credits per row. Results are written to the open_to_work column.

Use this to check every contact in a list in one call, rather than looping over Individual Lookup per row.

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.

Example

Input

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

Output

{
  "success": true,
  "job_id": "4176d63e-9b2d-4ec4-af38-cac69bd02a28",
  "status": "queued",
  "list_name": "my_list",
  "rows_selected": 10,
  "rows_fetched": 10,
  "message": "queued",
  "view": "all",
  "max_rows": 5000,
  "truncated": false,
  "credits_used": 0
}

Error

{
  "status": "error",
  "error": {
    "code": "validation_error",
    "message": "state: Extra inputs are not permitted"
  },
  "success": false
}

Reading the acknowledgement

Field	Meaning
job_id	Identifier for this run. Always a string.
status	A job status: queued, processing, done, not_found, cancelled or error.
rows_selected	How many rows matched your view before the page limit was applied.
rows_fetched	How many rows this run actually picked up. This is the number that gets processed.
max_rows	The ceiling a single run will fetch.
truncated	true when the list was longer than max_rows and the run was cut to fit.

Retrieving results

• Check List Status

• Download List Data