Skip to content

Instantly share code, notes, and snippets.

@stcalica
Last active November 20, 2023 22:47
Show Gist options
  • Save stcalica/c54f70d65f0e364d66fc6916ddc6bc19 to your computer and use it in GitHub Desktop.
Save stcalica/c54f70d65f0e364d66fc6916ddc6bc19 to your computer and use it in GitHub Desktop.
linkedin_postman_profile.md

LinkedIn Team Description

The official Team for LinkedIn Developer API workspaces.

Our API documentation is organized by business lines covering Consumer, Compliance, Learning, Marketing, Sales, and Talent Solutions. Follow the links below to learn more about business lines and their possible integration types. Please checkout our API documentation overview.

To get started with using these APIs please create an account and app over at our Developer Portal.

Note: The use of the APIs listed in this workspace are restricted to developers approved by LinkedIn. For support or to provide feedback, please submit a developer support ticket.

LinkedIn Consumer Solutions Workspace Overview

The LinkedIn Consumer Solutions Platform enables sites and applications the power to enhance their sign-in experience using the world's largest professional network. The Consumer Solutions Platform contains APIs to Sign In with LinkedIn and Share on LinkedIn. Follow the links below to learn more about the Consumer Solutions Platform APIs.

Ready to start development? Refer to the links below for guidance on building your application.

Note: The use of the APIs listed in this workspace are restricted to developers approved by LinkedIn. For support or to provide feedback, please submit a developer support ticket.

LinkedIn Learning Solutions Workspace Overview

LinkedIn Learning is an online learning platform that combines the industry-leading content from Lynda.com with LinkedIn’s professional data and network. LinkedIn Learning is built on three core pillars:

  • World-class content: Our library of 9,000+ digital courses are taught by industry experts and cover a wide range of business, creative and technical topics, from leadership “soft skills” to design principles to programming. We’re always evolving the Lynda.com library, adding at least 25 courses a week, and teaching the leading-edge skills you need to stay current. Plus, we also offer courses in German, Spanish, Japanese and French.
  • Data-driven personalization: We get the right course in front of you at the right time. Using the intelligence that comes with our network, LinkedIn Learning creates personalized recommendations, so learners can efficiently discover which courses are most relevant to their goals or job function. Organizations can use LinkedIn insights to customize multi-course Learning Paths to meet their specific needs. We also provide robust analytics and reporting to help you measure learning effectiveness.
  • Anytime, anywhere convenience: It isn’t enough to know exactly which course to take – it also needs to be easy to take. Our courses are broken into bite-sized segments that can be viewed anytime, on any device, online and off. Learning content is recommended throughout your LinkedIn.com experience, helping you easily discover relevant courses, and the content can be integrated with a learning management system.

LinkedIn Learning APIs are designed to represent LinkedIn Learning content in a unified and extensible format. The endpoints can be used to integrate LinkedIn Learning catalog metadata and search into your application. Using LinkedIn Learning APIs you can:

  • Retrieve a page of learning assets, given some criteria.
  • Retrieve an individual learning asset, given an URN.
  • Retrieve a page of learning classifications, given some criteria.
  • Retrieve an individual learning classification, given an URN.
  • Retrieve a page of learning assets, given some search and relevance criteria.
  • Retrieve a list of learning assets updated since a given date.
  • Retrieve a page of learning classifications, given a keyword.

In researching standards and implementations of learning content metadata, we adopted patterns that will allow the API to evolve and expand using the same fundamental data model. This means after you integrate with the API presented in this document, your integration can more easily take advantage of new types of LinkedIn Learning content and content information as we add them to the API.

Note: The use of the APIs listed in this workspace are restricted to developers approved by LinkedIn. For support or to provide feedback, please submit a developer support ticket.

LinkedIn Talent Solutions Workspace Overview

The LinkedIn Talent Solutions enhances candidate sourcing and recruiting experience for ATSs and applications using the world's largest professional network. Here is more documnetation on our Talent Solutions APIs here.

Note: The use of the APIs listed in this workspace are restricted to developers approved by LinkedIn. For support or to provide feedback, please submit a developer support ticket.

LinkedIn Marketing Solutions Versioned APIs Workspace Overview

The LinkedIn Marketing Platform helps businesses grow by building technology to reach, engage, and convert professional audiences at scale. The platform offers APIs to create LinkedIn marketing campaigns, to report campaign performance, to manage leads, and to grow a company Page. More documentation on the Marketing Solution APIs here.

This is a quick start guide to get you started with the LinkedIn APIs. You can perform the following using this guide:

  1. Apply for API access.
  2. Get started with the Advertising API.
  3. Get started with the Community Management.
  4. Get started with the Lead Sync API.
  5. Get started with the Conversions API.
  6. Learn about the tools to manage your app.

Step 1: Apply for API Access

  1. Create a LinkedIn Page.
  2. Create a developer application in the Developer Portal.
  3. Review our API and data restrictions to ensure your use case is supported and your application will not be rejected due to a restricted use case.
  4. Apply to the Advertising or Community Management or Lead Sync or Conversions API under the Products tab of your app.
  5. Complete the access form.

Step 2: Get Started with the Advertising API

  1. Generate an access token.
    Generate an access token to make authenticated API calls either through Token Generator tool available on the Developer Portal or the LinkedIn Marketing Solutions Workspace on the Postman Network.

  2. Ensure you the right permission based on your use case.
    Review the permissions available and confirm you have access to the right permissions in the Developer Portal under the Auth tab for your app.

  3. Validate which ad accounts a user has access to.
    The /adAccountUsers endpoint has the following methods to determine which members have access to which Ad Accounts. Follow the links below for specific examples.

    Additionally, /adAccountUsers can be used to grant, update, or revoke access to an Ad Account. This action must be performed using the token of a member who has either an ACCOUNT_BILLING_ADMIN or ACCOUNT_MANAGER role.

  4. Map the ad account ID to your application.

  5. From the Campaign Manager tool, copy the nine-digit Ad Account ID.

  6. Open the Developer Portal and select your application.

  7. From the Products tab, click View Ad Accounts.

  8. Choose Add Ad Account and enter the Ad Account ID and save the changes.

  9. Review the Tips to Get Started.

  10. Check out the Advertising Use Case Guide to build your solution.

  11. Once you’ve built and tested your application, apply for Standard tier access.
    To upgrade to Advertising API Standard tier, first build and test your application and then submit a a tier upgrade request including a video demonstrating how your platform creates, edits, and/or optimizes LinkedIn campaigns.

Step 3: Get Started with the Community Management API

*If you have an existing integration and need to migrate to the new API, check out the migration guide. If you are new to LinkedIn Marketing APIs, refer to the following the steps:

  1. Generate an access token.
    Generate an access token to make authenticated API calls either through Token Generator tool available on the Developer Portal or the LinkedIn Marketing Solutions Workspace on the Postman Network.

  2. Ensure you the right permission based on your use case.
    Review the permissions available and confirm you have access to the right permissions in the Developer Portal under the Auth tab for your app.

  3. Validate which LinkedIn Pages a user has access to The /organizationAcls endpoint has the following methods to determine which members have access to which Company Page. Follow the links below for specific examples:

    Note

    Access to a Company Page cannot be granted or updated through the API. Please use the UI tool to grant, update, or remove access.

  4. Review the Tips to Get Started.

  5. Check out the Community Management Use Case Guides to build your solution.

  6. Once you’ve built and tested your application, apply for Standard tier access.

To upgrade to Community Management Standard tier, you will need to complete a Standard tier access form, submit a screen recording of your app, and share test credentials for your app. Learn more on the Community Management App Review page.

Step 4: Get Started with the Lead Sync API

*If you have an existing integration and need to migrate to the new API, check out the migration guide. If you are new to LinkedIn Marketing APIs, refer to the following the steps:

  1. Generate an access token to make authenticated API calls either through Token Generator tool available on the Developer Portal or the LinkedIn Marketing Solutions Workspace on the Postman Network.

  2. Ensure you have the right permission(s) based on your use case. Review the permissions available and confirm you have access to the right permissions in the Developer Portal under the Auth tab for your app.

  3. Validate the member has the right role on the ad account and company page.

  4. Review the Tips to Get Started.

Once you’ve built and tested your application, review the Integration Requirements to become a formally certified partner.

Step 5: Get Started with the Conversions API

  1. Generate an access token to make authenticated API calls either through Token Generator tool available on the Developer Portal or the LinkedIn Marketing Solutions Workspace on the Postman Network.

  2. Ensure you have the right permission(s) based on your use case. Review the permissions available and confirm you have access to the right permissions in the Developer Portal under the Auth tab for your app.

  3. Validate the member has the right role on the ad account. See Account Access Controls for information on how to retrieve a member's ad account roles.

  4. Review the Tips to Get Started.

Step 6: Tools to Manage Your App on the Developer Portal

  • Token generator: generate a new token using the Developer Portal.
  • Token inspector: check the Time to Live (TTL) and status (active/expired) for all tokens
  • API endpoint catalog: get a holistic view of the endpoints and permissions your application has access to
  • App analytics: assess app performance to understand product health, diagnose issues, and stay informed on usage trends in order to better serve your users
  • Webhooks: register your webhook to receive real-time HTTP notifications for subscribed events
  • Add team members: enable your team to manage your app and receive the API newsletter.

Note: The use of the APIs listed in this workspace are restricted to developers approved by LinkedIn. For support or to provide feedback, please submit a developer support ticket.

LinkedIn Compliance Solutions Workspace Overview

LinkedIn provides the following Compliance API Guides for all monitoring, archiving, and management of communications for enterprises in regulated industries. The APIs will help your social interactions remain effective while ensuring compliance with corporate governance policies and major regulations. More documentation on Compliance Solutions API here.

Note: The use of the APIs listed in this workspace are restricted to developers approved by LinkedIn. For support or to provide feedback, please submit a developer support ticket.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment