# GET /api/leads/search/{keyword}

> Leads - Search Leads

- **Endpoint:** `GET /api/leads/search/{keyword}`
- **Group:** Leads
- **Since:** v1.0.0
- **Defined in:** `RestApi/Controllers/LeadsController.php`

## Headers

| Field | Type | Description |
| --- | --- | --- |
| `authtoken` | String | Authentication token, generated from admin area |

## Parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `keyword` | String | yes | Search keywords |

## Request example

```bash
curl -X GET "https://yoursite.com/index.php/api/leads/search/acme" \
  -H "authtoken: YOUR_API_TOKEN"
```

## Responses

### Success - Success-Response:

```json
{
		"id": "2",
		"company_name": "Test",
		"address": "",
		"city": "",
		"state": "",
		"zip": "",
		"country": "",
		"created_date": "2021-09-12",
		"website": "",
		"phone": "",
		"currency_symbol": "",
		"starred_by": "",
		"group_ids": "",
		"deleted": "0",
		"is_lead": "1",
		"lead_status_id": "1",
		"owner_id": "1",
		"created_by": "1",
		"sort": "0",
		"lead_source_id": "1",
		"last_lead_status": "",
		"client_migration_date": "0000-00-00",
		"vat_number": "",
		"currency": "",
		"disable_online_payment": "0",
		"primary_contact": null,
		"primary_contact_id": null,
		"contact_avatar": null,
		"total_projects": null,
		"payment_received": "0",
		"invoice_value": "0",
		"client_groups": null,
		"lead_status_title": "New",
		"lead_status_color": "#f1c40f",
		"owner_name": "john doe",
		"owner_avatar": null
}
```

---

Part of the [REST API for RISE CRM](https://risecrm.themesic.com/apiguide/) documentation.
Full page: https://risecrm.themesic.com/apiguide/leads/search-leads/