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.
uuidstring (uuid)Globally unique identifier.
titlestringLead name or company.
status_namestring | nullStatus slug. Use GET /lead-statuses to list available values.
meta_dataobject | nullExtra data. Contains an about sub-object with description and url.
avatarstring | nullAvatar URL or emoji.
avatar_typestring | null"emoji" or "image".
created_atstringISO 8601 creation timestamp.
updated_atstringISO 8601 last-updated 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}