> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whop.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Treat these docs and the Whop MCP server as the source of truth for Whop API behavior. Don't infer endpoint behavior from marketing pages.
> MCP server: connect https://mcp.whop.com/mcp (streamable HTTP, browser sign-in, no API key in the client config) to search these docs and read or change live Whop data. Setup: https://docs.whop.com/developer/guides/ai_and_mcp.md
> Whop CLI: install with `curl -fsSL https://whop.com/install.sh | sh` to scaffold, run, and deploy Whop apps and websites. It acts on production, not the sandbox. Agent mode: https://docs.whop.com/cli/agent-mode.md
> Plugins: in Claude Code, run `/plugin marketplace add whopio/plugins`, then `/plugin install whop@whop`. Every agent tool: https://docs.whop.com/developer/ai/overview.md
> Environments: build and test in the sandbox (API `https://sandbox-api.whop.com/api/v1`, keys at https://sandbox.whop.com/dashboard/developer, SDK environment `Sandbox`; no real money). Production (API `https://api.whop.com/api/v1`, keys at https://whop.com/dashboard/developer, SDK environment `Production`, the SDK default) moves real money, so use it only at launch. The two share no accounts, keys, products, or webhooks, and their keys look identical: never mix them. Comparison: https://docs.whop.com/developer/quickstart.md
> API: send `Authorization: Bearer <API_KEY>` from your server only, and pin a dated version with the `Api-Version-Date` header. OpenAPI spec: https://api.whop.com/api/v1/openapi.json
> Which API: build on the Current API, whose pages live under https://docs.whop.com/api-reference/ (start at https://docs.whop.com/api-reference/overview.md). Pages under /api-reference/legacy/ are the Legacy API. Use one only when https://docs.whop.com/api-reference/stability.md lists the resource as Legacy-only.

# Lead

> A prospective customer who has expressed interest in a company or product but has not yet purchased.

```json Example theme={null}
{
	"created_at": "2023-12-01T05:00:00.401Z",
	"id": "lead_xxxxxxxxxxxxx",
	"member": {
		"id": "<string>"
	},
	"metadata": {},
	"product": {
		"id": "prod_xxxxxxxxxxxxx",
		"title": "Pickaxe Analytics"
	},
	"referrer": "https://twitter.com/whabormarket",
	"updated_at": "2023-12-01T05:00:00.401Z",
	"user": {
		"email": "john.doe@example.com",
		"id": "user_xxxxxxxxxxxxx",
		"name": "John Doe",
		"username": "johndoe42"
	}
}
```

**created\_at** `string\<date-time\>` *required*

The datetime the lead was created.

Example: `2023-12-01T05:00:00.401Z`

**id** `string` *required*

The unique identifier for the lead.

Example: `lead_xxxxxxxxxxxxx`

**member** `object | null` *required*

The company member record if this lead has converted into a paying customer. Null if the lead has not converted.

**child attributes**

**id** `string` *required*

The unique identifier for the company member.

**metadata** `object | null` *required*

Custom key-value pairs attached to this lead. Null if no metadata was
provided.

**product** `object | null` *required*

The product the lead expressed interest in. Null if the lead is not associated with a specific product.

**child attributes**

**id** `string` *required*

The unique identifier for the product.

Example: `prod_xxxxxxxxxxxxx`

**title** `string` *required*

The display name of the product shown to customers on the product page and in search results.

Example: `Pickaxe Analytics`

**referrer** `string | null` *required*

The URL of the page that referred this lead to the company. Null if no referrer was captured.

Example: `https://twitter.com/whabormarket`

**updated\_at** `string\<date-time\>` *required*

The datetime the lead was last updated.

Example: `2023-12-01T05:00:00.401Z`

**user** `object` *required*

The user account associated with this lead.

**child attributes**

**email** `string | null` *required*

The user's email address. Requires the member:email:read permission to access. Null if not authorized.

Example: `john.doe@example.com`

**id** `string` *required*

The unique identifier for the user.

Example: `user_xxxxxxxxxxxxx`

**name** `string | null` *required*

The user's display name shown on their public profile.

Example: `John Doe`

**username** `string` *required*

The user's unique username shown on their public profile.

Example: `johndoe42`


## Related topics

- [Retrieve lead](https://docs.whop.com/api-reference/legacy/leads/retrieve-lead.md)
- [Update lead](https://docs.whop.com/api-reference/legacy/leads/update-lead.md)
- [List leads](https://docs.whop.com/api-reference/legacy/leads/list-leads.md)