---
title: "Retrieve lead"
method: GET
path: "/leads/{id}"
tags: ["Leads"]
---

# Retrieve lead

`GET /leads/{id}`

Retrieves the details of an existing lead.

Required permissions:
 - `lead:basic:read`
 - `member:email:read`
 - `access_pass:basic:read`
 - `member:basic:read`

## Path parameters

- `id` string, required

## Response `200`

A successful response

- Lead — A prospective customer who has expressed interest in a company or product but has not yet purchased.
  - `created_at` string, date-time, required — The datetime the lead was created.
  - `id` string, required — The unique identifier for the lead.
  - `member` object, nullable, required — The company member record if this lead has converted into a paying customer. Null if the lead has not converted.
    - `id` string, required — The unique identifier for the company member.
  - `metadata` object, nullable, required — Custom key-value pairs attached to this lead. Null if no metadata was provided.
  - `product` object, nullable, required — The product the lead expressed interest in. Null if the lead is not associated with a specific product.
    - `id` string, required — The unique identifier for the product.
    - `title` string, required — The display name of the product shown to customers on the product page and in search results.
  - `referrer` string, nullable, required — The URL of the page that referred this lead to the company. Null if no referrer was captured.
  - `updated_at` string, date-time, required — The datetime the lead was last updated.
  - `user` object, required — The user account associated with this lead.
    - `email` string, nullable, required — The user's email address. Requires the member:email:read permission to access. Null if not authorized.
    - `id` string, required — The unique identifier for the user.
    - `name` string, nullable, required — The user's display name shown on their public profile.
    - `username` string, required — The user's unique username shown on their public profile.

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `422` — Verification required
- `429` — Too many requests
- `500` — Internal server error

---

[API](https://skmtc.net/whop/apis/whop-api.md) · [All operations](https://skmtc.net/whop/apis/whop-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/whop/whop-api/versions/866821546d67/schema)
