Leads

List leads

Changed on

Lists an account's leads, newest first.

Required permissions:

  • lead:basic:read
  • member:email:read
  • access_pass:basic:read
  • member:basic:read
get/leads

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/leads
  • Auth: HTTP bearer

Query parameters

afterstring

Returns the elements in the list that come after the specified cursor.

beforestring

Returns the elements in the list that come before the specified cursor.

firstinteger

Returns the first n elements from the list.

Example:42
lastinteger

Returns the last n elements from the list.

Example:42
created_afterstring date-time

Only return leads created after this timestamp.

Example:2023-12-01T05:00:00.401Z
created_beforestring date-time

Only return leads created before this timestamp.

Example:2023-12-01T05:00:00.401Z
product_idsstring[]

Filter leads to only those associated with these specific product identifiers.

account_idstring required

The unique identifier of the company to list leads for.

Example:biz_xxxxxxxxxxxxxx

Response

A successful response

Example response

{
  "data": [
    {
      "created_at": "2023-12-01T05:00:00.401Z",
      "id": "lead_xxxxxxxxxxxxx",
      "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"
      }
    }
  ]
}

Changes

  • 697924df40d1Revision changes
    • breaking

      added the new required query request parameter account_id

    • warning

      deleted the query request parameter company_id