Search persons with Pipedrive API on Custom Interval from Schedule API

Pipedream makes it easy to connect APIs for Pipedrive, Schedule and 2,000+ other apps remarkably fast.

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

Search persons with the Pipedrive API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

Trusted by 800,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Schedule trigger and Pipedrive action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Custom Interval trigger
1. Connect your Schedule account
2. Configure Cron Schedule
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
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

Custom Interval on Schedule

Description:Trigger your workflow every N hours, minutes or seconds.

Version:0.0.2

Key:schedule-custom-interval

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

import schedule from "../../schedule.app.mjs";

export default {
  name: "Custom Interval",
  version: "0.0.2",
  key: "schedule-custom-interval",
  type: "source",
  description: "Trigger your workflow every N hours, minutes or seconds.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
    },
  },
};

Trigger 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.

Label	Prop	Type	Description
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

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.5

Key:pipedrive-search-persons

View on GitHub

Pipedrive Overview#

Pipedrive API on Pipedream allows you to create powerful sales automation and data management workflows. With access to Pipedrive's CRM capabilities, you can automate deal updates, contact management, and sales reporting. Whether you're syncing customer information across platforms or triggering actions based on deal stages, Pipedream makes these integrations seamless.

Action Code#

import constants from "../../common/constants.mjs";
import pipedriveApp from "../../pipedrive.app.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.5",
  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";
    }
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Pipedrive	`pipedriveApp`	`app`	This component uses the Pipedrive app.
Search term	`term`	`string`	The search term to look for. Minimum 2 characters (or 1 if using exact_match).
Search fields	`fields`	`string`	Select a value from the drop down menu:`custom_fieldsemailnotesphonename`
Exact match	`exactMatch`	`boolean`	When enabled, only full exact matches against the given term are returned. It is not case sensitive.
Organization ID	`organizationId`	`integer`	Select a value from the drop down menu.
Include fields	`includeFields`	`string`	Select a value from the drop down menu:`person.picture`
Pagination start	`start`	`integer`	Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
Limit	`limit`	`integer`	Items shown per page.

Action 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#

Pipedrive is the easy-to-use, #1 user-rated CRM tool. Get more qualified leads and grow your business with Pipedrive's sales CRM.

More Ways to Connect Pipedrive + Schedule#

Other Popular Integrations#

Add Activity with Pipedrive API on Schedule based on a custom interval from Schedule API

Schedule + Pipedrive

Search persons with Pipedrive API on Custom Interval from Schedule API

Pipedream makes it easy to connect APIs for Pipedrive, Schedule and 2,000+ other apps remarkably fast.

Trusted by 800,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,000+apps by most popular

1
-
24
of
2,000+
apps by most popular