Pipedrive: Search Persons

Search Pipedrive people by name, email, phone, notes or custom fields.

Tool ID: pipedrive_search_persons

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'pipedrive_search_persons',
  {
    "term": "software companies hiring engineers"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute pipedrive_search_persons --input '{
  "term": "software companies hiring engineers"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "success": true,
    "data": {
      "items": [
        {
          "result_score": 123,
          "item": {}
        }
      ]
    },
    "additional_data": {
      "next_cursor": "cursor_123"
    }
  }
}

Use deepline describe pipedrive_search_persons --json for the latest machine-readable contract.

Input reference

Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. Found persons can be filtered by organization ID.

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.fields`	`"custom_fields" \| "email" \| "notes" \| "phone" \| "name"`	No	—	A comma-separated string array. The fields to perform the search from. Defaults to all of them. 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 . Allowed: `custom_fields`, `email`, `notes`, `phone`, `name`.
`payload.exact_match`	`boolean`	No	—	When enabled, only full exact matches against the given term are returned. It is not case sensitive.
`payload.organization_id`	`integer`	No	—	Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
`payload.include_fields`	`"person.picture"`	No	—	Supports including optional fields in the results which are not provided by default Allowed: `person.picture`.
`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 500 is allowed.
`payload.cursor`	`string`	No	—	For pagination, the marker (an opaque string value) representing the first item on the next page

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`	`object`	No	—	—
`result.data.data.items[].item.id`	`integer`	No	—	The ID of the person
`result.data.data.items[].item.type`	`string`	No	—	The type of the item
`result.data.data.items[].item.name`	`string`	No	—	The name of the person
`result.data.data.items[].item.phones`	`array`	No	—	An array of phone numbers
`result.data.data.items[].item.emails`	`array`	No	—	An array of email addresses
`result.data.data.items[].item.visible_to`	`integer`	No	—	The visibility of the person
`result.data.data.items[].item.owner`	`object`	No	—	—
`result.data.data.items[].item.owner.id`	`integer`	No	—	The ID of the owner of the person
`result.data.data.items[].item.organization`	`object`	No	—	—
`result.data.data.items[].item.organization.id`	`integer`	No	—	The ID of the organization the person is associated with
`result.data.data.items[].item.organization.name`	`string`	No	—	The name of the organization the person is associated with
`result.data.data.items[].item.custom_fields`	`array`	No	—	Custom fields
`result.data.data.items[].item.notes`	`array`	No	—	An array of notes
`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).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation