> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Pipedrive: Search Item
> Perform a search from multiple item types. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.
Perform a search from multiple item types.
Tool ID: `pipedrive_search_item`
## Run this action
Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.
```ts theme={null}
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'pipedrive_search_item',
{
"term": "software companies hiring engineers"
},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={null}
deepline tools execute pipedrive_search_item --input '{
"term": "software companies hiring engineers"
}' --json
```
## Example response
The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.
```json theme={null}
{
"data": {
"success": true,
"data": {
"items": [
{
"result_score": 123,
"item": {}
}
],
"related_items": [
{
"result_score": 123,
"item": {}
}
]
},
"additional_data": {
"next_cursor": "cursor_123"
}
}
}
```
Use `deepline tools get pipedrive_search_item --json` for the latest machine-readable contract.
## Input reference
Performs a search from your choice of item types and fields.
| Name | Type | Required | Default | Details |
| ---------------------------------- | --------------------------------------------------------------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.term` | `string` | Yes | — | The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded. |
| `payload.item_types` | `"deal" \| "person" \| "organization" \| "product" \| "lead" \| "file" \| "mail_attachment" \| "project"` | No | — | A comma-separated string array. The type of items to perform the search from. Defaults to all. Allowed: `deal`, `person`, `organization`, `product`, `lead`, `file`, `mail_attachment`, `project`. |
| `payload.fields` | `"address" \| "code" \| "custom_fields" \| "email" \| "name" \| "notes" \| "phone" \| "title" \| "description"` | No | — | A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are: Item type Field Deal `custom_fields`, `notes`, `title` Person `custom_fields`, `email`, `name`, `notes`, `phone` Organization `address`, `custom_fields`, `name`, `notes` Product `code`, `custom_fields`, `name` Lead `custom_fields`, `notes`, `title` File `name` Mail attachment `name` Project `custom_fields`, `notes`, `title`, `description` Only the following custom field types See the live schema for the complete constraint. |
| `payload.search_for_related_items` | `boolean` | No | — | When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization |
| `payload.exact_match` | `boolean` | No | — | When enabled, only full exact matches against the given term are returned. It is not case sensitive. |
| `payload.include_fields` | `"deal.cc_email" \| "person.picture" \| "product.price"` | No | — | A comma-separated string array. Supports including optional fields in the results which are not provided by default. Allowed: `deal.cc_email`, `person.picture`, `product.price`. |
| `payload.limit` | `integer` | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed. |
| `payload.cursor` | `string` | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Performs a search from your choice of item types and fields.",
"properties": {
"term": {
"type": "string",
"description": "The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded."
},
"item_types": {
"type": "string",
"description": "A comma-separated string array. The type of items to perform the search from. Defaults to all.",
"enum": [
"deal",
"person",
"organization",
"product",
"lead",
"file",
"mail_attachment",
"project"
]
},
"fields": {
"type": "string",
"description": "A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are: Item type Field Deal `custom_fields`, `notes`, `title` Person `custom_fields`, `email`, `name`, `notes`, `phone` Organization `address`, `custom_fields`, `name`, `notes` Product `code`, `custom_fields`, `name` Lead `custom_fields`, `notes`, `title` File `name` Mail attachment `name` Project `custom_fields`, `notes`, `title`, `description` Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields here .",
"enum": [
"address",
"code",
"custom_fields",
"email",
"name",
"notes",
"phone",
"title",
"description"
]
},
"search_for_related_items": {
"type": "boolean",
"description": "When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization"
},
"exact_match": {
"type": "boolean",
"description": "When enabled, only full exact matches against the given term are returned. It is not case sensitive."
},
"include_fields": {
"type": "string",
"description": "A comma-separated string array. Supports including optional fields in the results which are not provided by default.",
"enum": [
"deal.cc_email",
"person.picture",
"product.price"
]
},
"limit": {
"type": "integer",
"description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed."
},
"cursor": {
"type": "string",
"description": "For pagination, the marker (an opaque string value) representing the first item on the next page"
}
},
"required": [
"term"
],
"additionalProperties": false
}
```
## Output reference
Standard tool result payload.
| Name | Type | Required | Default | Details |
| ----------------------------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.success` | `boolean` | No | — | If the response is successful or not |
| `result.data.data` | `object` | No | — | — |
| `result.data.data.items` | `array` | No | — | The array of found items |
| `result.data.data.items[].result_score` | `number` | No | — | Search result relevancy |
| `result.data.data.items[].item` | `record` | No | — | Item |
| `result.data.data.related_items` | `array` | No | — | The array of related items if `search_for_related_items` was enabled |
| `result.data.data.related_items[].result_score` | `number` | No | — | Search result relevancy |
| `result.data.data.related_items[].item` | `record` | No | — | Item |
| `result.data.additional_data` | `object` | No | — | Pagination related data |
| `result.data.additional_data.next_cursor` | `string` | No | — | The first item on the next page. The value of the `next_cursor` field will be `null` if you have reached the end of the dataset and there’s no more pages to be returned. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Provider response payload.",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
},
"data": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "The array of found items",
"items": {
"type": "object",
"properties": {
"result_score": {
"type": "number",
"description": "Search result relevancy"
},
"item": {
"type": "object",
"description": "Item"
}
},
"additionalProperties": false
}
},
"related_items": {
"type": "array",
"description": "The array of related items if `search_for_related_items` was enabled",
"items": {
"type": "object",
"properties": {
"result_score": {
"type": "number",
"description": "Search result relevancy"
},
"item": {
"type": "object",
"description": "Item"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"additional_data": {
"type": "object",
"description": "Pagination related data",
"properties": {
"next_cursor": {
"type": "string",
"description": "The first item on the next page. The value of the `next_cursor` field will be `null` if you have reached the end of the dataset and there’s no more pages to be returned."
}
},
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Deepline cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
## Related documentation
* [Pipedrive provider guide](/docs/providers/pipedrive/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)