← Close

Search Leads with Close API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Search Leads with the Close 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 Leads with the Close API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Search Leads action
    1. Connect your Close account
    2. Configure Field
    3. Configure Text
  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 Leads with Close API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Close
 
Try it
Search Leads with Close API on New Message from Discord API
Discord + Close
 
Try it
Search Leads with Close API on New Message In Channels from Slack API
Slack + Close
 
Try it
Search Leads with Close API on New Message in Channel from Discord Bot API
Discord Bot + Close
 
Try it
Search Leads with Close API on New Submission from Typeform API
Typeform + Close
 
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 Leads on Close
Description:Searching leads with a given field and word, [See the docs](https://developer.close.com/resources/advanced-filtering/)
Version:0.0.1
Key:close-search-leads

Code

import close from "../../close.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  type: "action",
  key: "close-search-leads",
  version: "0.0.1",
  name: "Search Leads",
  description: "Searching leads with a given field and word, [See the docs](https://developer.close.com/resources/advanced-filtering/)",
  props: {
    close,
    field: {
      label: "Field",
      description: "Field name which will be searched in, e.g. 'name'",
      type: "string",
    },
    text: {
      label: "Text",
      description: "Contained text",
      type: "string",
    },
  },
  async run({ $ }) {
    const data = {};
    if (this.name) data.name = this.name;
    if (this.url) data.url = this.url;
    if (this.statusId) data.status_id = this.statusId;
    if (this.contacts) data.contacts = utils.parseObject(this.contacts);
    if (this.addresses) data.addresses = utils.parseObject(this.addresses);
    const moreFields = {};
    for (let key in this.moreFields) {
      moreFields[key] = utils.parseObject(this.moreFields[key]);
    }
    const response = await this.close.searchLeads({
      data: {
        query: {
          queries: [
            {
              object_type: "lead",
              type: "object_type",
            },
            {
              type: "field_condition",
              field: {
                object_type: "lead",
                type: "regular_field",
                field_name: this.field,
              },
              condition: {
                type: "text",
                mode: "full_words",
                value: this.text,
              },
            },
          ],
          type: "and",
        },
      },
    });
    $.export("$summary", `${response.data.data.length} Leads has been found.`);
    return response.data;
  },
};

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
ClosecloseappThis component uses the Close app.
Fieldfieldstring

Field name which will be searched in, e.g. 'name'

Texttextstring

Contained text

Authentication

Close uses API keys for authentication. When you connect your Close account, Pipedream securely stores the keys so you can easily authenticate to Close APIs in both code and no-code steps.

API keys are per-organization and can be generated and deleted in the Settings page.

About Close

Inside Sales Software CRM with Calling & Emailing

More Ways to Use Close

Triggers

New Custom Event from the Close API

Emit new event when configured type of events triggered, See all possibilities

 
Try it
New Lead from the Close API

Emit new event when a new Lead is created

 
Try it
New Lead Status Change from the Close API

Emit new event when a Lead status is changed

 
Try it
New Opportunity from the Close API

Emit new event when a new Opportunity is created

 
Try it

Actions

Create Lead with the Close API

Creates a lead, See the docs

 
Try it
Custom Action with the Close API

Makes an aribitrary call to Close API, See for all options.

 
Try it
Update Lead with the Close API

Updates a lead, See the docs

 
Try it