Leads

List, read, create and update leads. New leads go through your assignment rules and duplicate checks.

1 min readUpdated 15 Oct 2026API v1

List leads#

GET/leadsleads:read

List leads, newest first by default. Paginated, and searchable with q.

Create a lead#

POST/leadsleads:write

name, source and sourceCampaign (a campaign id) are required. Answers 201 with data.lead, plus data.duplicateWarning when it looks like someone you already have.

Field	Type	Notes
`name`	string	Required
`email`, `phoneNumber`	string	Used for duplicate detection
`source`	enum	Required. `WEBSITE`, `REFERRAL`, `FACEBOOK`, `GOOGLE`, `WALK_IN`, `INDIAMART`, `JUSTDIAL`, `ACRES99`, `MAGICBRICKS`, `HOUSING`, `OTHER` and more; the full list is in OpenAPI
`sourceCampaign`	id	Required. A campaign in your organization
`assignedTo`	user id	Optional. Otherwise your assignment rules decide
`customFields`	object	Your organization's lead fields, by key

Duplicates#

A high-confidence duplicate is refused with 409 DUPLICATE_LEAD; send "force": true to create it anyway.

Get a lead#

GET/leads/{id}leads:read

Update a lead#

PATCH/leads/{id}leads:write

Send only the fields you’re changing.