Search People with People Data Labs API

Pipedream makes it easy to connect APIs for People Data Labs and 2,700+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Search People with the People Data Labs API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Configure the Search People action
1. Connect your People Data Labs account
2. Configure Query
3. Select a Query Type
4. Optional- Configure Size
5. Optional- Configure Datasets
6. Optional- Configure Title Case
7. Optional- Configure Pretty
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Search People with People Data Labs API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + People Data Labs

Try it

Search People with People Data Labs API on New Submission from Typeform API

Typeform + People Data Labs

Try it

Search People with People Data Labs API on New Submission (Instant) from Jotform API

Jotform + People Data Labs

Try it

Search People with People Data Labs API on New Scheduled Tasks from Pipedream API

Pipedream + People Data Labs

Try it

Search People with People Data Labs API on npm Download Counts from npm API

npm + People Data Labs

Try it

Details#

This is a pre-built, source-available 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 People on People Data Labs

Description:Find specific segments of people that you need to power your projects and products. [See the docs here](https://docs.peopledatalabs.com/docs/reference-person-search-api)

Version:0.0.1

Key:people_data_labs-search-people

View on GitHub

Code#

import { QUERY_TYPE_OPTIONS } from "../../common/constants.mjs";
import app from "../../people_data_labs.app.mjs";

export default {
  key: "people_data_labs-search-people",
  name: "Search People",
  description: "Find specific segments of people that you need to power your projects and products. [See the docs here](https://docs.peopledatalabs.com/docs/reference-person-search-api)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    query: {
      label: "Query",
      type: "string",
      description: "The query to perform (can be an [Elasticsearch](https://docs.peopledatalabs.com/docs/input-parameters-person-search-api#query) or [SQL query](https://docs.peopledatalabs.com/docs/input-parameters-person-search-api#sql)). Click the preferred query type for the documentation.",
    },
    queryType: {
      label: "Query Type",
      type: "string",
      description: "Which type of query is being used.",
      options: QUERY_TYPE_OPTIONS,
    },
    size: {
      label: "Size",
      type: "integer",
      description: "The batch size or the maximum number of matched records to return for this query if they exist",
      default: 1,
      min: 1,
      max: 100,
      optional: true,
    },
    datasets: {
      label: "Datasets",
      type: "string[]",
      description: "Specifies which [dataset(s)](https://docs.peopledatalabs.com/docs/datasets) the API should search against.",
      optional: true,
    },
    titlecase: {
      type: "boolean",
      label: "Title Case",
      description: "By default, all text in the response data returns as lowercase. Setting to `true` will titlecase any records returned.",
      optional: true,
    },
    pretty: {
      propDefinition: [
        app,
        "pretty",
      ],
    },
  },
  async run({ $ }) {
    const {
      app, query, queryType, ...data
    } = this;
    const params = {
      [queryType]: query,
      ...data,
    };

    const res = await app.searchPeople({
      $,
      params,
    });
    $.export("$summary", res?.status === 200
      ? `Found ${res?.data?.length} records`
      : "No records found");
    return res;
  },
};

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
People Data Labs	`app`	`app`	This component uses the People Data Labs app.
Query	`query`	`string`	The query to perform (can be an Elasticsearch or SQL query). Click the preferred query type for the documentation.
Query Type	`queryType`	`string`	Select a value from the drop down menu:`{ "label": "Elasticsearch query", "value": "query" }{ "label": "SQL query", "value": "sql" }`
Size	`size`	`integer`	The batch size or the maximum number of matched records to return for this query if they exist
Datasets	`datasets`	`string[]`	Specifies which dataset(s) the API should search against.
Title Case	`titlecase`	`boolean`	By default, all text in the response data returns as lowercase. Setting to `true` will titlecase any records returned.
Pretty	`pretty`	`boolean`	Whether the output should have human-readable indentation.