Skip to main content
POST
Read LinkedIn company

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of read_linkedin_company.

ln_nickname
string | null

The company page slug, or its linkedin.com/company/ link; parsed at the edge, never stored. One of ln_nickname, ln_id and domain.

Required string length: 1 - 2048
ln_id
string | null

The page's numeric LinkedIn id, as digits (read_linkedin_person's company_ln_id), when the slug is not known: the page is read by the address LinkedIn serves for it.

Pattern: ^\d{1,20}$
domain
string | null

The company's website domain (acme.com, a URL accepted), when neither the slug nor the id is known: a corpus lookup, which answers only a page the corpus already knows (found false, reason company_not_resolvable, otherwise).

Required string length: 1 - 255

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
any
required
result
object
required
meta
object
required