---
title: "Get Lead"
method: GET
path: "/leads/{ID}"
tags: ["Leads"]
---

# Get Lead

`GET /leads/{ID}`

Returns details for a given Lead ID.

Example:
To fetch the details for a lead with the ID `jPlz8TM628rzyCRPqrtcvm`, send an [authenticated](https://docs.developer.yelp.com/docs/authorization-code-workflow) 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"

## Parameters

- `#/components/schemas/RequiredLeadID` — unresolved $ref

## Response `200`

The lead details were fetched successfully.

- LeadObject
  - `id` string, required — The Yelp Lead ID (same as the ID query parameter)
  - `business_id` string, required — The Yelp Business ID
  - `conversation_id` string — 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_address` string — 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](https://docs.developer.yelp.com/docs/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_expiry` string, 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_number` string — **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_expiry` string, 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_number` string — The consumer's phone number. **Note** This field may not be returned if the consumer has not opted into receiving phone calls.
  - `time_created` string, date-time, required — The time when the lead was created
  - `last_event_time` string, date-time, required — Time of the last event on the lead
  - `user` ProjectConsumerUser — The consumer user that created the project
    - `display_name` string, required — Display name of the user
  - `project` Project — The project
    - `location` object, nullable, required — The consumer users location
      - `postal_code` string, required
    - `availability` object, nullable, required — The consumer users availability
      - `status` string, required — The status of the availability. Is one of SPECIFIC_DATES, ASAP or FLEXIBLE
      - `dates` string[], required — The list of dates that the consumer user selected, is empty if status is not SPECIFIC_DATES
    - `job_names` string[], required — The name that identifies the type of job. For a moving business this could be "In-state moving" or "Out-of-state moving"
    - `survey_answers` object[], required — The projects survey questions and answers
      - `question_text` string, required — The survey question text
      - `question_identifier` string — Optional custom question identifier used instead of the text to uniquely identify a question across text changes
      - `answer_text` string[], required — The survey answers. This will contain multiple entries if the consumer user selected multiple answers for e.g. a list of items that need to be moved
    - `attachments` object[] — The project attachments (e.g. uploaded photos)
      - `id` string — The unique ID for this attachment
      - `url` string — A url to the attachment content. Accessible for up to 24 hours after querying this endpoint
      - `resource_name` string — The name of the resource
      - `mime_type` string — The mime type of the file
  - `link_to_reply_in_yelp` string — 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.

## Other responses

- `400` — unresolved $ref
- `401` — The API key has either expired or doesn't have the required scopes to query this endpoint. | code | description | | ------------- | ------------- | | UNAUTHORIZED_API_KEY | The API key provided is not currently able to query this endpoint. | | TOKEN_INVALID | Invalid API key or authorization header. |
- `403` — unresolved $ref
- `404` — unresolved $ref
- `429` — You have either exceeded your daily quota, or have exceeded the queries-per-second limit for this endpoint. Try reducing the rate at which you make queries.
- `500` — Internal Server Error

---

[API](https://skmtc.net/yelp/apis/businesses.md) · [All operations](https://skmtc.net/yelp/apis/businesses/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yelp/businesses/revisions/d3f744f55ed7/schema)