Leads

Get a lead

Returns detailed information about a single lead, including channel and traffic source, score, captured URL parameters, and tour/move-in metadata. The lead must belong to a community the caller has access to.

get/api/v1/leads/{id}

Request

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

Path parameters

idinteger required

Response

idinteger required

Internal Further lead identifier.

external_lead_idstring

Lead identifier in the customer's CRM, when CRM sync is configured.

namestring required

Full name of the lead.

emailstring required

Lead email address.

phonestring required

Lead phone number.

hash_codestring required

Stable opaque identifier for the lead, safe for use in URLs.

channel_sourcestring required

Originating channel. One of chat_api, conversational_webform (embedded VSA), conversational_ivr (voice VSA), web_form_submit, static_webform, phone_call, or referral.

scoreinteger required

Lead score assigned by Further's qualification engine (0-100).

move_in_datestring date-time required

Recorded move-in date, or null if none was set.

tour_datestring date-time

Start time of the most recent tour, or null if none.

care_typestring required

Care level captured during the qualifying conversation (free text).

visitor_uuidstring uuid

Stable identifier of the originating website visitor, when known.

url_parametersobject[] required

Query-string parameters captured at the originating visit, as [{key, value}, …].

traffic_sourcestring

Classified traffic source of the originating visit (e.g. Direct, Google Ads).

Changes

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