Leads

List leads

Search a campaign's leads within a date window.

Results are newest first and paged with a cursor: pass the response's search_after value to fetch the next page, and stop when it comes back null.

A lead's supplier and buyers each carry a nested client, keyed name in this version.

get/leads

Request

  • Base URL: https://api.leadprosper.io/public
  • URL: https://api.leadprosper.io/public/leads
  • Auth: one of:
    • HTTP bearer
    • API key in query parameter api_token

Query parameters

campaigninteger required

Campaign id.

start_datestring required

Start of the window, YYYY-MM-DD or YYYY-MM-DD HH:MM:SS.

end_datestring required

End of the window, inclusive.

timezonestring

IANA timezone the window is read in. Defaults to UTC.

status'accepted' | 'duplicated' | 'error'

Only leads with this outcome.

supplierinteger

Only leads from this supplier.

field_namestring

Match on a lead field. Requires field_value.

field_valuestring

The value to match. Requires field_name.

testboolean

Only test leads, or only live ones.

returnboolean

Only returned leads, or only unreturned ones.

repostboolean

Only reposted leads, or only original ones.

search_afterinteger

The search_after value from the previous page.

Response

Success

search_afterstring

Changes

No recorded changes to this operation across all 1 revision of this API.