Docs
Leads

Get a lead

Returns one captured lead by its sqid-encoded id.

GET/api/v1/leads/{id}

Responds 404 rather than 403 when the lead belongs to another workspace, so ids cannot be enumerated.

Path parameters

Prop

Type

Response 200

Prop

Type

Errors

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

Every error shares one envelope.

Example

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

List leads

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

List bookings

Returns meetings booked through the agent, paginated — both natively scheduled meetings on your connected Google Calendar and Cal.com bookings, each carrying its provider, start and end time, attendee timezone, and status.

On this page

Path parameters
Response 200
Errors
Example