List leads
Returns a paginated list of leads. Filter by status or source to segment your pipeline.string
Filter by lead status. Accepted values:
"new", "contacted", "qualified", "converted".string
Filter by the channel that captured the lead. Accepted values:
"call", "sms", "form", "facebook", "google".string
Field to sort results by. Default:
"created_at".integer
Number of results per page. Default:
20.Response
Create a lead
Creates a lead manually. Useful for syncing contacts from a CRM or external form.At least one of
phone or email is recommended. A lead with neither cannot be contacted by an agent.string
required
Full name of the lead.
string
Phone number in E.164 format (e.g.
"+15551234567").string
Email address of the lead.
string
Label describing where the lead came from (e.g.
"crm-import", "referral").string[]
Array of tags to apply for segmentation (e.g.
["high-intent", "hvac-repair"]).Response
Update a lead
Updates one or more fields on an existing lead. Only the fields you include are changed. Path parameterstring
required
The ID of the lead to update.
string
Updated full name.
string
Updated phone number (E.164).
string
Updated email address.
string
Updated pipeline status:
"new", "contacted", "qualified", or "converted".string[]
Replaces the existing tag list entirely.
Response