← Pipedrive

Search persons with Pipedrive API

Pipedream makes it easy to connect APIs for Pipedrive and 900+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Search persons with the Pipedrive API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Create a workflow to Search persons with the Pipedrive API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Search persons action
    1. Connect your Pipedrive account
    2. Configure Search term
    3. Optional- Select a Search fields
    4. Optional- Configure Exact match
    5. Optional- Select a Organization ID
    6. Optional- Select a Include fields
    7. Optional- Configure Pagination start
    8. Optional- Configure Limit
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Search persons with Pipedrive API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Pipedrive
 
Try it
Search persons with Pipedrive API on New Item in Feed from RSS API
RSS + Pipedrive
 
Try it
Search persons with Pipedrive API on New Message from Discord API
Discord + Pipedrive
 
Try it
Search persons with Pipedrive API on New Message In Channels from Slack API
Slack + Pipedrive
 
Try it
Search persons with Pipedrive API on New Message in Channel from Discord Bot API
Discord Bot + Pipedrive
 
Try it

Details

This is a pre-built, open source component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Search persons on Pipedrive
Description: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. See the Pipedrive API docs [here](https://developers.pipedrive.com/docs/api/v1/Persons#searchPersons)
Version:0.1.2
Key:pipedrive-search-persons

Code

import pipedriveApp from "../../pipedrive.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "pipedrive-search-persons",
  name: "Search persons",
  description: "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. See the Pipedrive API docs [here](https://developers.pipedrive.com/docs/api/v1/Persons#searchPersons)",
  version: "0.1.2",
  type: "action",
  props: {
    pipedriveApp,
    term: {
      type: "string",
      label: "Search term",
      description: "The search term to look for. Minimum 2 characters (or 1 if using exact_match).",
    },
    fields: {
      type: "string",
      label: "Search fields",
      description: "A comma-separated string array. The fields to perform the search from. Defaults to all of them.",
      optional: true,
      options: constants.FIELD_OPTIONS,
    },
    exactMatch: {
      type: "boolean",
      label: "Exact match",
      description: "When enabled, only full exact matches against the given term are returned. It is not case sensitive.",
      optional: true,
    },
    organizationId: {
      propDefinition: [
        pipedriveApp,
        "organizationId",
      ],
      description: "Will filter Deals by the provided Organization ID. The upper limit of found Deals associated with the Organization is 2000.",
    },
    includeFields: {
      type: "string",
      label: "Include fields",
      description: "Supports including optional fields in the results which are not provided by default.",
      optional: true,
      options: constants.INCLUDE_FIELDS_OPTIONS,
    },
    start: {
      propDefinition: [
        pipedriveApp,
        "start",
      ],
    },
    limit: {
      propDefinition: [
        pipedriveApp,
        "limit",
      ],
    },
  },
  async run({ $ }) {
    const {
      term,
      fields,
      exactMatch,
      organizationId,
      includeFields,
      start,
      limit,
    } = this;

    try {
      const resp =
        await this.pipedriveApp.searchPersons({
          term,
          fields,
          exact_match: exactMatch,
          org_id: organizationId,
          include_fields: includeFields,
          start,
          limit,
        });

      $.export("$summary", `Successfully found ${resp.data?.items.length || 0} persons`);

      return resp;

    } catch (error) {
      console.error(error.context?.body || error);
      throw error.context?.body?.error || "Failed to search persons";
    }
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
PipedrivepipedriveAppappThis component uses the Pipedrive app.
Search termtermstring

The search term to look for. Minimum 2 characters (or 1 if using exact_match).

Search fieldsfieldsstringSelect a value from the drop down menu:custom_fieldsemailnotesphonename
Exact matchexactMatchboolean

When enabled, only full exact matches against the given term are returned. It is not case sensitive.

Organization IDorganizationIdintegerSelect a value from the drop down menu.
Include fieldsincludeFieldsstringSelect a value from the drop down menu:person.picture
Pagination startstartinteger

Pagination start. Note that the pagination is based on main results and does not include related items when using search_for_related_items parameter.

Limitlimitinteger

Items shown per page.

Authentication

Pipedrive uses OAuth authentication. When you connect your Pipedrive account, Pipedream will open a popup window where you can sign into Pipedrive and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Pipedrive API.

Pipedream requests the following authorization scopes when you connect your account:

About Pipedrive

Sales CRM & Pipeline Management Software

More Ways to Use Pipedrive

Triggers

New Deal from the Pipedrive API

Triggers when a new deal is created.

 
Try it
New Person from the Pipedrive API

Triggers when a new person is created.

 
Try it
Updated Deal from the Pipedrive API

Triggers when a deal is updated.

 
Try it
Updated Person from the Pipedrive API

Triggers when a person is updated.

 
Try it

Actions

Add Activity with the Pipedrive API

Adds a new activity. Includes more_activities_scheduled_in_context property in response's additional_data which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data). See the Pipedrive API docs for Activities here. For info on adding an activity in Pipedrive

 
Try it
Add Deal with the Pipedrive API

Adds a new deal. See the Pipedrive API docs for Deals here

 
Try it
Add Organization with the Pipedrive API

Adds a new organization. See the Pipedrive API docs for Organizations here

 
Try it
Add Person with the Pipedrive API

Adds a new person. See the Pipedrive API docs for People here

 
Try it
Update Deal with the Pipedrive API

Updates the properties of a deal. See the Pipedrive API docs for Deals here

 
Try it