Skip to main content
GET
/
api
/
v1
/
iframes
/
{id}
/
leads
List Widget Leads
curl --request GET \
  --url https://api.example.com/api/v1/iframes/{id}/leads
{
  "leads": [
    {}
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

​
Authentication

Requires a Bearer token (API key) or a dashboard session.

​
Path Parameters

​
id
string
required
The widget config UUID.

​
Query Parameters

​
limit
number
default:"50"
Page size (max 200).
​
offset
number
default:"0"
Number of leads to skip.
​
search
string
Case-insensitive match against captured lead fields.
​
from
string
ISO timestamp lower bound (inclusive).
​
to
string
ISO timestamp upper bound (inclusive).

​
Response

​
leads
array
Each lead: id, lead_data (the captured fields), session_id, ip_country, referrer_url, created_at.
​
total
number
Total leads matching the filter.
​
limit
number
​
offset
number

​
Example

curl
curl "https://www.hitheo.ai/api/v1/iframes/CONFIG_ID/leads?limit=50" \
  -H "Authorization: Bearer $THEO_API_KEY"