import Whop from '@whop/sdk';
const client = new Whop({
apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const leadListResponse of client.leads.list({ company_id: 'biz_xxxxxxxxxxxxxx' })) {
console.log(leadListResponse.id);
}{
"data": [
{
"id": "lead_xxxxxxxxxxxxx",
"created_at": "2023-12-01T05:00:00.401Z",
"updated_at": "2023-12-01T05:00:00.401Z",
"referrer": "https://twitter.com/whabormarket",
"metadata": {},
"user": {
"id": "user_xxxxxxxxxxxxx",
"email": "john.doe@example.com",
"name": "John Doe",
"username": "johndoe42"
},
"product": {
"id": "prod_xxxxxxxxxxxxx",
"title": "Pickaxe Analytics"
},
"member": {
"id": "<string>"
}
}
],
"page_info": {
"end_cursor": "<string>",
"start_cursor": "<string>",
"has_next_page": true,
"has_previous_page": true
}
}Returns a paginated list of leads for a company, with optional filtering by product and creation date.
Required permissions:
lead:basic:readmember:email:readaccess_pass:basic:readmember:basic:readimport Whop from '@whop/sdk';
const client = new Whop({
apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const leadListResponse of client.leads.list({ company_id: 'biz_xxxxxxxxxxxxxx' })) {
console.log(leadListResponse.id);
}{
"data": [
{
"id": "lead_xxxxxxxxxxxxx",
"created_at": "2023-12-01T05:00:00.401Z",
"updated_at": "2023-12-01T05:00:00.401Z",
"referrer": "https://twitter.com/whabormarket",
"metadata": {},
"user": {
"id": "user_xxxxxxxxxxxxx",
"email": "john.doe@example.com",
"name": "John Doe",
"username": "johndoe42"
},
"product": {
"id": "prod_xxxxxxxxxxxxx",
"title": "Pickaxe Analytics"
},
"member": {
"id": "<string>"
}
}
],
"page_info": {
"end_cursor": "<string>",
"start_cursor": "<string>",
"has_next_page": true,
"has_previous_page": true
}
}A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
42
Returns the last n elements from the list.
42
The unique identifier of the company to list leads for.
"biz_xxxxxxxxxxxxxx"
Only return leads created after this timestamp.
"2023-12-01T05:00:00.401Z"
Only return leads created before this timestamp.
"2023-12-01T05:00:00.401Z"
Filter leads to only those associated with these specific product identifiers.
Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.
Was this page helpful?