---
title: "List leads"
method: GET
path: "/leads"
tags: ["Leads"]
---

# List leads

`GET /leads`

Returns a paginated list of leads for a company, with optional filtering by product and creation date.

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

## Query parameters

- `after` string, nullable — Returns the elements in the list that come after the specified cursor.
- `before` string, nullable — Returns the elements in the list that come before the specified cursor.
- `first` integer, nullable — Returns the first _n_ elements from the list.
- `last` integer, nullable — Returns the last _n_ elements from the list.
- `company_id` string, required — The unique identifier of the company to list leads for.
- `created_after` string, date-time, nullable — Only return leads created after this timestamp.
- `created_before` string, date-time, nullable — Only return leads created before this timestamp.
- `product_ids` string[], nullable — Filter leads to only those associated with these specific product identifiers.

## Response `200`

A successful response

- object — The connection type for Lead.
  - `data` LeadListItem[], required — A list of nodes.
    - `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.
  - `page_info` PageInfo, required — Information about pagination in a connection.
    - `end_cursor` string, nullable, required — When paginating forwards, the cursor to continue.
    - `has_next_page` boolean, required — When paginating forwards, are there more items?
    - `has_previous_page` boolean, required — When paginating backwards, are there more items?
    - `start_cursor` string, nullable, required — When paginating backwards, the cursor to continue.

## 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)