Skip to main content
GET
Estimate a cost

Authorizations

Authorization
string
header
required

An Intent Leads API key, e.g. il_live_ followed by 32 letters and digits. Create one on the API and CLI page of the dashboard.

Query Parameters

meter
enum<string>

intent (default; website visitors use it too) or search.

Available options:
intent,
search
quantity
integer
required

How many people.

Required range: x >= 1

Response

The estimate.

meter
enum<string>
required
Available options:
intent,
search
quantity
integer
required
cost_usd
number
required
average_cents
number
required
people_this_month_before
integer
required
covered_by_balance
boolean
required
workspace_limit_left
integer | null
required

People the rest of the workspace's monthly budget buys now, or null when it has none.

workspace_budget_left_usd
number | null
required

What's left of the workspace's monthly budget, or null when it has none.

note
string
required
available_usd
number

The organization's available balance. Not shown to a workspace's own key.

people_the_balance_covers
integer

Not shown to a workspace's own key.