Versions Compared

Key

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

...

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

getCompanyStatisticsaddComment

The Company Statistics add comment API provides the ability to retrieve statistics 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

Operation details

This section provides details on each of the operations.

...

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

...

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

...

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 followers 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",
"companyId":"162479",
"universalName":"linkedin",
"emailDomains":"apple.com",
"companyAdmin":"true",
"fieldSelectors":"id"
}

Related LinkedIn documentation

...

  • companyId: The unique ID for the suggested company.
  • executeFunction: start - Start following a company.
                                    stop - Stop following a company.
                                    defaut - You can retrieve a collection of suggested companies for the current user.
  • 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 unescaped. 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.

...

Code Block
languagehtml/xml
titlesearchCompanyPage
<linkedin.searchCompanyPage>
	<refineResults>{$ctx:refineResults}</refineResults>
    <keywords>{$ctx:keywords}</keywords>
    <isHqOnly>{$ctx:isHqOnly}</isHqOnly>
    <facet>{$ctx:facet}</facet>
    <facets>{$ctx:facets}</facets>
    <start>{$ctx:start}</start>
    <count>{$ctx:count}</count>
    <sort>{$ctx:sort}</sort>
</linkedin.searchCompanyPage>

Properties

  • 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.

Code Block
languagehtml/xml
titleSample request for searchCompanyPage
{
"accessToken":"AQXpiC74J2e67w7RPX2sgVL3W5F5R1d3TVOwzpII13XHJNlDWjrvbCW0lpiWBR2_H8PYqlN2oQQ0ZkziU_E0HtYjKRFGLleagMKZVwJEx5sFIal_kYakEbd7IFGhm979SxCtvFaP6S3CVXRjqlRIVcTWwz1ePo5nhyeR7S1R2tuyEp76q5I",
"apiUrl":"https://api.linkedin.com",
"refineResults":"facets,companies:(id,website-url)",
"keywords":"mobile",
"isHqOnly":"true",
"facet":"location,us:0,fr:0",
"facets":"network",
"start":"5",
"count":"15",
"sort":"followers"
}

Related LinkedIn documentation

http://developer.linkedin.com/documents/company-search

...

$ctx:sort}</sort>
</linkedin.searchCompanyPage>

Properties

  • 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.

Code Block
languagehtml/xml
titlegetCompanyStatistics
<linkedin.getCompanyStatistics>
	<companyId>{$ctx:companyId}</companyId>
	<fieldSelectors>{$ctx:fieldSelectors}</fieldSelectors>
</linkedin.getCompanyStatistics>

Properties: 

...

Sample request for searchCompanyPage
{
"accessToken":"AQXpiC74J2e67w7RPX2sgVL3W5F5R1d3TVOwzpII13XHJNlDWjrvbCW0lpiWBR2_H8PYqlN2oQQ0ZkziU_E0HtYjKRFGLleagMKZVwJEx5sFIal_kYakEbd7IFGhm979SxCtvFaP6S3CVXRjqlRIVcTWwz1ePo5nhyeR7S1R2tuyEp76q5I",
"apiUrl":"https://api.linkedin.com",
"refineResults":"facets,companies:(id,website-url)",
"keywords":"mobile",
"isHqOnly":"true",
"facet":"location,us:0,fr:0",
"facets":"network",
"start":"5",
"count":"15",
"sort":"followers"
}

Related LinkedIn documentation

http://developer.linkedin.com/documents/company-search

Anchor
checkShare
checkShare
Company checkShare

The Company Statistics API provides the ability to retrieve statistics for a particular company page. These stats can give you insights on both company share and follower metrics. Currently, the numbers provided are not real-time numbers. The analytical breakdown for a company page is provided on a daily basis.

Code Block
titlecheckShare
 <linkedin.checkShare>
  <companyId>{$ctx:companyId}</companyId>
</linkedin.checkShare>

Properties: 

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

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

Code Block
languagehtml/xml
titleSample request for getCompanyStatisticscheckShare
{
"apiUrl":"https://api.linkedin.com",
"accessToken":"AQUDwVyNpxmDdVgdBB0V3yOrdyeEpbaPoZveoYH5jH5p-dIVBRyGZoeU2l0JaHv4LhLa0sOjZgBkS2TCN8V5ilZ3h3pKb_2Nkym2gvSXEWyvg-wqbExzXuLS1s9oMRB_jzmVHSFGDbQCLczvqpi_IwbPSfnKjw4ySISwI5T_W44Q1cWQ2eY",
"companyId":"32873",
"fieldSelectors":"id"
}
Related LinkedIn documentation

httphttps://developer.linkedin.com/documentsdocs/company-statisticspages#sharing_enabled

Anchor
sample
sample

Sample configuration

...