Leads

List leads

Returns a paginated list of leads from communities the caller has access to. Supports search by name, email, and phone, plus filters from LeadPublicAPIFilters. Personal API keys return leads from the communities visible to the key owner; organization keys return every lead belonging to the calling organization.

get/api/v1/leads/

Request

  • Base URL: https://api.talkfurther.com
  • URL: https://api.talkfurther.com/api/v1/leads/
  • Auth: one of:
    • API key in header Authorization
    • API key in header Authorization

Query parameters

community_idnumber[]

Multiple values may be separated by commas.

end_datestring date
financially_unqualifiedboolean
group_idinteger[]

Multiple values may be separated by commas.

move_in_dateboolean
orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

score_frominteger
score_tointeger
searchstring

A search term.

start_datestring date
submitted_to_crmboolean
tour_scheduledboolean
updated_end_datestring date
updated_start_datestring date

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Changes

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