{ "openapi": "3.0.1", "info": { "title": "GoWork FR & DE Company Reviews and Profile Scraper", "description": "Extract company profiles from GoWork France and Germany, including contact details, review threads with replies, ratings breakdowns, opening hours, social links, SIREN/NAF identifiers, and 100+ structured company fields. Supports keyword search, URL input, and bulk sitemap discovery.", "version": "1.6", "x-build-id": "8Y7Z7wC60adMGDRDY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abotapi~gowork-eu-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abotapi-gowork-eu-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/abotapi~gowork-eu-scraper/runs": { "post": { "operationId": "runs-sync-abotapi-gowork-eu-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/abotapi~gowork-eu-scraper/run-sync": { "post": { "operationId": "run-sync-abotapi-gowork-eu-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": [ "mode" ], "properties": { "mode": { "title": "Start mode", "enum": [ "search", "url", "sitemap" ], "type": "string", "description": "Pick how to seed companies. search: free-text queries. url: paste detail or search URLs (multi). sitemap: walk the gowork.fr or gowork.de sitemap index for bulk discovery.", "default": "search" }, "locale": { "title": "Site locale", "enum": [ "fr", "de" ], "type": "string", "description": "Applies to search and sitemap modes. URL mode infers locale from the host (gowork.fr vs gowork.de) automatically.", "default": "fr" }, "queries": { "title": "Search queries", "type": "array", "description": "Search terms (company name, brand, or keyword). One query becomes one SERP walk.", "items": { "type": "string" } }, "urls": { "title": "Start URLs", "type": "array", "description": "Paste detail URLs (e.g. https://gowork.fr/b-hive-mulhouse) or full search URLs (e.g. https://gowork.fr/search?q=Carrefour&page=2). Multi-URL supported. Filter-mode fields are ignored. Search URLs auto-paginate forward.", "items": { "type": "string" } }, "sitemapKind": { "title": "Sitemap kind", "enum": [ "constant", "cities", "regions", "rankings", "all" ], "type": "string", "description": "Which sitemap shard family to walk. \"constant\" yields company profile URLs and is the most useful for bulk seeding.", "default": "constant" }, "sitemapFilter": { "title": "Sitemap URL keyword filter (optional)", "type": "string", "description": "Case-insensitive substring filter applied to discovered URLs (matches the slug part). Empty = no filter.", "default": "" }, "output": { "title": "Output shape", "enum": [ "company", "reviews" ], "type": "string", "description": "company: standard one-record-per-company shape with reviews nested. reviews: flat shape, each review becomes its own row with companySlug / companyName / companySiteLocale / companyRating / etc. joined in. reviews mode auto-enables fetchDetails.", "default": "company" }, "fetchDetails": { "title": "Fetch full company detail (recommended)", "type": "boolean", "description": "When ON, fetches each detail page and extracts the full Nuxt payload, opening hours, all reviews, histogram, social links, NAF code, geo. When OFF, only SERP-card data is returned (no detail surcharge). Auto-promoted to ON when output=reviews.", "default": true }, "maxPages": { "title": "Max SERP pages per search", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Pagination ceiling per search query / per SERP URL. 0 = unlimited (walk until end of results or maxListings cap is hit). URL-mode detail URLs ignore this.", "default": 0 }, "maxListings": { "title": "Max companies (hard cap across all modes)", "minimum": 0, "type": "integer", "description": "Hard ceiling on companies returned across the whole run, regardless of mode (search / url / sitemap). 0 = unlimited (only bounded by Apify's per-run timeout). This is the authoritative budget cap, applied AFTER per-search pagination.", "default": 25 }, "maxReviewsPerCompany": { "title": "Max review threads per company", "minimum": 0, "maximum": 500, "type": "integer", "description": "Cap on review threads (each thread can also include replies) returned per company. 0 = unlimited.", "default": 50 }, "minRating": { "title": "Minimum company rating", "minimum": 0, "maximum": 5, "type": "integer", "description": "Skip companies whose aggregate rating is below this threshold (0-5). Applied client-side.", "default": 0 }, "minReviewCount": { "title": "Minimum review count", "minimum": 0, "type": "integer", "description": "Skip companies with fewer than N total reviews.", "default": 0 }, "ratedOnly": { "title": "Only companies with at least one rated review", "type": "boolean", "description": "Skip companies whose JSON-LD aggregate rating count is zero (i.e., no scored reviews on file).", "default": false }, "verifiedOnly": { "title": "Only verified companies", "type": "boolean", "description": "Skip companies marked as unverified (status flag from the Nuxt payload).", "default": false }, "proxy": { "title": "Proxy", "type": "object", "description": "GoWork uses an upstream edge filter that prefers residential connections. Apify Residential FR (default) or DE lifts it naturally for most pages. Datacenter is rejected." } } }, "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 } } } } } } } } } }