Docs / Search

get_company

Read one company page.

This action only reads. It changes nothing, so it is safe to try.

What you give it

InputWhat it isWhere to get it
company
needed
A company link or a company id. The company: its LinkedIn page URL, its name as it appears in that URL, or its numeric id.Open the company's page on LinkedIn and copy the address from your browser. It looks like https://www.linkedin.com/company/their-name
Or run search_linkedin_companies and use results[].profileUrl from its answer.
7 more places to get it
connectionId
optional
A connection id. Which of your LinkedIn accounts to act from (its id from list_linkedin_accounts). Omit to use your first live one.Run list_linkedin_accounts and use accounts[].id from its answer.
15 more places to get it

Call it

curl -X POST https://api.heyreagent.com/v1/actions/get_company \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "content-type: application/json" \
  -d '{"company":"PASTE_COMPANY_LINK_HERE"}'
The same call in JavaScript
const response = await fetch("https://api.heyreagent.com/v1/actions/get_company", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_KEY",
    "content-type": "application/json",
  },
  body: JSON.stringify({
    "company": "PASTE_COMPANY_LINK_HERE"
  }),
});
const answer = await response.json();
console.log(answer);
The same call in Python
import requests

response = requests.post(
    "https://api.heyreagent.com/v1/actions/get_company",
    headers={"Authorization": "Bearer YOUR_KEY"},
    json={
        "company": "PASTE_COMPANY_LINK_HERE",
    },
)
print(response.json())
The same call in n8n

Add an HTTP Request node and fill it in like this:

MethodPOST
URLhttps://api.heyreagent.com/v1/actions/get_company
Send HeadersOn. Name Authorization, Value Bearer YOUR_KEY
Send BodyOn. Body Content Type JSON, Specify Body Using JSON, then paste the body below
{
  "company": "PASTE_COMPANY_LINK_HERE"
}

Put your own key where it says YOUR_KEY. Put your own value where it says PASTE_…_HERE: the table above says where each one comes from. New here? Start with your first call.

What you get back

When it worked, the answer is { "ok": true, "result": { … } }. Inside result:

idA company id. Other actions take it.
namestring
descriptionstring
entityUrnstring
publicIdentifierstring
profileUrlA company link. Other actions take it.
taglinestring
followersCountnumber
isFollowingboolean
isEmployeeboolean
hashtags[].titlestring
messaging.isEnabledboolean
messaging.idA company messaging id. Other actions take it.
messaging.entityUrnstring
claimedboolean
viewerPermissions.canMembersInviteToFollowboolean
viewerPermissions.canReadContentSuggestionsboolean
viewerPermissions.canReadMessagesboolean
viewerPermissions.canUpdateOrganizationProfileboolean
viewerPermissions.canCreateOrganicShareboolean
viewerPermissions.canReadAdminDashboardboolean
viewerPermissions.canReadOrganizationActivityboolean
viewerPermissions.canEditCuratorsboolean
viewerPermissions.canManageOrganizationalPageFollowboolean
viewerPermissions.canReadOrganizationFollowerAnalyticsboolean
viewerPermissions.canInviteMemberToFollowboolean
viewerPermissions.canReadOrganizationLeadsAnalyticsboolean
viewerPermissions.canEditPendingAdministratorsboolean
viewerPermissions.canManageMessagingAccessboolean
viewerPermissions.canSeeEmployeeExperienceAsMemberboolean
viewerPermissions.canEmployeesInviteToFollowboolean
viewerPermissions.canSeeOrganizationAdministrativePageboolean
viewerPermissions.canManageAdminRolesboolean
viewerPermissions.canEditOrganizationDetailsboolean
viewerPermissions.canApproveContentboolean
viewerPermissions.canViewTeamPerformanceboolean
viewerPermissions.canManageOrganizationSettingsboolean
viewerPermissions.canAccessAdvancedAnalyticsboolean
viewerPermissions.canModerateCommentsboolean
viewerPermissions.canCreateAdsboolean
viewerPermissions.canManageAdBudgetsboolean
viewerPermissions.canEditPageThemeboolean
viewerPermissions.canPublishNewslettersboolean
viewerPermissions.canEditCustomTabsboolean
viewerPermissions.canManageIntegrationsboolean
viewerPermissions.canAssignRolesboolean
viewerPermissions.canApprovePendingMembersboolean
viewerPermissions.canEditCareerPageSettingsboolean
viewerPermissions.canViewBillingInformationboolean
organizationTypePUBLIC_COMPANY | EDUCATIONAL | SELF_EMPLOYED | GOVERNMENT_AGENCY | NON_PROFIT | SELF_OWNED | PRIVATELY_HELD | PARTNERSHIP or null
locations[].isHeadquarterboolean
locations[].countrystring
locations[].citystring
locations[].postalCodestring
locations[].streetstring[]
locations[].descriptionstring
locations[].areastring
logostring
industrystring[]
activitiesstring[]
employeeCountnumber
employeeCountRange.fromnumber
employeeCountRange.tonumber
websitestring
foundationDatestring
phonestring
acquiredBy.idstring
acquiredBy.namestring
acquiredBy.publicIdentifierstring
acquiredBy.profileUrlstring
crunchbaseFunding.lastUpdatedAtstring
crunchbaseFunding.companyUrlstring

A field that does not apply to an answer is left out, or is null. There are 17 more fields nested inside these.

When it did not work, the answer is { "ok": false, "error": "…", "message": "…" }. What each error means.

Good to know

In Claude or ChatGPT

Once connected, ask in your own words. The assistant sees this action as a tool with the same name, get_company, and the same inputs.