Leads
Leads
The lead object and the endpoints that work with it.
A lead is a prospective client captured from any source — a web form, an ad, a referral, an imported list, or the push endpoint.
Endpoints
| Method | Path | Scope | Description |
|---|---|---|---|
GET | /api/leads | leads:read | List leads (filtered, paginated) |
GET | /api/leads/{id} | leads:read | Fetch a single lead |
POST | /api/leads | leads:write | Create a lead |
PATCH | /api/leads/{id} | leads:write | Update a lead (partial) |
POST | /api/leads/{id}/archive | leads:write | Archive a lead |
POST | /api/leads/{id}/unarchive | leads:write | Restore a lead |
The lead object
{
"id": "3f8c1e2a-1b2c-4d5e-8f90-abcdef012345",
"first_name": "Ada",
"last_name": "Lovelace",
"email": "ada@example.com",
"phone": "+15551234567",
"source": "web_form",
"status": { "key": "new", "name": "New" },
"assignee_id": null,
"archived": false,
"created_at": "2026-06-23T10:00:00.000Z",
"last_activity_at": "2026-06-23T10:00:00.000Z",
"data": { "city": "London", "qualification": "qualified" }
}| Field | Type | Notes |
|---|---|---|
id | string | UUID, stable. |
first_name, last_name | string | |
email | string | Lowercased. |
phone | string | Normalized to E.164 where possible. |
source | string | Where the lead came from (e.g. web_form, zapier). |
status | object | The firm's pipeline stage: a stable key and a display name. |
assignee_id | string | null | The assigned staff member's id, if any. |
archived | boolean | Whether the lead is archived. |
created_at | string | ISO-8601 timestamp. |
last_activity_at | string | ISO-8601 timestamp of the most recent activity. |
data | object | Firm-defined custom fields (varies per firm). |
status.key is a stable identifier you can branch on; status.name is for display and a firm
can rename it. Filter by the key.