Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
maxLevel3
typeflat

Overview

The following operations allow you to work with Companies. Click an operation name to see details on how to use it.

For a sample proxy service the illustrates how to work with companies, see Sample configuration. 

Operation

Description

companyLookup

The Company Profile API retrieves and displays one or more company profiles based on the company ID or universal name. Also, it returns basic company profile data such as name, Web site, and industry, and handles additional company content such as RSS stream and Twitter feed

followCompanyPage

Members can follow companies to receive updates for company activities such as new job postings, employment changes and new products

addComment

The Company add comment API provides the ability to add comment for a particular company page

searchCompanyPage

Use the Company Search API to find companies using keywords, industry, or location. It returns a collection of matching companies

checkShareCheck the member has admin privileges or not.
getAdditionalProfileInfoThe Company Statistics API provides the ability to retrieve profile details for a particular company page
getcommentsForSpecificUpdateThe Company Statistics API provides the ability to retrieve comments for a particular company page
getCompanyProfileThe Company Profile API Retrieves and displays one or more company profiles
getCompanySpecificUpdateThe Company Statistics API provides the ability to retrieve specific updates for a particular company page
getCompanyUpdateThe Company Statistics API provides the ability to retrieve updates for a particular company page
getfollowersThe Company Statistics API provides the ability to retrieve no of followers for a particular company page
getHistoricalFollowersThe Company Statistics API provides the ability to retrieve historical followers for a particular company page
gethistoricalStatusUpdateThe Company Statistics API provides the ability to retrieve historical status update for a particular company page
getLikesForCompanyUpdateThe Company Statistics API provides the ability to retrieve likes for status update a particular company page
listCompanyByMemberThe Company Profile API Retrieves and displays members of company profiles
searchCompanyPageThe Company Search API enables search across company pages

Operation details

This section provides details on each of the operations.

...

The Company Profile API retrieves and displays one or more company profiles based on the company ID or universal name. Also, it returns basic company profile data such as name, Web site, and industry, and handles additional company content such as RSS stream and Twitter feed.

Code Block
languagehtml/xml
titlecompanyLookUp
<linkedin.companyLookup>
	<companyId>{$ctx:companyId}</companyId>
    <universalName>{$ctx:universalName}</universalName>
    <emailDomains>{$ctx:emailDomains}</emailDomains>
    <companyAdmin>{$ctx:companyAdmin}</companyAdmin>
    <fieldSelectors>{$ctx:fieldSelectors}</fieldSelectors>
</linkedin.companyLookup>

Properties

  • companyId: The unique internal numeric company identifier.
  • universalName: Required - The unique string identifier for a company.  
  • emailDomains: Company email domains.
  • companyAdmin: Lists all the companies that the authenticated user is an administrator of.
  • fieldSelectors: Field selectors are specified after the resource identifiers and path components of a resource, prefixed by a colon, contained within parentheses, and separated by commas. Fields will be returned in the order specified. When URL-encoding your resource URLs, ensure that the parentheses used in selectors remain un-escaped. Remember, each field you select adds computation time to your API request. It's best to be very specific as to what fields you want returned in each API call you make.
Note: Based on the parameters getting passed, the end URL must get changed. The below table describes how the end point changes with the parameter combination changes.

1 = considered parameter    0 = not considered parameter

...

Table of Contents
maxLevel3
typeflat

...

Overview

The following operations allow you to work with Companies. Click an operation name to see details on how to use it.

For a sample proxy service the illustrates how to work with companies, see Sample configuration. 

Operation

Description

companyLookup

The Company Profile API retrieves and displays one or more company profiles based on the company ID or universal name. Also, it returns basic company profile data such as name, Web site, and industry, and handles additional company content such as RSS stream and Twitter feed

checkAdminMember

check the member is an Admin or not in the company profiles.

addComment

The Company add comment API provides the ability to add comment for a particular company page

searchCompanyPage

Use the Company Search API to find companies using keywords, industry, or location. It returns a collection of matching companies

checkShareCheck the member has admin privileges or not.
getAdditionalProfileInfoThe Company Statistics API provides the ability to retrieve profile details for a particular company page
getcommentsForSpecificUpdateThe Company Statistics API provides the ability to retrieve comments for a particular company page
getCompanyProfileThe Company Profile API Retrieves and displays one or more company profiles
getCompanySpecificUpdateThe Company Statistics API provides the ability to retrieve specific updates for a particular company page
getCompanyUpdateThe Company Statistics API provides the ability to retrieve updates for a particular company page
getfollowersThe Company Statistics API provides the ability to retrieve no of followers for a particular company page
getHistoricalFollowersThe Company Statistics API provides the ability to retrieve historical followers for a particular company page
getHistoricalStatusUpdateThe Company Statistics API provides the ability to retrieve historical status update for a particular company page
getLikesForCompanyUpdateThe Company Statistics API provides the ability to retrieve likes for status update a particular company page
listCompanyByMemberThe Company Profile API Retrieves and displays members of company profiles
searchCompanyPageThe Company Search API enables search across company pages

Operation details

This section provides details on each of the operations.

Anchor
companyLookup
companyLookup
Company lookup API and fields

The Company Profile API retrieves and displays one or more company profiles based on the company ID or universal name. Also, it returns basic company profile data such as name, Web site, and industry, and handles additional company content such as RSS stream and Twitter feed.

Code Block
languagehtml/xml
titlecompanyLookUp
<linkedin.companyLookup>
	<companyId>{$ctx:companyId}</companyId>
    <universalName>{$ctx:universalName}</universalName>
    <emailDomains>{$ctx:emailDomains}</emailDomains>
    <companyAdmin>{$ctx:companyAdmin}</companyAdmin>
    <fieldSelectors>{$ctx:fieldSelectors}</fieldSelectors>
</linkedin.companyLookup>

Properties

  • companyId: The unique internal numeric company identifier.
  • universalName: Required - The unique string identifier for a company.  
  • emailDomains: Company email domains.
  • companyAdmin: Lists all the companies that the authenticated user is an administrator of.
  • fieldSelectors: Field selectors are specified after the resource identifiers and path components of a resource, prefixed by a colon, contained within parentheses, and separated by commas. Fields will be returned in the order specified. When URL-encoding your resource URLs, ensure that the parentheses used in selectors remain un-escaped. Remember, each field you select adds computation time to your API request. It's best to be very specific as to what fields you want returned in each API call you make.
Note: Based on the parameters getting passed, the end URL must get changed. The below table describes how the end point changes with the parameter combination changes.

1 = considered parameter    0 = not considered parameter

Anchor
request
request
Sample request

Following is a sample REST request that can be handled by the companyLookup operation.

Code Block
languagehtml/xml
titleSample request for companyLookup
{
"accessToken":"AQUTf-7ouUMipARXfNVowT6ikytQsmVdf3VIo648_iksSI4uBeAv5aqlmpoL0_m4nZ3bG8nyK7wqZRyJKqLTsOAHLDnGpqGf0tFb8F4pSy_dtbJoaFGuIdoD8PjipKpyIorZXgR1wjpyynowzEJ9YX9Poj6AXbRWTRsnKpRNZzwEQB4YAv8",
"apiUrl":"https://api.linkedin.com
/v1/companies/162479 1100http://api
",
"companyId":"162479",
"universalName":"linkedin",
"emailDomains":"apple.com",
"companyAdmin":"true",
"fieldSelectors":"id"
}

Related LinkedIn documentation

https://developer.linkedin.com/

v1/companies::(162479,universal-name=linkedin)1010http://api.linkedin.com/v1/companies/162479 1001http://api.linkedin.com/v1/companies/162479 0110http://api.linkedin.com/v1/companies/universal-name=linkedin0101http://api.linkedin.com/v1/companies/universal-name=linkedin0011http

docs/company-pages

Anchor
checkAdminMember
checkAdminMember
Check Member Type. 

This page require the member to be an administrator of the target company, checkAdmiMember call returns the currently authenticated user is  administrator or not.

Code Block
titlecheckAdminMember
<linkedin.checkAdminMember>
    <companyId>{$ctx:companyId}</companyId>
</linkedin.checkAdminMember>

Properties

  • companyId: The unique internal numeric company identifier.

Sample request 

Following is a sample REST request that can be handled by the checkAdminMember operation.

Code Block
titleSample request for checkAdminMember
{
"apiUrl":"https://api.linkedin.com
/v1/companies?email-domain=apple.com0111http://api
",
"accessToken":"AQUDwVyNpxmDdVgdBB0V3yOrdyeEpbaPoZveoYH5jH5p-dIVBRyGZoeU2l0JaHv4LhLa0sOjZgBkS2TCN8V5ilZ3h3pKb_2Nkym2gvSXEWyvg-wqbExzXuLS1s9oMRB_jzmVHSFGDbQCLczvqpi_IwbPSfnKjw4ySISwI5T_W44Q1cWQ2eY",
"companyId":"32873"
}

Related LinkedIn documentation

https://developer.linkedin.com/

v1

docs/

companies/universal-name=linkedin1011http://api.linkedin.com/v1/companies/162479 1101http://api.linkedin.com/v1/companies::(162479,universal-name=linkedin)1110http://api.linkedin.com/v1/companies::(162479,universal-name=linkedin)1111http://api.linkedin.com/v1/companies::(162479,universal-name=linkedin) AnchorrequestrequestSample request

company-pages#is_admin

Add a comment on Company page.

AddComment method allows to submit a comment on a company update. 

Code Block
titleaddComment
<linkedin.addComment>
    <companyId>{$ctx:companyId}</companyId>
    <updateKey>{$ctx:updateKey}</updateKey>
    <comment>{$ctx:comment}</comment>
</linkedin.addComment>

Properties

  • companyId: The unique internal numeric company identifier.

Sample request 

Following is a sample REST request that can be handled by

...

the addComment operation.

Code Block

...

titleSample request for

...

addComment
{

...


"apiUrl":"https://api.linkedin.com",
"

...

accessToken":"

...

AQUDwVyNpxmDdVgdBB0V3yOrdyeEpbaPoZveoYH5jH5p-dIVBRyGZoeU2l0JaHv4LhLa0sOjZgBkS2TCN8V5ilZ3h3pKb_2Nkym2gvSXEWyvg-wqbExzXuLS1s9oMRB_jzmVHSFGDbQCLczvqpi_IwbPSfnKjw4ySISwI5T_W44Q1cWQ2eY",
"

...

companyId":"

...

2414183",
"

...

updateKey":"

...

PDATE-c2414183-6029016796592427008",
"

...

comment":"

...

test"

...


...

}

...

Related

...

LinkedIn documentation

https://developer.linkedin.com/docs/company-

...

pages#company_comment

Anchor
searchCompanyPage
searchCompanyPage

Company search

Use the Company Search API to find companies using keywords, industry, or location. It returns a collection of matching companies. Each entry can contain much of the information available on the company page.

...

  • refineResults: Comma separated values refine the results that need to be retrieved from the API. For example, the above method would return the facets, ID and Web site URL of the company.
  • keywords: Companies that have all the keywords anywhere in their listing. Multiple words should be separated by a space. (Don't forget to URL encode this data.)
  • isHqOnly: Matching companies by the location of the headquarters. When this is set to "true" and a location facet is used, this restricts returned companies to only those whose headquarters resides in the specified location.
  • facet: Facet values to search over.
  • facets: Facet buckets to return.
  • start: Start location within the result set for paginated returns. This is the zero-based ordinal number of the search return, not the number of the page. To see the second page of 10 results per page, specify 10, not 1. Ranges are specified with a starting index and a number of results (count) to return. The default value is 0.
  • count: The number of jobs to return. Values can range between 0 and 110. The default value is 10. The total number of results available to any user depends on the user's account level.
  • sort: Controls the search result order. Options would be relevance or relationship.

 

Sample request

Following is a sample REST request that can be handled by the searchCompanyPage operation.

...

  • companyId: Required - The unique ID for the suggested company.
Sample request

Following is a sample REST request that can be handled by the checkShare operation.

...

  • companyId: Required - The unique ID for the suggested company.

  • properties: specify the needed fields(id,name,description).

Sample request

Following is a sample REST request that can be handled by the getAdditionalProfileInfo operation.

...

  • companyId: Required - The unique ID for the suggested company.

  • updateKey: The unique identifier for company update.

Sample request

Following is a sample REST request that can be handled by the getAdditionalProfileInfo operation.

...

https://developer.linkedin.com/docs/company-pages#get_update_comments

 

 

Anchor
getCompanyUpdate
getCompanyUpdate
Update the company profile.

...

  • companyId: Required - The unique ID for the suggested company.

  • count: Maximum number of updates to return.

  • start: The offset value for paginating update results.

Sample request

Following is a sample REST request that can be handled by the getCompanySpecificUpdate operation.

...

  • companyId: Required - The unique ID for the suggested company.

  • updateKey: The unique identifier for company update.

Sample request

Following is a sample REST request that can be handled by the getCompanySpecificUpdate operation.

...

  • companyId: Required - The unique ID for the suggested company.

  • geos : Segment by a particular geographic area.

  • jobFunc : Segment by a particular company size targeting code.

  • industries : Segment by member industry.

  • seniorities: Segment by member seniority level targeting code.

  • companySizes : Segment by a particular geographic area.

Sample request

Following is a sample REST request that can be handled by the getfollowers operation.

...

  • companyId: Required - The unique ID for the suggested company.

  • timeGranularity: Granularity of statistics eg values:day,month.

  • startTimestamp: Starting timestamp of when the stats search should begin (milliseconds since epoch).

  • endTimestamp: Ending timestamp of when the stats search should end (milliseconds since epoch).

Sample request

Following is a sample REST request that can be handled by the getHistoricalFollowers operation.

...

  • companyId: Required - The unique ID for the suggested company.

  • udateKeyupdateKey: The unique identifier for company update.

...