Search / TypeScript SDK
Search companies database
LinkedIn company search through a connected account. Pass params with category="companies" plus resolved filters. Returns { results, totalCount, cursor, planType }.
pipeline.searchCompaniesDatabaseDeterministic operationParameters
workspaceIdOptional · string- Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.
accountIdOptional · string- UUID of the connected LinkedIn account to search through.
paramsRequired · object- Typed LinkedIn company filters. category="companies" is required.
apiOptional · string- See the input schema for this field.classic · sales_nav · recruiter
cursorOptional · string- See the input schema for this field.
limitOptional · number- Max results (1-100, default 25).
await pipeline.searchCompaniesDatabase({
"params": {
"category": "companies"
}
})Full input schema
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"minLength": 1,
"description": "Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client."
},
"accountId": {
"type": "string",
"description": "UUID of the connected LinkedIn account to search through."
},
"params": {
"type": "object",
"properties": {
"api": {
"type": "string",
"enum": [
"classic",
"sales_nav",
"sales_navigator",
"recruiter"
]
},
"category": {
"type": "string",
"enum": [
"people",
"companies"
]
},
"keywords": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"title": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"location": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\d+$"
}
},
"industry": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\d+$"
}
},
"current_company": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\d+$"
}
},
"past_company": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\d+$"
}
},
"school": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\d+$"
}
},
"network_distance": {
"type": "array",
"items": {
"type": "number",
"enum": [
1,
2,
3
]
}
},
"connections_of": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\d+$"
}
},
"followers_of": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\d+$"
}
},
"seniority": {
"type": "array",
"items": {
"type": "string"
}
},
"function": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\d+$"
}
},
"company_headcount": {
"type": "array",
"items": {
"type": "string"
}
},
"saved_search_id": {
"type": "string"
},
"recruiter_network_distance": {
"type": "array",
"items": {
"type": "string",
"enum": [
"F",
"S",
"A"
]
}
},
"can_send_inmail": {
"type": "boolean"
}
},
"additionalProperties": false,
"description": "Typed LinkedIn company filters. category=\"companies\" is required."
},
"api": {
"type": "string",
"enum": [
"classic",
"sales_nav",
"recruiter"
]
},
"cursor": {
"type": "string"
},
"limit": {
"type": "number",
"description": "Max results (1-100, default 25)."
}
},
"required": [
"params"
]
}