fetch_company
Retrieve LinkedIn company details, including employees, posts, and decision makers, using a company URL. Customize data retrieval with filters and optional configurations for targeted insights.
Instructions
Allows you to open a company page to retrieve its basic information (st.openCompanyPage action). Can optionally retrieve employees, posts and decision makers.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| companyUrl | Yes | Public or hashed LinkedIn URL of the company. (e.g., 'https://www.linkedin.com/company/microsoft') | |
| dmRetrievalConfig | No | Optional. Configuration for retrieving decision makers. Available only if retrieveDMs is true. | |
| employeeRetrievalConfig | No | Optional. Configuration for retrieving employees. Available only if retrieveEmployees is true. | |
| postRetrievalConfig | No | Optional. Configuration for retrieving posts. Available only if retrievePosts is true. | |
| retrieveDMs | No | Optional. Whether to retrieve the company's decision makers information. Default is false. | |
| retrieveEmployees | No | Optional. Whether to retrieve the company's employees information. Default is false. | |
| retrievePosts | No | Optional. Whether to retrieve the company's posts information. Default is false. |
Input Schema (JSON Schema)
{
"properties": {
"companyUrl": {
"description": "Public or hashed LinkedIn URL of the company. (e.g., 'https://www.linkedin.com/company/microsoft')",
"type": "string"
},
"dmRetrievalConfig": {
"description": "Optional. Configuration for retrieving decision makers. Available only if retrieveDMs is true.",
"properties": {
"limit": {
"description": "Optional. Number of decision makers to retrieve. Defaults to 20, with a maximum value of 20. If a company has fewer decision makers than specified, only the available ones will be returned.",
"type": "number"
}
},
"type": "object"
},
"employeeRetrievalConfig": {
"description": "Optional. Configuration for retrieving employees. Available only if retrieveEmployees is true.",
"properties": {
"filter": {
"description": "Optional. Object that specifies filtering criteria for employees. When multiple filter fields are specified, they are combined using AND logic.",
"properties": {
"firstName": {
"description": "Optional. First name of employee.",
"type": "string"
},
"industries": {
"description": "Optional. Array of enums representing industries. Matches if employee works in any of the listed industries. Takes specific values available in the LinkedIn interface.",
"type": "array"
},
"lastName": {
"description": "Optional. Last name of employee.",
"type": "string"
},
"locations": {
"description": "Optional. Array of free-form strings representing locations. Matches if employee is located in any of the listed locations.",
"type": "array"
},
"position": {
"description": "Optional. Job position of employee.",
"type": "string"
},
"schools": {
"description": "Optional. Array of institution names. Matches if employee currently attends or previously attended any of the listed institutions.",
"type": "array"
}
},
"type": "object"
},
"limit": {
"description": "Optional. Maximum number of employees to retrieve. Defaults to 500, with a maximum value of 500.",
"type": "number"
}
},
"type": "object"
},
"postRetrievalConfig": {
"description": "Optional. Configuration for retrieving posts. Available only if retrievePosts is true.",
"properties": {
"limit": {
"description": "Optional. Number of posts to retrieve. Defaults to 20, with a maximum value of 20.",
"type": "number"
},
"since": {
"description": "Optional. ISO 8601 timestamp to filter posts published after the specified time.",
"type": "string"
}
},
"type": "object"
},
"retrieveDMs": {
"description": "Optional. Whether to retrieve the company's decision makers information. Default is false.",
"type": "boolean"
},
"retrieveEmployees": {
"description": "Optional. Whether to retrieve the company's employees information. Default is false.",
"type": "boolean"
},
"retrievePosts": {
"description": "Optional. Whether to retrieve the company's posts information. Default is false.",
"type": "boolean"
}
},
"required": [
"companyUrl"
],
"type": "object"
}