Leads

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

Field	Type	Description
`id`	integer	Unique lead ID.
`uuid`	string (uuid)	Globally unique identifier.
`title`	string	Lead name or company.
`status_name`	string \| null	Status slug. Use `GET /lead-statuses` to list available values.
`meta_data`	object \| null	Extra data. Contains an `about` sub-object with `description` and `url`.
`custom_fields`	object	Custom field values, keyed by each definition’s `field_key`. `{}` when nothing is set. Write them by sending `custom_fields` on create or update; list the definitions with `GET /custom-fields`.
`avatar`	string \| null	Avatar URL or emoji.
`avatar_type`	string \| null	`"emoji"` or `"image"`.
`created_at`	string	ISO 8601 creation timestamp.
`updated_at`	string	ISO 8601 last-updated timestamp.

GET /leads

GET /leads/{id}

POST /leads

PUT /leads/{id}

PUT /leads/{id}/status

DELETE /leads/{id}