{ "openapi": "3.0.1", "info": { "title": "LinkedIn Company Scraper", "description": "Extract companies from LinkedIn. Returns employee count, industry, headquarters, description, and specialties. Optional employee profile scraping. Pay-per-result.", "version": "1.0", "x-build-id": "pqKKW6p7GSNRzTwqN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/santamaria-automations~linkedin-company-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-santamaria-automations-linkedin-company-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/santamaria-automations~linkedin-company-scraper/runs": { "post": { "operationId": "runs-sync-santamaria-automations-linkedin-company-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/santamaria-automations~linkedin-company-scraper/run-sync": { "post": { "operationId": "run-sync-santamaria-automations-linkedin-company-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "companies" ], "properties": { "companies": { "title": "Companies to Enrich", "type": "array", "description": "List of companies to look up on LinkedIn. Provide linkedin_url if known, otherwise we search by company name + domain.", "items": { "type": "object", "required": [ "company_id", "company_name" ], "properties": { "company_id": { "title": "Company ID", "type": "string", "description": "Your internal company identifier (UUID or any string)" }, "company_name": { "title": "Company Name", "type": "string", "description": "Company name to search on LinkedIn" }, "website_domain": { "title": "Website Domain", "type": "string", "description": "e.g. example.com" }, "linkedin_url": { "title": "LinkedIn URL", "type": "string", "description": "Direct LinkedIn company URL if known" } } } }, "includeEmployees": { "title": "Include Employees", "type": "boolean", "description": "Scrape employee profiles from the company's people page (limited without login)", "default": false }, "maxEmployeesPerCompany": { "title": "Max Employees Per Company", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of employee profiles to scrape per company", "default": 10 }, "employeeTitleFilters": { "title": "Employee Title Filters", "type": "array", "description": "Filter employees by title keywords (e.g., HR, CEO, CTO, Recruiter). Empty = all.", "default": [ "HR", "CEO", "CTO", "Recruiter", "People", "Talent" ], "items": { "type": "string" } }, "includePosts": { "title": "Include Recent Posts", "type": "boolean", "description": "Also parse the last few company posts from the guest feed (post_id, post_url, text, published_at, like_count, comment_count, share_count, has_image, has_video). Useful for icebreakers and lead-scoring signals. Off by default to keep runs cheap.", "default": false }, "maxPostsPerCompany": { "title": "Max Posts Per Company", "minimum": 1, "maximum": 15, "type": "integer", "description": "How many recent posts to return per company when includePosts is on. LinkedIn's guest feed exposes about 10 activity cards per company, so raising this above 10 rarely yields more data.", "default": 5 }, "linkedinCookie": { "title": "LinkedIn Cookie (li_at)", "type": "string", "description": "Your LinkedIn li_at session cookie. Get it from browser DevTools > Application > Cookies > linkedin.com > li_at. Alternative to email/password login." }, "linkedinEmail": { "title": "LinkedIn Email", "type": "string", "description": "LinkedIn login email. Used for programmatic login to get li_at cookie automatically. May trigger 2FA." }, "linkedinPassword": { "title": "LinkedIn Password", "type": "string", "description": "LinkedIn login password." }, "requestDelay": { "title": "Request Delay (ms)", "minimum": 500, "type": "integer", "description": "Delay between requests to avoid rate limiting", "default": 2000 }, "customData": { "title": "Custom Data", "type": "object", "description": "Custom data passed to webhook (campaign_id, pipeline_run_id)" }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "RESIDENTIAL proxy required for LinkedIn", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }