Skip to main content
A lead represents a prospect or client. It is the central resource — tasks, opportunities, contacts, and custom field values all attach to leads.

​
Lead object

FieldTypeDescription
idintegerUnique lead ID.
titlestringLead name or company.
descriptionstring | nullFull description.
short_descriptionstring | nullShort summary shown in cards.
tagstring | nullFree-form label, e.g. "hot".
due_datestring | nullISO 8601 deadline.
ongoingbooleanNo fixed deadline when true.
lead_statusobject | nullCurrent status — id, name, label, color.
custom_fieldsarrayValues for your agency’s custom fields.
created_atstringISO 8601 creation timestamp.

​
Endpoints

List leads

GET /leads

Get lead

GET /leads/{id}

Create lead

POST /leads

Update lead

PUT /leads/{id}

Upsert status

PUT /leads/{id}/status

Delete lead

DELETE /leads/{id}