Search Profiles with LinkupAPI for LinkedIn API

Pipedream makes it easy to connect APIs for LinkupAPI for LinkedIn and 3,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Search Profiles with the LinkupAPI for LinkedIn 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 Profiles with the LinkupAPI for LinkedIn API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Search Profiles action
1. Connect your LinkupAPI for LinkedIn account
2. Configure Login Token
3. Optional- Configure Keyword
4. Optional- Configure First Name
5. Optional- Configure Last Name
6. Optional- Configure Job Title
7. Optional- Configure Company URLs
8. Optional- Configure Locations
9. Optional- Configure School URLs
10. Optional- Select one or more Network Connection Level
11. Optional- Configure Total Results
12. Optional- Configure Fetch Invitation State
13. Optional- Select a Country
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

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 Profiles on LinkupAPI for LinkedIn

Description:Search for LinkedIn profiles based on criteria. [See the documentation](https://docs.linkupapi.com/api-reference/linkup/Profile/search)

Version:0.0.1

Key:linkupapi-search-profiles

View on GitHub

Code#

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

export default {
  type: "action",
  key: "linkupapi-search-profiles",
  name: "Search Profiles",
  description: "Search for LinkedIn profiles based on criteria. [See the documentation](https://docs.linkupapi.com/api-reference/linkup/Profile/search)",
  version: "0.0.1",
  props: {
    app,
    loginToken: {
      propDefinition: [
        app,
        "loginToken",
      ],
    },
    keyword: {
      type: "string",
      label: "Keyword",
      description: "Search keyword to find relevant profiles",
      optional: true,
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "First name parameter for advanced keyword search",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Last name parameter for advanced keyword search",
      optional: true,
    },
    title: {
      type: "string",
      label: "Job Title",
      description: "Job title parameter for advanced keyword search",
      optional: true,
    },
    companyUrl: {
      propDefinition: [
        app,
        "companyUrl",
      ],
    },
    location: {
      description: "Geographic locations to filter profiles",
      propDefinition: [
        app,
        "location",
      ],
    },
    schoolUrl: {
      type: "string[]",
      label: "School URLs",
      description: "LinkedIn school URLs",
      optional: true,
    },
    network: {
      type: "string[]",
      label: "Network Connection Level",
      description: "Filter by connection level",
      options: [
        {
          value: "F",
          label: "First-degree connections (1st)",
        },
        {
          value: "S",
          label: "Second-degree connections (2nd)",
        },
        {
          value: "O",
          label: "Out-of-network connections (3rd+)",
        },
      ],
      optional: true,
    },
    totalResults: {
      type: "integer",
      label: "Total Results",
      description: "Number of profiles to retrieve (default: `10`)",
      optional: true,
    },
    fetchInvitationState: {
      type: "boolean",
      label: "Fetch Invitation State",
      description: "Whether to fetch the invitation/connection status for each profile",
      optional: true,
    },
    country: {
      propDefinition: [
        app,
        "country",
      ],
    },
  },
  annotations: {
    readOnlyHint: true,
    destructiveHint: false,
    openWorldHint: true,
    idempotentHint: true,
  },
  async run({ $ }) {
    const {
      app,
      loginToken,
      country,
      keyword,
      firstName,
      lastName,
      title,
      companyUrl,
      location,
      schoolUrl,
      network,
      totalResults,
      fetchInvitationState,
    } = this;

    const response = await app.searchProfiles({
      $,
      data: {
        login_token: loginToken,
        country,
        keyword,
        first_name: firstName,
        last_name: lastName,
        title,
        company_url: utils.getOptionalProp(companyUrl),
        location: utils.getOptionalProp(location),
        school_url: utils.getOptionalProp(schoolUrl),
        network: utils.getOptionalProp(network, ","),
        fetch_invitation_state: fetchInvitationState,
        total_results: totalResults,
      },
    });

    $.export("$summary", "Successfully retrieved profiles");
    return response;
  },
};

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
LinkupAPI for LinkedIn	`app`	`app`	This component uses the LinkupAPI for LinkedIn app.
Login Token	`loginToken`	`string`	LinkedIn authentication token obtained from login/verify process
Keyword	`keyword`	`string`	Search keyword to find relevant profiles
First Name	`firstName`	`string`	First name parameter for advanced keyword search
Last Name	`lastName`	`string`	Last name parameter for advanced keyword search
Job Title	`title`	`string`	Job title parameter for advanced keyword search
Company URLs	`companyUrl`	`string[]`	LinkedIn company URLs. Eg. `https://www.linkedin.com/company/stripe/`
Locations	`location`	`string[]`	Geographic locations to filter profiles
School URLs	`schoolUrl`	`string[]`	LinkedIn school URLs
Network Connection Level	`network`	`string[]`	Select a value from the drop down menu:`{ "value": "F", "label": "First-degree connections (1st)" }{ "value": "S", "label": "Second-degree connections (2nd)" }{ "value": "O", "label": "Out-of-network connections (3rd+)" }`
Total Results	`totalResults`	`integer`	Number of profiles to retrieve (default: `10`)
Fetch Invitation State	`fetchInvitationState`	`boolean`	Whether to fetch the invitation/connection status for each profile
Country	`country`	`string`	Select a value from the drop down menu:`USUKFRDENLITILCABRESIN`