Skip to main content

📊 Creator API: Leads Tool (get_leads)

Learn how the get_leads Creator API tool reports aggregate lead counts and buy-through rates without exposing any personal details.

📊 What get_leads does

If your creator API key has the leads scope, you can call get_leads (or the matching REST endpoint) to see how many people showed interest in your offers over a date window.

It covers three kinds of interest: someone filling in a lead-capture form, an identified website visitor, or someone who started a product's extra checkout questions.

🔒 What it never shows

get_leads reports counts and buy-through rates only. It never returns anyone's email, name, photo, phone number, location, company, job, form answers, or any other personal detail.

Breakdowns are only by source, form, and date, never by anything personal. Buying is only broken down by source, not by form or time period.

✅ How a lead becomes a buyer

A lead is matched to a purchase by comparing their email (case-insensitive) to the account email on a successful charge. Checkout-question starters are matched by account directly. Tips don't count as purchases.

Every lead falls into exactly one group: already a customer before showing interest, first purchase on or after showing interest, or not bought yet. These three always add up to your total. The buy-through rate only covers people who weren't already customers.

If fewer than 10 people sit behind a rate, you'll see null with a reason instead of a number, so you're not shown a misleading figure.

⚠️ What it can't catch

A purchase made with a different email, a gift (matched to the recipient, not the giver), free products or trials, and refunds (never subtracted) won't be picked up. For identified visitors, only their main identified email is checked.

🗂️ How results are organized

People who started checkout questions get their own separate count and rate, kept out of your main lead totals since they were mostly already at checkout.

Only real lead-form sign-ups count toward named forms. CSV-imported leads are excluded and shown as their own separate number. Someone who joined more than one form is counted under the first form they joined.

Sign-ups with no specific form, like a generic waiting list, newsletter box, or manual add, appear as their own line, separate from named forms.

Identified website visitors are only counted if you've unlocked that feature, matching what your dashboard shows. If visitor identification is off, you'll see null with a reason, not zero.

Your own email is never counted as a lead.

If you get stuck, message us from the chat bubble and we will help.

Did this answer your question?