Skip to content
Docs

Retrieve a company page

GETdirect.lempile.com/api/v1/linkedin/company/{identifier}

A company page by its public identifier, id, urn or link (one LinkedIn call). Its employees: POST /linkedin/search with category: people and company: [id].

Authentication

X-API-KEY header·A Lempile Direct key, one per workspace, made in Lempile's dashboard.

Path parameters

  • identifierstringrequired

    The company's public identifier (example-co), id (1035), urn or link.

Query parameters

  • account_idstringrequired

    The account that reads: a Lempile LinkedIn account id (GET /accounts lists them).

Responses

200

OK

›

application/json

  • objectstringrequired
    AlwaysCompanyProfile
  • idstringrequired

    The company's id (digits).

  • namestringrequired
  • descriptionstringrequired
  • entity_urnstringrequired
  • public_identifierstringrequired
  • profile_urlstringrequired
  • taglinestring
  • followers_countinteger
  • is_followingboolean
  • is_employeeboolean
  • hashtagsarray of objectrequired
    ›Show fields
    • titlestringrequired
  • messagingobjectrequired
    ›Show fields
    • is_enabledbooleanrequired

      Always false: LinkedIn's page answer names no messaging setting.

    • idstring
    • entity_urnstring
  • claimedbooleanrequired
  • viewer_permissionsobjectrequired

    Each true for the page's admins, false for anyone else.

    ›Show fields
    • canMembersInviteToFollowboolean
    • canReadContentSuggestionsboolean
    • canReadMessagesboolean
    • canUpdateOrganizationProfileboolean
    • canCreateOrganicShareboolean
    • canReadAdminDashboardboolean
    • canReadOrganizationActivityboolean
    • canEditCuratorsboolean
    • canManageOrganizationalPageFollowboolean
    • canReadOrganizationFollowerAnalyticsboolean
    • canInviteMemberToFollowboolean
    • canReadOrganizationLeadsAnalyticsboolean
    • canEditPendingAdministratorsboolean
    • canManageMessagingAccessboolean
    • canSeeEmployeeExperienceAsMemberboolean
    • canEmployeesInviteToFollowboolean
    • canSeeOrganizationAdministrativePageboolean
    • canManageAdminRolesboolean
    • canEditOrganizationDetailsboolean
    • canApproveContentboolean
    • canViewTeamPerformanceboolean
    • canManageOrganizationSettingsboolean
    • canAccessAdvancedAnalyticsboolean
    • canModerateCommentsboolean
    • canCreateAdsboolean
    • canManageAdBudgetsboolean
    • canEditPageThemeboolean
    • canPublishNewslettersboolean
    • canEditCustomTabsboolean
    • canManageIntegrationsboolean
    • canAssignRolesboolean
    • canApprovePendingMembersboolean
    • canEditCareerPageSettingsboolean
    • canViewBillingInformationboolean
  • organization_typestring | nullrequired
    One ofPUBLIC_COMPANYEDUCATIONALSELF_EMPLOYEDGOVERNMENT_AGENCYNON_PROFITSELF_OWNEDPRIVATELY_HELDPARTNERSHIPnull
  • locationsarray of objectrequired
    ›Show fields
    • is_headquarterbooleanrequired
    • countrystringrequired
    • citystringrequired
    • postalCodestring
    • streetarray of stringrequired
    • descriptionstring
    • areastring
  • logostring
  • industryarray of string
  • activitiesarray of string

    The page's specialties.

  • employee_countinteger
  • employee_count_rangeobject
    ›Show fields
    • fromintegerrequired
    • tointegerrequired
  • websitestring
  • foundation_datestring
  • phonestring
  • acquired_byobject
    ›Show fields
    • idstringrequired
    • namestringrequired
    • public_identifierstringrequired
    • profile_urlstringrequired
400

A required parameter missing (errors/missing_parameters), or one that isn't valid (errors/invalid_parameters, errors/invalid_url, errors/content_too_large).

›

application/json

  • titlestringrequired

    A short title, e.g. Too many requests.

  • detailstringrequired

    What happened, in plain words. Never an account's data.

  • typestringrequired

    Unipile's error type: errors/<kind>. Branch on this, not on detail.

  • statusintegerrequired

    The HTTP status again.

  • retry_afterinteger

    Seconds to wait before trying this account again. Only on 429; the Retry-After header carries the same value.

401

errors/missing_credentials: the X-API-KEY header is missing, wrong or revoked. errors/disconnected_account: LinkedIn signed the account out (or asks it for a security check); reconnect it.

›

application/json

  • titlestringrequired

    A short title, e.g. Too many requests.

  • detailstringrequired

    What happened, in plain words. Never an account's data.

  • typestringrequired

    Unipile's error type: errors/<kind>. Branch on this, not on detail.

  • statusintegerrequired

    The HTTP status again.

  • retry_afterinteger

    Seconds to wait before trying this account again. Only on 429; the Retry-After header carries the same value.

403

LinkedIn refused it for this account (errors/resource_access_restricted, errors/account_restricted, errors/action_required), or the account doesn't write through Direct (errors/insufficient_permissions), or it needs Sales Navigator or Recruiter (errors/feature_not_subscribed).

›

application/json

  • titlestringrequired

    A short title, e.g. Too many requests.

  • detailstringrequired

    What happened, in plain words. Never an account's data.

  • typestringrequired

    Unipile's error type: errors/<kind>. Branch on this, not on detail.

  • statusintegerrequired

    The HTTP status again.

  • retry_afterinteger

    Seconds to wait before trying this account again. Only on 429; the Retry-After header carries the same value.

404

errors/resource_not_found: an unknown or removed account, an account of another workspace (answered exactly the same), or nothing on LinkedIn with this id.

›

application/json

  • titlestringrequired

    A short title, e.g. Too many requests.

  • detailstringrequired

    What happened, in plain words. Never an account's data.

  • typestringrequired

    Unipile's error type: errors/<kind>. Branch on this, not on detail.

  • statusintegerrequired

    The HTTP status again.

  • retry_afterinteger

    Seconds to wait before trying this account again. Only on 429; the Retry-After header carries the same value.

429

errors/too_many_requests: LinkedIn asked the account to slow down (it rests 15 minutes), its daily calls or writes are used up, or it's busy with other calls. Wait retry_after seconds.

›

application/json

  • titlestringrequired

    A short title, e.g. Too many requests.

  • detailstringrequired

    What happened, in plain words. Never an account's data.

  • typestringrequired

    Unipile's error type: errors/<kind>. Branch on this, not on detail.

  • statusintegerrequired

    The HTTP status again.

  • retry_afterinteger

    Seconds to wait before trying this account again. Only on 429; the Retry-After header carries the same value.

500

errors/provider_error: LinkedIn answered something Direct couldn't read (nothing was written). errors/unexpected_error: Direct failed.

›

application/json

  • titlestringrequired

    A short title, e.g. Too many requests.

  • detailstringrequired

    What happened, in plain words. Never an account's data.

  • typestringrequired

    Unipile's error type: errors/<kind>. Branch on this, not on detail.

  • statusintegerrequired

    The HTTP status again.

  • retry_afterinteger

    Seconds to wait before trying this account again. Only on 429; the Retry-After header carries the same value.

501

errors/feature_not_implemented: Direct doesn't do this (yet). A Unipile client can fall back to Unipile.

›

application/json

  • titlestringrequired

    A short title, e.g. Too many requests.

  • detailstringrequired

    What happened, in plain words. Never an account's data.

  • typestringrequired

    Unipile's error type: errors/<kind>. Branch on this, not on detail.

  • statusintegerrequired

    The HTTP status again.

  • retry_afterinteger

    Seconds to wait before trying this account again. Only on 429; the Retry-After header carries the same value.

503

errors/network_down: the account's proxy or browser server didn't answer. Nothing was sent.

›

application/json

  • titlestringrequired

    A short title, e.g. Too many requests.

  • detailstringrequired

    What happened, in plain words. Never an account's data.

  • typestringrequired

    Unipile's error type: errors/<kind>. Branch on this, not on detail.

  • statusintegerrequired

    The HTTP status again.

  • retry_afterinteger

    Seconds to wait before trying this account again. Only on 429; the Retry-After header carries the same value.

504

errors/request_timeout: LinkedIn didn't answer in time. On a write: an unknown outcome (it may have been sent); it's never retried and its Idempotency-Key never writes again.

›

application/json

  • titlestringrequired

    A short title, e.g. Too many requests.

  • detailstringrequired

    What happened, in plain words. Never an account's data.

  • typestringrequired

    Unipile's error type: errors/<kind>. Branch on this, not on detail.

  • statusintegerrequired

    The HTTP status again.

  • retry_afterinteger

    Seconds to wait before trying this account again. Only on 429; the Retry-After header carries the same value.

Was this page helpful?