Sign in
latestOpenAPI 3.1.02026-07-248941352.6 KB

d3f744f55ed7

Leads

Get Lead

Returns details for a given Lead ID.

Example: To fetch the details for a lead with the ID jPlz8TM628rzyCRPqrtcvm, send an authenticated GET request to the following URL: https://api.yelp.com/v3/leads/jPlz8TM628rzyCRPqrtcvm

A sample response is shown in the example response box on the right under "200 - Lead"

get/leads/{ID}

Parameters

#/components/schemas/RequiredLeadID — unresolved $ref

Response

The lead details were fetched successfully.

idstring required

The Yelp Lead ID (same as the ID query parameter)

business_idstring required

The Yelp Business ID

conversation_idstring

The Conversation ID. Can be used to construct a link to Yelp Biz Inbox (URL format https://biz.yelp.com/messaging/[business-id]/thread/[conversation-id]).

NOTE We will eventually migrate all users to the Yelp Leads Center, at which point this URL scheme will become obsolete as it uses the Lead ID instead.

temporary_email_addressstring

A temporary, one-time-use email address which the biz user can use to reply to the lead.

Note In some cases, we may not return this temporary email address. Cases when this can happen include:

  • Access to proxy email addresses has not been enabled for you, see Yelp Partner APIs on how to get access
  • The lead has been created more than 30 days ago
  • The lead has already been replied to by any biz user
temporary_email_address_expirystring date-time

The expiry time of the reply email address (replies after expiry will be rejected). This field will only be included if a temporary email address is returned as well.

temporary_phone_numberstring

Deprecated. The consumer's phone number. Only present if you were already receiving this field; otherwise, use phone_number.

Note This field may not be returned if the consumer has not opted into receiving phone calls.

temporary_phone_number_expirystring date-time

Deprecated. The expiry time associated with the temporary phone number. If temporary_phone_number is present, this value will be 2099-12-31T23:59:59+00:00.

phone_numberstring

The consumer's phone number.

Note This field may not be returned if the consumer has not opted into receiving phone calls.

time_createdstring date-time required

The time when the lead was created

last_event_timestring date-time required

Time of the last event on the lead

link_to_reply_in_yelpstring

A direct link to the lead in Yelp's Leads Center, where the business can reply to the consumer. Please contact Yelp if you want to receive this field in the response.

Example response

{
  "link_to_reply_in_yelp": "https://biz.yelp.com/leads_center/VXi7gzRqPKp63X0u6fUtbg/leads/18kPq7GPye-YQ3LyKyAZPw"
}