# Indeed Company Scraper — Reviews, Ratings & Firmographics (`blackfalcondata/indeed-company-scraper`) Actor Turn any Indeed company page into clean, structured JSON. Get star-rated employee reviews with full text plus a firmographic overview of industry, size and revenue. Monitor new reviews incrementally, with compact results for AI agents. - **URL**: https://apify.com/blackfalcondata/indeed-company-scraper.md - **Developed by:** [Black Falcon Data](https://apify.com/blackfalcondata) (community) - **Categories:** Business, Lead generation, Automation - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $2.00 / 1,000 results This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ### What does Indeed Company Scraper do? Indeed Company Scraper extracts structured company data from [indeed.com](https://indeed.com) company pages — employee reviews with star ratings, five sub-ratings, review title and full text, job title, location and employment status, an opt-in interview-insights record (interview sources, hiring-process duration, sample questions), plus a firmographic overview covering rating, review count, industry, employee size, revenue, headquarters, founded year, CEO, website and happiness score. Enter a company name or an Indeed company URL, choose reviews, overview, or both, and cap reviews per company, so you can pull reputation and firmographic data consistently over time. **New to Apify?** [Sign up free](https://console.apify.com/sign-up?fpr=1h3gvi&fp_sid=ctaplain) and use the included $5 monthly platform credit to test this actor. ### Key features - **⭐ Employee reviews** — every review comes back structured: overall star rating, five sub-ratings (work-life balance, compensation, job security, management, culture), title, full text, reviewer job title, location, employment status, and helpful counts. - **🏢 Company overview** — a firmographic record per company: rating, review count, industry, employee range, revenue, headquarters, founded year, CEO, website, logo, happiness score, and category ratings. - **🎤 Interview insights (opt-in)** — one record per company with how candidates got their interviews, hiring-process duration distribution, and sample interview questions and experiences. - **🔎 Name or URL input** — enter a plain company name (`Google`) or paste an Indeed company URL. Names are resolved automatically, so you don't need to hunt for the exact slug. - **♻️ Incremental monitoring** — recurring runs emit and charge only for reviews unseen since the last run. First run builds the baseline; subsequent runs return just the new reviews. - **🔔 Notifications and webhooks** — push new reviews to Telegram, Slack, Discord, WhatsApp Cloud API, or a generic webhook, with change-only notifications for monitoring workflows. - **📦 AI-ready output controls** — compact mode and empty-field exclusion keep payloads small for agents and automation. - **🔌 MCP connectors** — export your results straight into Notion (or another connected app) via Apify's MCP connectors — a clean run-summary, no glue code. Opt-in via the App connector field; deterministic field-mapping, no AI. ### What data can you extract from indeed.com? Three record types share the dataset. A `review` record carries the overall star rating, five sub-ratings (work-life balance, compensation & benefits, job security & advancement, management, culture & values), review title and text, reviewer job title, location, country, employment status, submission date, and helpful counts. An `overview` record carries the company's rating, review count, happiness score, industry, sector, employee range, revenue, headquarters, founded year, CEO, website, logo, and per-category ratings. An opt-in `interview` record carries how candidates got their interviews (source distribution), the hiring-process duration distribution, and sample interview questions and experiences. Filter with `includeReviews` / `includeOverview` / `includeInterviews`. In standard mode every field is present — unavailable data points are `null`, never omitted. In compact mode only core fields are returned. ### Input Configure the actor through the input schema in Apify Console. Key parameters: - **`companies`** — Company names or Indeed company URLs. One string or a JSON array (e.g. ["Google", "https://www.indeed.com/cmp/Amazon-com"]). Names are resolved automatically — "general motors" finds the right company page. - **`startUrls`** — Alias for Companies — paste direct Indeed company or reviews URLs (indeed.com/cmp/...). Merged with the Companies list. - **`includeReviews`** — Scrape the company's employee reviews (star ratings, five sub-ratings, review title and full text, job title, location, employment status). (default: `true`) - **`includeOverview`** — Emit one firmographic overview record per company: rating, review count, industry, employee range, revenue, HQ, founded year, CEO, website, happiness score, and category ratings. (default: `true`) - **`includeInterviews`** — Also emit one interview-insights record per company: how candidates got interviews, hiring-process duration, and sample interview questions and experiences. (default: `false`) - **`maxReviews`** — Maximum reviews to scrape per company (newest first). Set 0 for all available reviews (best-effort — large companies have thousands). (default: `100`) - **`compact`** — Output only core fields per record. Ideal for AI agents, MCP workflows, and LLM context windows where token budget matters. (default: `false`) - **`excludeEmptyFields`** — Drop null, empty-string, and empty-array fields from each record before push. Smaller payloads for AI agents and dashboards. (default: `false`) - **`incrementalMode`** — Return only reviews not seen in a previous run for the same company set. Ideal for monitoring new reviews on a schedule. State is keyed automatically; set State Key to isolate universes. (default: `false`) - **`stateKey`** — Optional stable identifier for the tracked company set. Leave empty to auto-derive from the Companies list. Use distinct keys for unrelated monitors to keep their state separate. - **`telegramToken`** — Telegram bot token from @BotFather. Required for Telegram notifications. - **`telegramChatId`** — Telegram chat or channel ID where alerts are sent (e.g. "-100123456789" for a private group, or "@yourchannel"). - ...and 11 more parameters ### Input examples **Reviews + overview for one company** — Scrape both record types for a single company. → One `overview` record plus up to `maxReviews` `review` records, all standard fields populated where the source provides them. ```json { "companies": [ "Google" ], "includeReviews": true, "includeOverview": true, "maxReviews": 100 } ```` **Overview only for a list of companies** — Firmographics for many companies at once, no reviews. → One `overview` record per company: rating, industry, size, revenue, HQ, founded year, and CEO. ```json { "companies": [ "Amazon", "Microsoft", "Meta" ], "includeReviews": false, "includeOverview": true } ``` **Interview insights for a company** — Opt-in interview intelligence: sources, durations, sample questions. → One `interview` record per company with interviewSources, hiringDurations and sample Q\&A arrays. ```json { "companies": [ "Google" ], "includeReviews": false, "includeOverview": false, "includeInterviews": true } ``` **New reviews monitor (incremental)** — Return only reviews unseen since the last run for the same company set. → First run builds the baseline. Subsequent runs emit — and charge for — only reviews not seen before. Pair with notifications to alert on new reviews. ```json { "companies": [ "Google" ], "includeReviews": true, "includeOverview": false, "maxReviews": 50, "incrementalMode": true, "stateKey": "indeed-tracker" } ``` **Compact output for AI agents** — Only core fields per record for AI-agent and MCP workflows. → Small payload with the most important fields — ideal for piping into LLMs without token overhead. ```json { "companies": [ "Google" ], "includeReviews": true, "includeOverview": false, "compact": true } ``` ### Output Each run produces a dataset of structured company records. Results can be downloaded as JSON, CSV, or Excel from the Dataset tab in Apify Console. ### Example company record ```json { "recordType": "overview", "company": "Google", "sourceUrl": "https://www.indeed.com/cmp/Google", "indeedUrl": "https://www.indeed.com/cmp/Google", "rating": 4.3, "reviewCount": 6235, "reviewCountFormatted": "6.2K", "happinessGrade": "EXCELLENT", "happinessScore": 77, "description": "Since our founding in 1998, Google has grown by leaps and bounds. Starting from two computer science students in a university dorm room, we now have thousands of employees and offices around the world...", "industry": "Internet & Web Services", "sectorNames": [ "Internet & Web Services" ], "employeeRange": "more than 10,000", "employeeRangeRaw": "ERv1_10000_PLUS", "revenue": "more than $10B (USD)", "revenueRaw": "RRv1_OVER_10B", "foundedYear": 1998, "headquarters": "Mountain View, CA", "website": "http://goo.gle/3ygdkgv", "ceoName": "Sundar Pichai", "ceoApproval": 67, "logoUrl": "https://d2q79iu7y748jz.cloudfront.net/s/_squarelogo/96x96/d778456838f54580d43f7dd78b3b0d9c", "categoryRatings": { "compensationBenefits": 4.1, "culture": 4.2, "jobSecurityAdvancement": 3.7, "management": 3.9, "workLifeBalance": 4.2 }, "happinessResponses": 1813, "scrapedAt": "2026-07-13T22:05:00.164Z" } ``` ### Incremental mode Reviews on Indeed are immutable once posted, so incremental mode tracks them by ID: the first run establishes the baseline and subsequent runs emit — and charge for — only reviews not seen before for the same company set. State is keyed automatically from the company list; set `stateKey` to keep unrelated monitors separate. Pair with notifications and `notifyOnlyChanges` to alert only on newly-posted reviews. ### How to scrape indeed.com 1. Go to [Indeed Company Scraper](https://apify.com/blackfalcondata/indeed-company-scraper?fpr=1h3gvi) in Apify Console. 2. Configure the input. 3. Set `maxReviews` to control how many results you need. 4. Click **Start** and wait for the run to finish. 5. Export the dataset as JSON, CSV, or Excel. ### Use cases - Monitor new employee reviews for your company or competitors and get alerted the moment one is posted. - Benchmark employer reputation across a set of companies using ratings, happiness scores, and category ratings. - Enrich CRM or lead lists with firmographics: industry, employee size, revenue, HQ, founded year, and CEO. - Track reputation trends over time with scheduled incremental runs that return only new reviews. - Feed structured company and review data into AI agents, MCP tools, and automated pipelines using compact mode. - Export clean company data to dashboards, spreadsheets, or data warehouses as JSON, CSV, or Excel. ### How much does it cost to scrape indeed.com? Indeed Company Scraper uses [pay-per-event](https://docs.apify.com/platform/actors/paid-actors/pay-per-event) pricing. You pay a small fee when the run starts and then for each result that is actually produced. - **Run start:** $0.01 per run - **Per result:** $0.002 per company record Example costs: - 10 results: **$0.03** - 25 results: **$0.06** - 100 results: **$0.21** - 200 results: **$0.41** - 500 results: **$1.01** #### Example: recurring monitoring savings These examples compare full re-scrapes with incremental runs at different churn rates. Churn is the share of records that are new or whose tracked content changed since the previous run. Actual churn depends on your query breadth, source activity, and polling frequency — the scenarios below are examples, not predictions. Example setup: 250 results per run, daily polling (30 runs/month). Event-pricing examples scale linearly with result count. | Churn rate | Full re-scrape run cost | Incremental run cost | Savings vs full re-scrape | Monthly cost after baseline | |---|---:|---:|---:|---:| | 5% — stable niche query | $0.51 | $0.04 | $0.47 (93%) | $1.05 | | 15% — moderate broad query | $0.51 | $0.08 | $0.43 (83%) | $2.55 | | 30% — high-volume aggregator | $0.51 | $0.16 | $0.35 (69%) | $4.80 | Full re-scrape monthly cost at daily polling: $15.30. First month with incremental costs $1.53 / $2.97 / $5.15 for the 5% / 15% / 30% scenarios because the first run builds baseline state at full cost before incremental savings apply. Platform usage is included in the per-result fee shown above. ### FAQ #### How many results can I get from indeed.com? The number of results depends on the search query and available records on indeed.com. Use the `maxReviews` parameter to control how many results are returned per run. #### Does Indeed Company Scraper support recurring monitoring? Yes. Enable incremental mode to only receive new or changed records on subsequent runs. This is ideal for scheduled monitoring where you want to track changes over time without re-processing the full dataset. #### Can I integrate Indeed Company Scraper with other apps? Yes. Indeed Company Scraper works with Apify's [integrations](https://apify.com/integrations?fpr=1h3gvi) to connect with tools like Zapier, Make, Google Sheets, Slack, and more. You can also use webhooks to trigger actions when a run completes. #### Can I use Indeed Company Scraper with the Apify API? Yes. You can start runs, manage inputs, and retrieve results programmatically through the [Apify API](https://docs.apify.com/api/v2). Client libraries are available for JavaScript, Python, and other languages. #### Can I use Indeed Company Scraper through an MCP Server? Yes. Apify provides an [MCP Server](https://apify.com/apify/actors-mcp-server?fpr=1h3gvi) that lets AI assistants and agents call this actor directly. Use compact mode and `excludeEmptyFields` to keep payloads manageable for LLM context windows. #### Is it legal to scrape indeed.com? This actor extracts publicly available data from indeed.com. Web scraping of public information is generally considered legal, but you should always review the target site's terms of service and ensure your use case complies with applicable laws and regulations, including GDPR where relevant. #### Your feedback If you have questions, need a feature, or found a bug, please [open an issue](https://apify.com/blackfalcondata/indeed-company-scraper/issues?fpr=1h3gvi) on the actor's page in Apify Console. Your feedback helps us improve. ### You might also like - [Actiris Brussels Job Scraper](https://apify.com/blackfalcondata/actiris-scraper?fpr=1h3gvi) — Scrape all active job listings from actiris.brussels — official Brussels public employment service.. - [AMS Austria Job Scraper — Austrian Public Employment Service](https://apify.com/blackfalcondata/ams-austria-job-scraper?fpr=1h3gvi) — Scrape jobs.ams.at — Austria's official AMS public employment portal, branded "alle jobs" ("all. - [APEC.fr Scraper - French Executive Jobs](https://apify.com/blackfalcondata/apec-scraper?fpr=1h3gvi) — Scrape apec.fr - French executive job listings with salary ranges, company, location, skills,. - [Arbeitsagentur Jobs Feed — German Federal Employment Agency](https://apify.com/blackfalcondata/arbeitsagentur-jobs-feed?fpr=1h3gvi) — Scrape arbeitsagentur.de — Germany's official public employment portal with over 1 million live job. - [Arbetsformedlingen Job Scraper](https://apify.com/blackfalcondata/arbetsformedlingen-scraper?fpr=1h3gvi) — Scrape arbetsformedlingen.se (Platsbanken) — Sweden's official employment portal. Returns 84. - [Bayt.com Scraper — MENA Jobs with Salary & Skills Filter](https://apify.com/blackfalcondata/bayt-scraper?fpr=1h3gvi) — Scrape bayt.com — the leading Middle East job board spanning UAE, Saudi Arabia, Qatar, Egypt. - [Bumeran Scraper — LATAM Jobs across 7 Countries & 8 Brands](https://apify.com/blackfalcondata/bumeran-scraper?fpr=1h3gvi) — Scrape Bumeran Group's job boards across LATAM — Argentina (bumeran.com.ar + zonajobs), Chile. - [Cadremploi Scraper — French Executive & Management Jobs](https://apify.com/blackfalcondata/cadremploi-scraper?fpr=1h3gvi) — Scrape cadremploi.fr — France's leading job board for executives and managers (cadres). Salary. - [Indeed Job Scraper](https://apify.com/blackfalcondata/indeed-scraper?fpr=1h3gvi) — Scrape Indeed **job listings** by keyword and location: title, company, salary, type, apply URL and full descriptions across 62 markets. - [Indeed Salary Scraper](https://apify.com/blackfalcondata/indeed-salary-scraper?fpr=1h3gvi) — Scrape Indeed **salary** data: median/min/max pay by job title and location across five pay periods, plus top-paying companies and cities. ### Getting started with Apify New to Apify? [Create a free account with $5 credit](https://console.apify.com/sign-up?fpr=1h3gvi\&fp_sid=ctaplain) — no credit card required. 1. Sign up — $5 platform credit included 2. Open this actor and configure your input 3. Click **Start** — export results as JSON, CSV, or Excel Need more later? [See Apify pricing](https://apify.com/pricing?fpr=1h3gvi). # Actor input Schema ## `companies` (type: `array`): Company names or Indeed company URLs. One string or a JSON array (e.g. \["Google", "https://www.indeed.com/cmp/Amazon-com"]). Names are resolved automatically — "general motors" finds the right company page. ## `startUrls` (type: `array`): Alias for Companies — paste direct Indeed company or reviews URLs (indeed.com/cmp/...). Merged with the Companies list. ## `includeReviews` (type: `boolean`): Scrape the company's employee reviews (star ratings, five sub-ratings, review title and full text, job title, location, employment status). ## `includeOverview` (type: `boolean`): Emit one firmographic overview record per company: rating, review count, industry, employee range, revenue, HQ, founded year, CEO, website, happiness score, and category ratings. ## `includeInterviews` (type: `boolean`): Also emit one interview-insights record per company: how candidates got interviews, hiring-process duration, and sample interview questions and experiences. ## `maxReviews` (type: `integer`): Maximum reviews to scrape per company (newest first). Set 0 for all available reviews (best-effort — large companies have thousands). ## `compact` (type: `boolean`): Output only core fields per record. Ideal for AI agents, MCP workflows, and LLM context windows where token budget matters. ## `excludeEmptyFields` (type: `boolean`): Drop null, empty-string, and empty-array fields from each record before push. Smaller payloads for AI agents and dashboards. ## `incrementalMode` (type: `boolean`): Return only reviews not seen in a previous run for the same company set. Ideal for monitoring new reviews on a schedule. State is keyed automatically; set State Key to isolate universes. ## `stateKey` (type: `string`): Optional stable identifier for the tracked company set. Leave empty to auto-derive from the Companies list. Use distinct keys for unrelated monitors to keep their state separate. ## `telegramToken` (type: `string`): Telegram bot token from @BotFather. Required for Telegram notifications. ## `telegramChatId` (type: `string`): Telegram chat or channel ID where alerts are sent (e.g. "-100123456789" for a private group, or "@yourchannel"). ## `discordWebhookUrl` (type: `string`): Discord incoming webhook URL. Get one from Server Settings → Integrations → Webhooks. ## `slackWebhookUrl` (type: `string`): Slack incoming webhook URL. Create at api.slack.com/messaging/webhooks. ## `whatsappPhoneNumberId` (type: `string`): WhatsApp Business phone number ID from Meta Business Manager (the numeric ID, not the phone number). Free service-conversation messages within 24 hours of last user-initiated contact. ## `whatsappAccessToken` (type: `string`): Meta Cloud API access token with `whatsapp_business_messaging` scope. Get a permanent token from a system user in Meta Business Manager. ## `whatsappTo` (type: `string`): Recipient phone in E.164 format (e.g. +919876543210). Recipient must have messaged your business number within the last 24 hours. ## `webhookUrl` (type: `string`): Generic webhook URL that receives a JSON POST with the review payload + run metadata. Universal escape hatch for n8n / Make / Zapier / your own backend. ## `webhookHeaders` (type: `object`): Optional headers (e.g. {"Authorization": "Bearer xyz"}) sent with the webhook POST. ## `notificationLimit` (type: `integer`): Maximum number of reviews included in each notification message (1–20). Excess reviews are still in the dataset. ## `notifyOnlyChanges` (type: `boolean`): When Incremental Mode is on, only send notifications for newly-seen reviews. ## `appConnector` (type: `string`): Optional. Pick a connected app under Settings → API & Integrations to receive your results. Best-effort across MCP connectors. ## `mcpIssueTeam` (type: `string`): Only for issue-tracker connectors: the team (name or ID) the summary issue is created under, if required. ## Actor input object example ```json { "companies": [ "Google" ], "includeReviews": true, "includeOverview": true, "includeInterviews": false, "maxReviews": 100, "compact": false, "excludeEmptyFields": false, "incrementalMode": false, "notificationLimit": 5, "notifyOnlyChanges": false } ``` # Actor output Schema ## `results` (type: `string`): No description # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "companies": [ "Google" ], "includeReviews": true, "includeOverview": true, "includeInterviews": false, "maxReviews": 100, "excludeEmptyFields": false }; // Run the Actor and wait for it to finish const run = await client.actor("blackfalcondata/indeed-company-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "companies": ["Google"], "includeReviews": True, "includeOverview": True, "includeInterviews": False, "maxReviews": 100, "excludeEmptyFields": False, } # Run the Actor and wait for it to finish run = client.actor("blackfalcondata/indeed-company-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "companies": [ "Google" ], "includeReviews": true, "includeOverview": true, "includeInterviews": false, "maxReviews": 100, "excludeEmptyFields": false }' | apify call blackfalcondata/indeed-company-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=blackfalcondata/indeed-company-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Indeed Company Scraper — Reviews, Ratings & Firmographics", "description": "Turn any Indeed company page into clean, structured JSON. Get star-rated employee reviews with full text plus a firmographic overview of industry, size and revenue. Monitor new reviews incrementally, with compact results for AI agents.", "version": "1.1", "x-build-id": "mWCOZ2znOFpetitOG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/blackfalcondata~indeed-company-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-blackfalcondata-indeed-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/blackfalcondata~indeed-company-scraper/runs": { "post": { "operationId": "runs-sync-blackfalcondata-indeed-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/blackfalcondata~indeed-company-scraper/run-sync": { "post": { "operationId": "run-sync-blackfalcondata-indeed-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", "properties": { "companies": { "title": "🏢 Companies", "type": "array", "description": "Company names or Indeed company URLs. One string or a JSON array (e.g. [\"Google\", \"https://www.indeed.com/cmp/Amazon-com\"]). Names are resolved automatically — \"general motors\" finds the right company page.", "items": { "type": "string" } }, "startUrls": { "title": "🔗 Start URLs", "type": "array", "description": "Alias for Companies — paste direct Indeed company or reviews URLs (indeed.com/cmp/...). Merged with the Companies list.", "items": { "type": "string" } }, "includeReviews": { "title": "⭐ Include Reviews", "type": "boolean", "description": "Scrape the company's employee reviews (star ratings, five sub-ratings, review title and full text, job title, location, employment status).", "default": true }, "includeOverview": { "title": "🏢 Include Company Overview", "type": "boolean", "description": "Emit one firmographic overview record per company: rating, review count, industry, employee range, revenue, HQ, founded year, CEO, website, happiness score, and category ratings.", "default": true }, "includeInterviews": { "title": "🎤 Include Interview Insights", "type": "boolean", "description": "Also emit one interview-insights record per company: how candidates got interviews, hiring-process duration, and sample interview questions and experiences.", "default": false }, "maxReviews": { "title": "💯 Max Reviews Per Company", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Maximum reviews to scrape per company (newest first). Set 0 for all available reviews (best-effort — large companies have thousands).", "default": 100 }, "compact": { "title": "📦 Compact Output", "type": "boolean", "description": "Output only core fields per record. Ideal for AI agents, MCP workflows, and LLM context windows where token budget matters.", "default": false }, "excludeEmptyFields": { "title": "✂️ Exclude Empty Fields", "type": "boolean", "description": "Drop null, empty-string, and empty-array fields from each record before push. Smaller payloads for AI agents and dashboards.", "default": false }, "incrementalMode": { "title": "♻️ Incremental Mode", "type": "boolean", "description": "Return only reviews not seen in a previous run for the same company set. Ideal for monitoring new reviews on a schedule. State is keyed automatically; set State Key to isolate universes.", "default": false }, "stateKey": { "title": "🔑 State Key", "type": "string", "description": "Optional stable identifier for the tracked company set. Leave empty to auto-derive from the Companies list. Use distinct keys for unrelated monitors to keep their state separate." }, "telegramToken": { "title": "🤖 Telegram Bot Token", "type": "string", "description": "Telegram bot token from @BotFather. Required for Telegram notifications." }, "telegramChatId": { "title": "💬 Telegram Chat ID", "type": "string", "description": "Telegram chat or channel ID where alerts are sent (e.g. \"-100123456789\" for a private group, or \"@yourchannel\")." }, "discordWebhookUrl": { "title": "🎮 Discord Webhook URL", "type": "string", "description": "Discord incoming webhook URL. Get one from Server Settings → Integrations → Webhooks." }, "slackWebhookUrl": { "title": "💼 Slack Webhook URL", "type": "string", "description": "Slack incoming webhook URL. Create at api.slack.com/messaging/webhooks." }, "whatsappPhoneNumberId": { "title": "📱 WhatsApp Phone Number ID", "type": "string", "description": "WhatsApp Business phone number ID from Meta Business Manager (the numeric ID, not the phone number). Free service-conversation messages within 24 hours of last user-initiated contact." }, "whatsappAccessToken": { "title": "🔐 WhatsApp Access Token", "type": "string", "description": "Meta Cloud API access token with `whatsapp_business_messaging` scope. Get a permanent token from a system user in Meta Business Manager." }, "whatsappTo": { "title": "📨 WhatsApp Recipient", "type": "string", "description": "Recipient phone in E.164 format (e.g. +919876543210). Recipient must have messaged your business number within the last 24 hours." }, "webhookUrl": { "title": "🪝 Generic Webhook URL", "type": "string", "description": "Generic webhook URL that receives a JSON POST with the review payload + run metadata. Universal escape hatch for n8n / Make / Zapier / your own backend." }, "webhookHeaders": { "title": "🔑 Webhook Headers", "type": "object", "description": "Optional headers (e.g. {\"Authorization\": \"Bearer xyz\"}) sent with the webhook POST." }, "notificationLimit": { "title": "📊 Max Reviews Per Notification", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of reviews included in each notification message (1–20). Excess reviews are still in the dataset.", "default": 5 }, "notifyOnlyChanges": { "title": "🔄 Notify Only New", "type": "boolean", "description": "When Incremental Mode is on, only send notifications for newly-seen reviews.", "default": false }, "appConnector": { "title": "Send results to a connected app", "type": "string", "description": "Optional. Pick a connected app under Settings → API & Integrations to receive your results. Best-effort across MCP connectors." }, "mcpIssueTeam": { "title": "Issue tracker team", "type": "string", "description": "Only for issue-tracker connectors: the team (name or ID) the summary issue is created under, if required." } } }, "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 } } } } } } } } } } ```