Skip to main content
Lists are snapshots of full records you have already retrieved. Saving, reading and exporting never re-run a search, so they never cost credits. Limits:
  • 50 lists per user and 1,000 records per list.
  • Up to 100 records per list_add call.

list_create

Create a list for people or companies.
string
required
List name.
string
required
person or company.

list_add

Save full records from an earlier search. Records are de-duplicated by person_id or company_id.
string
required
The list to add to.
object[]
required
1–100 full public records, exactly as a search returned them.

list_get

Read one page of a saved list, with every stored public field.
string
required
The list to read.
integer
1–100 records per page.
integer
0–1000.

list_list

List your saved lists. No parameters.

list_remove

Remove records from a list. The agent asks you to confirm first.
string
required
The list to edit.
string[]
required
1–100 person or company IDs to remove.

list_delete

Delete a list and revoke its export links. The agent asks you to confirm first.
string
required
The list to delete.

list_export

A private CSV download of a saved list, with every stored public field. Nested values are written as JSON, and cells that look like spreadsheet formulas are escaped.
string
required
The list to export.
The download link works for 15 minutes and acts like a password. Only share it with the list’s owner, and never post or log it.