---
title: "Search leads"
method: GET
path: "/leads/search"
tags: ["Leads"]
---

# Search leads

`GET /leads/search`

Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href="https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.

## Query parameters

- `term` string, required
- `fields` 'custom_fields' | 'notes' | 'title'
- `exact_match` boolean
- `person_id` integer
- `organization_id` integer
- `include_fields` 'lead.was_seen'
- `start` integer
- `limit` integer

## Response `200`

Success

- object
  - `success` boolean — If the response is successful or not
  - `data` object
    - `items` object[] — The array of leads
      - `result_score` number — Search result relevancy
      - `item` object
        - `id` string — The ID of the lead
        - `type` string — The type of the item
        - `title` string — The title of the lead
        - `owner` object
          - `id` integer — The ID of the owner of the lead
        - `person` object
          - `id` integer — The ID of the person the lead is associated with
          - `name` string — The name of the person the lead is associated with
        - `organization` object
          - `id` integer — The ID of the organization the lead is associated with
          - `name` string — The name of the organization the lead is associated with
        - `phones` string[]
        - `emails` string[]
        - `custom_fields` string[] — Custom fields
        - `notes` string[] — An array of notes
        - `value` integer — The value of the lead
        - `currency` string — The currency of the lead
        - `visible_to` integer — The visibility of the lead
        - `is_archived` boolean — A flag indicating whether the lead is archived or not
  - `additional_data` object
    - `pagination` object — Pagination details of the list
      - `start` integer — Pagination start
      - `limit` integer — Items shown per page
      - `more_items_in_collection` boolean — Whether there are more list items in the collection than displayed
      - `next_start` integer — Next pagination start

---

[API](https://skmtc.net/pipedrive/apis/pipedrive-api-v1.md) · [All operations](https://skmtc.net/pipedrive/apis/pipedrive-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pipedrive/pipedrive-api-v1/revisions/bf863a979545/schema)