# LinkedIn

{% hint style="info" %}
This widget supports multiple actions. For a more comprehensive understanding of its functionality, we recommend reviewing the following documentation carefully.

You need to pass both the `action` and other input parameters of the chosen action to your `module_config`
{% endhint %}

## Try it in the Widget Center

Click this [url](https://app.myshell.ai/robot-workshop/widget/1787389541640318976) to try this widget and copy the Pro Config template.

## Usage

### Domain Search

<mark style="color:green;">`action`</mark> `domain_search`

This endpoint enables you to discover email addresses associated with a domain name, website, or company name. Additionally, you have the option to obtain highly accurate and unique company data enrichment.

**Input Parameters**

<table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default</th><th data-type="checkbox">Required</th></tr></thead><tbody><tr><td>action</td><td><code>string</code></td><td>The action to perform</td><td>domain_search</td><td>true</td></tr><tr><td>company</td><td><code>string</code></td><td>The company domain, website or name. Using a domain or website is recommended for better accuracy. If submitting a company name, it needs to be between 3 to 75 characters</td><td>myshell.ai</td><td>true</td></tr><tr><td>company_enrichment</td><td><code>boolean</code></td><td>Whether to enrich the company data</td><td>False</td><td>false</td></tr></tbody></table>

**Output Parameters**

| Name | Type     | Description                           | File Type |
| ---- | -------- | ------------------------------------- | --------- |
| data | `object` | The data returned by the Linkedin API |           |

**Output Example**

{% tabs %}
{% tab title="success" %}
{% code fullWidth="false" %}

```json
{
  "data": {
    "error": false,
    "response": {
      "company_enrichment": null,
      "email_list": [
        {
          "email": "mica@myshell.ai",
          "email_anon_id": "NBD533y6Pgiq",
          "email_type": "professional",
          "first_name": "Mica",
          "last_name": "Zhang",
          "verification": {
            "last_verified_at": "2024-02-19 22:30:17.151542+00:00",
            "status": "VALID"
          }
        },
        {
          "email": "ethan@myshell.ai",
          "email_anon_id": "QqcHBgkDctie",
          "email_type": "professional",
          "first_name": "Ethan",
          "last_name": "Sun",
          "verification": {
            "last_verified_at": "2024-02-11 00:52:17.637839+00:00",
            "status": "VALID"
          }
        },
        {
          "email": "hance@myshell.ai",
          "email_anon_id": "Vw89JoY3hlTK",
          "email_type": "professional",
          "first_name": "Hance",
          "last_name": "Zhang",
          "verification": {
            "last_verified_at": "2024-03-26 13:29:37.178356+00:00",
            "status": "VALID"
          }
        },
        {
          "email": "anny@myshell.ai",
          "email_anon_id": "wZPHy8lYqfbS",
          "email_type": "professional",
          "first_name": "Anny",
          "last_name": "Ma",
          "verification": {
            "last_verified_at": "2024-04-01 01:51:20.439291+00:00",
            "status": "VALID"
          }
        },
        {
          "email": "ouyang@myshell.ai",
          "email_anon_id": "zvm4BkofdtxX",
          "email_type": "professional",
          "first_name": "Chengwei",
          "last_name": "Ouyang",
          "verification": {
            "last_verified_at": "2024-05-06 05:35:56.131826+00:00",
            "status": "VALID"
          }
        }
      ],
      "meta": {
        "domain": "myshell.ai",
        "limit": 50,
        "more_results": false,
        "remaining_emails": 0,
        "search_id": "l3K8H1T1j5pZ",
        "total_emails": 5
      }
    }
  }
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

### Email Finder

<mark style="color:green;">`action`</mark> `email_finder`

This endpoint allows you to uncover professional emails by providing a first and last name or a full name, along with a company (domain, website, or company name). The system leverages multiple patterns and advanced technology to discover and verify emails while staying fully GDPR compliant.

**Input Parameters**

<table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default</th><th data-type="checkbox">Required</th></tr></thead><tbody><tr><td>action</td><td><code>string</code></td><td>The action to perform</td><td>email_finder</td><td>true</td></tr><tr><td>company</td><td><code>string</code></td><td>The company domain, website or name. Using a domain or website is recommended for better accuracy. If submitting a company name, it needs to be between 3 to 75 characters</td><td>myshell.ai</td><td>true</td></tr><tr><td>first_name</td><td><code>string</code></td><td>The first name of the person to find the email for</td><td></td><td>false</td></tr><tr><td>last_name</td><td><code>string</code></td><td>The last name of the person to find the email for</td><td></td><td>false</td></tr><tr><td>full_name</td><td><code>string</code></td><td>The full name of the person to find the email for. We advise you to submit the first and last name for higher accuracy</td><td></td><td>false</td></tr></tbody></table>

**Output Parameters**

| Name | Type     | Description                           | File Type |
| ---- | -------- | ------------------------------------- | --------- |
| data | `object` | The data returned by the Linkedin API |           |

**Output Example**

{% tabs %}
{% tab title="success" %}
{% code fullWidth="false" %}

```json
{
  "data": {
    "error": false,
    "response": {
      "domain": "myshell.ai",
      "email": "ouyang@myshell.ai",
      "email_anon_id": "zvm4BkofdtxX",
      "email_status": "VALID",
      "first_name": "Chengwei",
      "free": true,
      "last_name": "Ouyang",
      "total_emails": 5
    }
  }
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

### Linkedin Profile Finder

<mark style="color:green;">`action`</mark> `profile_finder`

This endpoint enables you to extract data from any LinkedIn profile in real-time, as well as all the data from the company page, and also find a valid verified email from the lead, in a clean JSON output with extracted details and the verified email, in one request.

You also have the option to only fetch the real-time profile data, with an average response time of 3 seconds.

The input parameter is a LinkedIn URL. You can use either a Sales Navigator encrypted URL or a standard LinkedIn URL.

**Input Parameters**

<table><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default</th><th data-type="checkbox">Required</th></tr></thead><tbody><tr><td>action</td><td><code>string</code></td><td>The action to perform</td><td>profile_finder</td><td>true</td></tr><tr><td>url</td><td><code>string</code></td><td>The LinkedIn profile URL to search</td><td></td><td>true</td></tr><tr><td>profile_only</td><td><code>boolean</code></td><td>This option allows you to specify you only need the data from the LinkedIn profile, but no in-depth company details and no email</td><td>False</td><td>true</td></tr></tbody></table>

**Output Parameters**

| Name | Type     | Description                           | File Type |
| ---- | -------- | ------------------------------------- | --------- |
| data | `object` | The data returned by the Linkedin API |           |

**Output Example**

{% tabs %}
{% tab title="success" %}
{% code fullWidth="false" %}

```json
{
  "data": {
    "error": false,
    "response": {
      "company": {
        "common_email_pattern": "{first}{last}",
        "description": "Founded in Silicon Valley in 2018, Orka is an innovative global hearing technology company born out of a passion and commitment to address hearing loss challenges intelligently. As one of the first multinational companies to employ AI technology throughout the full lifecycle of hearing aids, Orka is dedicated to creating an integrated hearing aid system that combines hardware, machine learning, and services.\n\nOur new FDA-registered hearing aid, Orka Two, with proprietary AI DeNoise technology and Bluetooth 5.3  is now available.",
        "domain": "hiorka.com",
        "founded_in": 2018,
        "industry": "Medical Equipment Manufacturing",
        "is_catch_all": null,
        "linkedin": "https://www.linkedin.com/company/orkahearingaids",
        "location": {
          "address": null,
          "city": "Chicago",
          "country": "United States",
          "country_code": "US",
          "postal_code": null,
          "state": null,
          "timezone": "America/New_York",
          "timezone_offset": "-4.0"
        },
        "logo": "https://assets-prospeo.s3.us-east-2.amazonaws.com/company_HAI2DFBHN9CT2YCAHDY5.jpg",
        "name": "Orka",
        "size": "51-200",
        "total_emails": 15,
        "website": "http://www.hiorka.com"
      },
      "current_job_month": 5,
      "current_job_year": 2020,
      "education": [],
      "email": {
        "email": null,
        "email_anon_id": null,
        "email_status": "NOT_FOUND",
        "email_type": "professional"
      },
      "entity_urn": "ACoAACUEkIoBFvU4QQNHWUhg5tzGXNJQdpU8bF0",
      "first_name": "Chengwei",
      "full_name": "chengwei ouyang",
      "gender": "male",
      "job_title": "--",
      "languages": {
        "primary_locale": {
          "country": "US",
          "language": "en"
        },
        "profile_languages": [],
        "supported_locales": [
          {
            "country": "US",
            "language": "en"
          }
        ]
      },
      "last_name": "Ouyang",
      "linkedin": "https://www.linkedin.com/in/chengwei-ouyang-5a2ba7153",
      "location": {
        "city": null,
        "country": "China",
        "country_code": "CN",
        "postal_code": null,
        "raw": "China",
        "state": null,
        "timezone": "Asia/Shanghai",
        "timezone_offset": 8
      },
      "picture": null,
      "premium": false,
      "skills": "Full-Stack Development, Speech Enhancement, Digital Signal Processing, Deep Learning",
      "summary": null,
      "work_experience": [
        {
          "company": {
            "employees": {
              "end": 200,
              "start": 51
            },
            "id": 28804048,
            "logo": "https://media.licdn.com/dms/image/C560BAQGrT1wWAkqsIw/company-logo_400_400/0/1630649520385/evoco_labs_logo?e=1723075200\u0026v=beta\u0026t=3hmIa1GRR32mDKqWHDPxeZBlR-nKzEH783vHVSGRIWg",
            "name": "Orka",
            "url": "https://www.linkedin.com/company/orkahearingaids/"
          },
          "date": {
            "end": {
              "day": null,
              "month": 1,
              "year": 2024
            },
            "start": {
              "day": null,
              "month": 5,
              "year": 2020
            }
          },
          "profile_positions": [
            {
              "company": "Orka",
              "date": {
                "end": {
                  "day": null,
                  "month": 1,
                  "year": 2024
                },
                "start": {
                  "day": null,
                  "month": 5,
                  "year": 2020
                }
              },
              "description": null,
              "employment_type": null,
              "location": "Shanghai, China",
              "title": "Algorithm Engineer"
            }
          ]
        }
      ]
    }
  }
}
```

{% endcode %}
{% endtab %}
{% endtabs %}