nv.openCompanyPage
This action allows you to open a company page in Sales Navigator to retrieve its basic information and perform additional company-related actions if needed.
In the Node SDK this is linkedapi.nvFetchCompany – the call is below, under Parameters.
In the Python SDK this is linkedapi.nv_fetch_company – the call is below, under Parameters.
In the CLI this is linkedin navigator company fetch – the command is below, under Parameters.
Constraints
⏺️ Root Start: allowed, when
companyHashedUrlparameter is provided.
⬆️ Parent Actions: st.openCompanyPage, nv.doForCompanies.
⬇️ Child Actions: nv.saveAccount, nv.unsaveAccount, nv.removeAccountFromList, nv.retrieveCompanyEmployees, nv.retrieveCompanyDMs, st.openCompanyPage.
Parameters
{
"actionType": "nv.openCompanyPage",
"label": "company1",
"companyHashedUrl": "https://www.linkedin.com/company/12345678",
"basicInfo": true,
"then": { ... }
}In AI assistants, the MCP server runs this action as the nv_fetch_company tool.
In the SDK this is the nvFetchCompany method. It always returns basic information: basicInfo, like label and then, exists only in workflow JSON. It takes the other parameters below and returns the result below in data.
Each retrieve… flag of nvFetchCompany adds one child action, and its data comes back under its own property of data:
| Flag | Child action | Configuration | Property of data |
|---|---|---|---|
retrieveEmployees | nv.retrieveCompanyEmployees | employeesRetrievalConfig: limit, filter | employees |
retrieveDMs | nv.retrieveCompanyDMs | dmsRetrievalConfig: limit | dms |
A configuration object takes effect only with its flag set to true, and takes the parameters of its child action – their defaults, limits and the employee filter fields are on the child's page. For example, up to 100 employees:
const workflow = await linkedapi.nvFetchCompany.execute({
companyHashedUrl: "https://www.linkedin.com/company/12345678",
retrieveEmployees: true,
employeesRetrievalConfig: { limit: 100 }
});from linkedapi import NvFetchCompanyParams
workflow = linkedapi.nv_fetch_company.execute(
NvFetchCompanyParams(
company_hashed_url="https://www.linkedin.com/company/12345678",
retrieve_employees=True,
employees_retrieval_config={"limit": 100},
)
)When a child action fails, its error comes back in errors and the rest of data is still returned.
In the CLI this is linkedin navigator company fetch:
linkedin navigator company fetch <hashed-url> [flags]| Flag | Type | Description |
|---|---|---|
--employees | boolean | Include employee data |
--dms | boolean | Include decision makers |
--employees-limit | integer | Max employees to retrieve |
--employees-first-name | string | Filter employees by first name |
--employees-last-name | string | Filter employees by last name |
--employees-positions | string | Filter employees by positions, comma-separated |
--employees-locations | string | Filter employees by locations, comma-separated |
--employees-industries | string | Filter employees by industries, comma-separated |
--employees-schools | string | Filter employees by schools, comma-separated |
--employees-years-of-experience | string | Filter employees by experience ranges, comma-separated |
--employees-connection-degrees | string | Filter employees by connection degrees (1st, 2nd, 3rd+, groupMembers), comma-separated |
--dms-limit | integer | Max decision makers to retrieve |
label(optional) – custom label for tracking this action in workflow completion.companyHashedUrl(required for root start, forbidden for parent start) – LinkedIn URL of the company: a hashed URL with the numeric company ID, a Sales Navigator company URL or a public company URL (see Accepted URLs).basicInfo(optional, default:false) – when set totrue, the action includes basic company information in the results.then(optional) – object or array of child actions to be executed within this action.
Accepted URLs
companyHashedUrl takes any of these forms:
- a hashed LinkedIn URL with the numeric company ID (
linkedin.com/company/12345678), such ashashedUrlfromnv.searchCompaniesornv.retrieveListAccounts; - a Sales Navigator company URL (
linkedin.com/sales/company/…), such as an alert'ssubject.urlfromnv.retrieveAlerts; - a public company URL (
linkedin.com/company/<vanity>). It costs one extra standard page load: Linked API opens the company's LinkedIn page first and goes to its Sales Navigator page from there.
Child actions act on the page this action opened and do not open a public URL again. A public URL that leads to no LinkedIn company page returns companyNotFound.
The same forms are accepted by nv.saveAccount, nv.unsaveAccount and nv.removeAccountFromList when they run as root actions.
Result options
- Successful page opening with
basicInfoset totrue:
{
"actionType": "nv.openCompanyPage",
"label": "company1",
"success": true,
"data": {
"name": "TechCorp",
"urn": "urn:li:organization:12345678",
"publicUrl": "https://www.linkedin.com/company/company1",
"description": "TechCorp is a leading provider of innovative technology solutions for businesses worldwide.",
"location": "Cupertino, California",
"headquarters": "US",
"industry": "IT Services and IT Consulting",
"website": "https://techcorp.com",
"employeesCount": 500,
"yearFounded": 2019,
"logoUrl": "https://media.licdn.com/dms/image/v2/C4D0BAQE/company-logo_200_200/0/1700000000000",
"then": { ... }
}
}label– included only if specified in the action parameters.data– basic information about the company and results of child actions execution.name– name of the company.urn– URN of the company, ornullif LinkedIn does not expose it.publicUrl– public LinkedIn URL of the company.description– description of the company.location– free-form string representing the company headquarters location.headquarters– two-character country code (e.g., "US", "UK") representing headquarters location.industry– enum representing the company industry. Takes specific values available in the LinkedIn interface.logoUrl– URL of the company's logo, ornullif the company has no logo.
- Successful page opening with
basicInfoset tofalse:
{
"actionType": "nv.openCompanyPage",
"label": "company1",
"success": true,
"data": {
"then": { ... }
}
}label– included only if specified in the action parameters.data.then– results of child actions execution.
- Failed page opening:
{
"actionType": "nv.openCompanyPage",
"label": "company1",
"success": false,
"error": {
"type": "companyNotFound",
"message": "The provided URL is not an existing LinkedIn company."
}
}label– included only if specified in the action parameters.error.type– enum with the following possible values:noSalesNavigator– your account does not have Sales Navigator subscription.companyNotFound– provided URL is not an existing LinkedIn company, including a public company URL that leads to no LinkedIn company page.