Docs
Leads

List leads

Returns contact details captured by the agent — from the lead form, a human handoff, or a booking — newest first.

GET/api/v1/leads

Filter by chatbot, status, or capture date.

Query parameters

Prop

Type

Response 200

Returns a data array with a pagination object. Each item:

Prop

Type

Errors

  • 401 — Missing or invalid API key
  • 429 — Rate limit exceeded

Every error shares one envelope.

Example

curl https://www.hey.support/api/v1/leads \
  -H 'Authorization: Bearer hs_live_…'

Create a lead

Records a lead against a chatbot, optionally linked to a conversation, and emits the `lead.created` webhook.

Get a lead

Returns one captured lead by its sqid-encoded id.

On this page

Query parameters
Response 200
Errors
Example