Name2Profile LinkedIn Profile Finder API Documentation

The Name2Profile API enables you to find employee LinkedIn profiles given a name, company, and/or email address. You can process using bulk API calls or a CSV import.

Calling the API

V1 of the API is hosted at https://www.name2profile.com/api/v1. All calls use this URL as the base.

Authentication

The Name2Profile API uses token-based authentication. If you're logged into your Name2Profile account, you'll see your API key below.

Your API key is <<log in to see your key>>.

Simply include key as a query parameter or a header parameter in your queries, like this: https://www.name2profile.com/api/v1/batches?key=<<log in to see your key>>.

If you don't include an API key or use the wrong one, Name2Profile will respond with a 401 authorization error.

Status and Error Codes

Here are the most common HTTP status codes you may receive from our API and what they mean.

  • 200: Request and response were successful.
  • 401: The API key you used was not found.
  • 404: The endpoint you're looking for wasn't found or is not accessible from your account.
  • 405: The method you attempted was not allowed.
  • 500: There was a server error.

Profiles

Find a LinkedIn profile

This endpoint converts a single set of employee data into a LinkedIn profile. The response may include title and headline.

Parameters
key (required)
Your API key
first_name (required)
The first name of the employee
last_name (required)
The last name of the employee
company (required)
The company name where the employee works.
Example

GET https://www.name2profile.com/api/v1/profile?key=<<log in to see your key>>&first_name=rich&last_name=barton&company=expedia

Result

{
  "status": "SUCCESS",
  "message": "Profiled the employee.",
  "data": {
    "li_handle": "richbarton",
    "first_name": "rich",
    "last_name": "barton",
    "company": "expedia",
    "li_profile": "https://www.linkedin.com/in/richbarton",
    "headline": "Rich Barton - Co-founder & CEO - Zillow Group"
  }
}

Batches

List batches

This is the index call for your batches. Batches store the bulk employee data you submitted for processing. A status attibute on the batch will tell you whether the batch is still processing or finished.

Example

GET https://www.name2profile.com/api/v1/batches?key=<<log in to see your key>>

Result

{
  "status": "SUCCESS",
  "message": "Loaded all batches.",
  "data": [
    {
      "id": 24,
      "user_id": 1,
      "name": "Marketing batch A",
      "created_at": "2020-02-04T23:38:06.876Z",
      "updated_at": "2020-02-04T23:38:06.955Z",
      "status": "ready"
    }
  ],
  "last_page": true,
  "total_count": 1
}

Create a batch

Add a batch of employees to process on your account.

Parameters
key (required)
Your API key
name (required)
A name to identify or describe your batch
data (required)
JSON formatted employee payload
webhook_url (optional)
Fully-formed URL to accept a POST request containing the batch attributes when the batch status changes to finished.
The JSON payload should have these keys.
first_name (required)
First name of the employee
last_name (required)
Last name of the employee
company (required)
Name of company (can be string or website or domain)
meta (optional)
JSON formatted metadata, which could include an internal ID
Example

POST https://www.name2profile.com/api/v1/batches

Result

{
  "status": "SUCCESS",
  "message": "Created batch.",
  "data": {
    "id": 24,
    "user_id": 1,
    "name": "Marketing batch A",
    "created_at": "2020-02-04T23:38:06.876Z",
    "updated_at": "2020-02-04T23:38:06.955Z",
    "status": "ready"
  }
}

List profiles

This is the index call for the employees in a batch. It's the equivalent to exporting the data from Name2Profile and is done on a batch-by-batch basis.

Example

GET https://www.name2profile.com/api/v1/batch/<batch_id>/profiles?key=<<log in to see your key>>

Result

{
  "status": "SUCCESS",
  "message": "Loaded profiles.",
  "data": [
    {
      "first_name": "Mary",
      "last_name": "Olsen",
      "company": "Pacificsource Health Plans",
      "headline": "Mary Olsen - Director of Operations - PacificSource Health Plans ...",
      "li_profile": "https://www.linkedin.com/in/mary-olsen-a3a24789",
      "li_handle": "mary-olsen-a3a24789",
      "meta": null
    },
    {
      "first_name": "Regan",
      "last_name": "Gralinski",
      "company": "Pacifica",
      "headline": "",
      "li_profile": null,
      "li_handle": null,
      "meta": null
    },
    {
      "first_name": "Curt",
      "last_name": "Foody",
      "company": "North American Company for Life & Health Insurance",
      "headline": "Curt Foody - University of Illinois at Chicago - Greater Chicago Area ...",
      "li_profile": "https://www.linkedin.com/in/curt-foody-06529b9a",
      "li_handle": "curt-foody-06529b9a",
      "meta": null
    }
  ]
}