Versions Compared

Key

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

...

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.

...

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

https://developer.linkedin.com/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",
"accessToken":"AQUDwVyNpxmDdVgdBB0V3yOrdyeEpbaPoZveoYH5jH5p-dIVBRyGZoeU2l0JaHv4LhLa0sOjZgBkS2TCN8V5ilZ3h3pKb_2Nkym2gvSXEWyvg-wqbExzXuLS1s9oMRB_jzmVHSFGDbQCLczvqpi_IwbPSfnKjw4ySISwI5T_W44Q1cWQ2eY",
"companyId":"32873"
}

Related LinkedIn documentation

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

Anchor
addComment
addComment
Add a comment on Company page.

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

...

  • companyId: The unique internal numeric company identifier.

  • updateKey: The unique identifier for company update.

  • comment: The status for company. 
Sample request 

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

...

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

...

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

Code Block
titleSample request for getAdditionalProfileInfogetcommentsForSpecificUpdate
{
"apiUrl":"https://api.linkedin.com",
"accessToken":"AQUDwVyNpxmDdVgdBB0V3yOrdyeEpbaPoZveoYH5jH5p-dIVBRyGZoeU2l0JaHv4LhLa0sOjZgBkS2TCN8V5ilZ3h3pKb_2Nkym2gvSXEWyvg-wqbExzXuLS1s9oMRB_jzmVHSFGDbQCLczvqpi_IwbPSfnKjw4ySISwI5T_W44Q1cWQ2eY",
"companyId":"32873",
"updateKey":"PDATE-c2414183-60290167965427008"
}

...

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

 

 

Anchor

...

getCompanyProfile

...

getCompanyProfile
Retrieve Company profile.

The Company Statistics API provides the ability to retrieve statistics for a particular company page.This call will return a single specific company update record for profile information about the company identified specified by the { id } value and the update identified by the {update-key} value in the request.

Code Block
titlegetCompanyUpdategetAdditionalProfileInfo
 <linkedin.getCompanyUpdate>getCompanyProfile>
    <companyId>{$ctx:companyId}</companyId>
    <eventType>{$ctx:eventType}</eventType>
   
<start>{$ctx:start}</start>
    <count>{$ctx:count}</count>
</linkedin.getCompanyUpdate>getCompanyProfile>

Properties

  • 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

...

Sample request

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

Code Block
titleSample request for getCompanyUpdategetCompanyProfile
{
"apiUrl":"https://api.linkedin.com",
"accessToken":"AQUDwVyNpxmDdVgdBB0V3yOrdyeEpbaPoZveoYH5jH5p-dIVBRyGZoeU2l0JaHv4LhLa0sOjZgBkS2TCN8V5ilZ3h3pKb_2Nkym2gvSXEWyvg-wqbExzXuLS1s9oMRB_jzmVHSFGDbQCLczvqpi_IwbPSfnKjw4ySISwI5T_W44Q1cWQ2eY",
"companyId":"32873",
"count":"2",
"start":"1"
}
Related LinkedIn documentation

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

Anchor
getCompanySpecificUpdate
getCompanySpecificUpdate
update the profile with specific fields

...

Related LinkedIn documentation

https://developer.linkedin.com/docs/company-pages#getpages#company_update updates

Anchor

...

getCompanyUpdate

...

getCompanyUpdate

...

Get A company's

...

update

The Company Statistics API provides the ability to retrieve statistics for a particular company page. This request allows you to get a follower-count for a specific segment to ensure you are at or over the minimum requirement for the target segment for the company specified by the {id} value in the requestGetCompanyUpdate method returns a list of update events from the from the LinkedIn company page of the company.

Code Block
titlegetfollowersgetCompanyUpdate
 <linkedin.getfollowers>getCompanyUpdate>
    <companyId>{$ctx:companyId}</companyId>
    <geos><eventType>{$ctx:eventType}</eventType>
    <start>{$ctx:start}</geos>start>
    <count>{$ctx:count}</count>
 </linkedin.getCompanyUpdate>

Properties

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

  • eventType: Filter the results to only return updates of the specified event type(optional).

  • start: The offset value for paginating update results by(optional).

  • count: Maximum number of updates to return(optional).

Sample request

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

Code Block
titleSample request for getCompanyUpdate
{
"apiUrl":"https://api.linkedin.com",
"accessToken":"AQUDwVyNpxmDdVgdBB0V3yOrdyeEpbaPoZveoYH5jH5p-dIVBRyGZoeU2l0JaHv4LhLa0sOjZgBkS2TCN8V5ilZ3h3pKb_2Nkym2gvSXEWyvg-wqbExzXuLS1s9oMRB_jzmVHSFGDbQCLczvqpi_IwbPSfnKjw4ySISwI5T_W44Q1cWQ2eY",
"companyId":"32873",
"count":"2",
"start":"1",
"eventType":""
}
Related LinkedIn documentation

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

Anchor
getfollowers
getfollowers
  Retrieve company's followers information

The Company Statistics API provides the ability to retrieve statistics for a particular company page.This request allows you to get a follower-count for a specific segment to ensure you are at or over the minimum requirement for the target segment for the company specified by the {id} value in the request.

Code Block
titlegetfollowers
 <linkedin.getfollowers>
    <companyId>{$ctx:companyId}</companyId>
    <geos>{$ctx:eventType}</geos>
    <jobFunc>{$ctx:jobFunc}</jobFunc>{$ctx:jobFunc}</jobFunc>
    <industries>{$ctx:industries}</industries>
    <seniorities>{$ctx:seniorities}</seniorities>
    <companySizes>{$ctx:companySizes}</companySizes>
</linkedin.getfollowers>

Properties: 

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

Code Block
titleSample request for getfollowers
{
"apiUrl":"https://api.linkedin.com",
"accessToken":"AQUDwVyNpxmDdVgdBB0V3yOrdyeEpbaPoZveoYH5jH5p-dIVBRyGZoeU2l0JaHv4LhLa0sOjZgBkS2TCN8V5ilZ3h3pKb_2Nkym2gvSXEWyvg-wqbExzXuLS1s9oMRB_jzmVHSFGDbQCLczvqpi_IwbPSfnKjw4ySISwI5T_W44Q1cWQ2eY",
"companyId":"32873",
"geos":"af"
}
Related LinkedIn documentation

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

Anchor
sample
sample

Anchor
getHistoricalFollowers
getHistoricalFollowers
 Retrieve historical followers information

This call retrieves statistics about followers for a particular company page identified by the {id} value in the request.

Code Block
titlegetHistoricalFollowers
 <linkedin.getHistoricalFollowers>
    <companyId>{$ctx:companyId}</companyId>
    <industries><timeGranularity>{$ctx:industriestimeGranularity}</industries>timeGranularity>
    <seniorities><startTimestamp>{$ctx:senioritiesstartTimestamp}</seniorities>startTimestamp>
    <companySizes><endTimestamp>{$ctx:companySizesendTimestamp}</companySizes>endTimestamp>
</linkedin.getfollowers>getHistoricalFollowers>

Properties: 

  • 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 areatimeGranularity: 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 getfollowers operationthe getHistoricalFollowers operation.

Code Block
titleSample request for getfollowersgetHistoricalFollowers
{
"apiUrl":"https://api.linkedin.com",
"accessToken":"AQUDwVyNpxmDdVgdBB0V3yOrdyeEpbaPoZveoYH5jH5p-dIVBRyGZoeU2l0JaHv4LhLa0sOjZgBkS2TCN8V5ilZ3h3pKb_2Nkym2gvSXEWyvg-wqbExzXuLS1s9oMRB_jzmVHSFGDbQCLczvqpi_IwbPSfnKjw4ySISwI5T_W44Q1cWQ2eY",
"companyId":"32873",
"timeGranularity": "day",
"geosstartTimestamp": "af421797310000"
}
Related LinkedIn documentation

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

Anchor

...

getHistoricalStatusUpdate

...

getHistoricalStatusUpdate
 Retrieve historical status update details.

The Historical Status Update Statistics API provides impression and engagement data on company shares for a given company page.

Code Block
titlegetHistoricalFollowersgetLikesForCompanyUpdate
 <linkedin.getHistoricalFollowers>gethistoricalStatusUpdate>
    <companyId>{$ctx:companyId}</companyId>
    <updateKey>{$ctx:updateKey}</updateKey>
    <timeGranularity>{$ctx:timeGranularity}</timeGranularity>
    <startTimestamp>{$ctx:startTimestamp}</startTimestamp>
    <endTimestamp>{$ctx:endTimestamp}</endTimestamp>
</linkedin.getHistoricalFollowers>gethistoricalStatusUpdate>

Properties: 

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

  • udateKey: The unique identifier for company update.

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

  • timeGranularity: Granularity of statistics eg values: 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).

...

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

Code Block
titleSample request for getHistoricalFollowersgethistoricalStatusUpdate
{
"apiUrl":"https://api.linkedin.com",
"accessToken":"AQUDwVyNpxmDdVgdBB0V3yOrdyeEpbaPoZveoYH5jH5p-dIVBRyGZoeU2l0JaHv4LhLa0sOjZgBkS2TCN8V5ilZ3h3pKb_2Nkym2gvSXEWyvg-wqbExzXuLS1s9oMRB_jzmVHSFGDbQCLczvqpi_IwbPSfnKjw4ySISwI5T_W44Q1cWQ2eY",
"companyId":"32873",
"timeGranularityupdateKey": "day",
"startTimestamp": "421797310000"
"UPDATE-c2414183-6029016867488677888" 
}
Related LinkedIn documentation

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

Anchor
getLikesForCompanyUpdate
getLikesForCompanyUpdate

...

Retrieve likes for company upadates.

The Historical Status Update Statistics API provides impression and engagement data on company shares for a given company page.

Code Block
titlegetLikesForCompanyUpdate
 <linkedin.gethistoricalStatusUpdate>getLikesForCompanyUpdate>
    <companyId>{$ctx:companyId}</companyId>
    <updateKey>{$ctx:updateKey}</updateKey>
    <timeGranularity>{$ctx:timeGranularity}</timeGranularity>
    <startTimestamp>{$ctx:startTimestamp}</startTimestamp>
 
  <endTimestamp>{$ctx:endTimestamp}</endTimestamp>
</linkedin.gethistoricalStatusUpdate>

Properties: 

...

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

...

getLikesForCompanyUpdate>

Properties: 

  • 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)updateKey: The unique identifier for company update.

Following is a sample REST request that can be handled by the gethistoricalStatusUpdate operationthe getLikesForCompanyUpdate operation.

Code Block
titleSample request for gethistoricalStatusUpdategetLikesForCompanyUpdate
{
"apiUrl":"https://api.linkedin.com",
"accessToken":"AQUDwVyNpxmDdVgdBB0V3yOrdyeEpbaPoZveoYH5jH5p-dIVBRyGZoeU2l0JaHv4LhLa0sOjZgBkS2TCN8V5ilZ3h3pKb_2Nkym2gvSXEWyvg-wqbExzXuLS1s9oMRB_jzmVHSFGDbQCLczvqpi_IwbPSfnKjw4ySISwI5T_W44Q1cWQ2eY",
"companyId":"32873",
"updateKey":"UPDATE-c2414183-6029016867488677888" 
}
Related LinkedIn documentation

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

...

pages#get_update_likes

Anchor
listCompanyByMember
listCompanyByMember
List all members in a company.

The Historical Status Update Statistics API provides impression and engagement data on company shares for a given company page.

Code Block
titlegetLikesForCompanyUpdatelistCompanyByMember
 <linkedin.getLikesForCompanyUpdate>listCompanyByMember>
    <companyId><count>{$ctx:companyIdcount}</companyId>count>
    <updateKey><start>{$ctx:updateKeystart}</updateKey>start>
</linkedin.getLikesForCompanyUpdate>listCompanyByMember>

Properties: 

  • companyIdstart: Required - The unique ID for the suggested company.updateKey: The unique identifier for company updateoffset value for paginating update results by(optional).
  • count: Maximum number of updates to return(optional).

Following is a sample REST request that can be handled by the getLikesForCompanyUpdate operationthe listCompanyByMember operation.

Code Block
titleSample request for getLikesForCompanyUpdatelistCompanyByMember
{
"apiUrl":"https://api.linkedin.com",
"accessToken":"AQUDwVyNpxmDdVgdBB0V3yOrdyeEpbaPoZveoYH5jH5p-dIVBRyGZoeU2l0JaHv4LhLa0sOjZgBkS2TCN8V5ilZ3h3pKb_2Nkym2gvSXEWyvg-wqbExzXuLS1s9oMRB_jzmVHSFGDbQCLczvqpi_IwbPSfnKjw4ySISwI5T_W44Q1cWQ2eY",
  "companyIdstart":"328731",
  "updateKeycount":"UPDATE-c2414183-60290168674886778880"
}
}
Related LinkedIn documentation

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

Anchor
sample
sample

Sample configuration

...