List prospects

Returns prospects in your workspace, newest first, with cursor pagination. Pass listId to return only the prospects in one list — the way to pull everyone in a list from your own server or script. Get list ids from GET /lists. Pass field and fieldValue to keep only the prospects whose job title, company, country, city or one of your own CSV columns contains a value — the same "Filter by field" as the Prospects page.

Required scope: prospects:read.

Returns a cursor-paginated list — pass cursor from the previous page to continue.

To export a whole list, keep requesting with cursor set to the previous next_cursor until has_more is false.

listId and filter combine: listId narrows to the list, then each filter must also match.

field + fieldValue combines with listId and filter, and is applied before paging, so it never shortens a page. Example: listId=<your list>&field=custom:language&fieldValue=German returns everyone in that list whose Language column contains German.

Every page holds limit rows unless it is the last one. The one exception: with a very selective filter, if 20,000 prospects are checked before the page fills, the page comes back with fewer rows (possibly none) and has_more true. Pass next_cursor back to continue.