get https://api.yelp.com/v3/leads/
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
For the above request a successful GET call will return the lead details with the following response body:
{
"business_id": qGjp8MD987rzyPTQpoisju,
"id": jPlz8TM628rzyCRPqrtcvm,
"conversation_id": E24Bu-vMhVpueQpU8mpRPw,
"temporary_email_address": [email protected],
"temporary_email_address_expiry": "2022-01-02T03:04:05+00:00",
"temporary_phone_number": "+14166666666",
"temporary_phone_number_expiry": "2022-07-06T00:00:00+00:00",
"time_created": "2022-06-07T13:10:16+00:00",
"last_event_time": "2022-06-07T18:43:36+00:00",
}
Note about temporary_email_address and temporary_phone_number fields
These fields, if enabled for you (see Yelp Partner APIs on how to get access), currently return dummy values as we continue to work on their implementation.
This endpoint is part of the Leads API, visit Leads API to learn more.