Getting Started

The easiest way to get started is to use the Apply with LinkedIn plugin generator. This documentation is for people who need to programmatically generate multiple versions of the plugin.

It's best to begin by getting the most basic version of the plugin working. This lets you test that everything is configured properly. Once this is complete, you can go ahead and further customize the plugin.

Step 1: Sign up for an API key

If you don't already have an API key, you need one to use the Apply with LinkedIn Plugin. Create an API key and remember the API Key we generate for you. It will look something like: d8amgl12v4ht (if you got a key after July, 2011) or 956amzk8Yg8GHeNzAuWcdlFjKS3980mGis24LWtUxLsDA-Bi7cGrQv8bx3xd4eNK (if you got a key before then). If you do have one, you can reuse it here. Either way, this key works for the Apply with LinkedIn plugin and also our REST and JavaScript APIs.

Be sure to set the JavaScript API domain to match your site's domain. If you use multiple subdomains, add them in a commas separated list, such as

http://www.linkedin.com, http://developer.linkedin.com, http://staging.linkedin.com

(All this information and more is in our JavaScript API Getting Started Guide.)

Step 2: Load the framework

To load the Javascript framework, embed our JavaScript in your HTML page:

<script type="text/javascript" src="http://platform.linkedin.com/in.js">
      api_key: <YOUR API KEY GOES HERE>
</script>

Replace <YOUR API KEY GOES HERE> with the API Key from Step 1. You don't need the angle brackets.

Step 3: Embed The Apply with LinkedIn Plugin tag

Place this tag on your page where you want the Apply plugin to appear.

<script type="IN/Apply"></script>

The tag needs three parameters to work. This will identify the company, job title, and delivery mechanism.

Step 4: Company

Pass one of two parameters to indicate the company with the job opening. You can do this by using data-companyId or data-companyName.

If your company has a LinkedIn Company Id, we strongly suggest you use data-companyId. This will provide the best experience for the applicant. For example, the applicant can see who else they know at the company after sending the application. It will also auto-populate the name, location, and logo for your company. You can override any of these pre-populated fields if you want to.

Here's the code for LinkedIn:

      data-companyId="1337"

If you only need the Company Id for one company, use the Apply with LinkedIn generator to have us convert your company name to a LinkedIn company ID.

Or, start typing your company name in the box below to select your company from a drop down list and see the information we have for your company:

Company ID lookup

If you need to populate this for multiple companies, read the documentation on programmatically looking up companies Ids using our REST API.

If your company does not have a LinkedIn Company Id, no problem! You can create one by filling out a form to create a company page on LinkedIn. Adding your company to the list of official LinkedIn company pages has many benefits beyond Apply with LinkedIn, but when you use it here applicants will be able to see who they know at your company -- which increases conversion significantly. So, we definitely recommend spending the few minutes necessary to add a page and get your Company Id.

If we still haven't convinced you about the benefits of using a Company Id, use the data-companyName parameter to pass along this required information. For example:

      data-companyName="XYZ Company"

Step 5: Job Title

Every job requires a job title.

      data-jobTitle="Chief Cat Wrangler"

This lets applicants know what they're applying for. It can be detailed or generic ("Member of the technical staff"), but it needs to be there.

Step 6: Delivery

Last, you must indicate how you want the applications to be sent back to your company. The easiest method is to have the applications delivered via e-mail.

      data-email="jobs@mycompany.com"

You can also have the plugin send an HTTP POST of the application to your own web service. This is covered on the Apply Processing Options page.

Putting it all Together

Here's the full code for a basic Apply with LinkedIn Plugin:

<html>
<head>
  <title>Apply with LinkedIn</title>
</head>
<body>

<script type="text/javascript" src="http://platform.linkedin.com/in.js">
  api_key: YOUR_API_KEY
</script>

<script type="IN/Apply" 
  data-companyId="1337" 
  data-jobTitle="Chief Cat Wrangler" 
  data-email="your-email-address@your-company.com">
</script>
      
</body>
</html>

Awesome, you have an Apply Plugin on your page! It behaves like this:

The next step is learning the visual display and functional options. This lets you configure the look-and-feel and behavior of the plugin.

After that, read how to receive applications. This shows the schema for the application data we send to you, how to specify where we send it, and whether we use XML or JSON. We have sample code included in many languages to help get you started.

Last, all of the supported parameters are on the Apply with LinkedIn Reference Guide. These tables are handy for lookups, when you want to double-check how a specific parameter behaves.