{ "openapi": "3.0.1", "info": { "title": "France Companies Likely to Hire: La Bonne Boite Leads", "description": "Find French companies most likely to hire in the next 6 months, by job, NAF code and area. Official France Travail La Bonne Boite data: SIRET, size, sector, hiring score, plus a free labour market tension score (1-5). Pay per company.", "version": "1.0", "x-build-id": "HZwjjMvCLv8wWFXuf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datacraft-studio~france-companies-likely-to-hire/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datacraft-studio-france-companies-likely-to-hire", "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/datacraft-studio~france-companies-likely-to-hire/runs": { "post": { "operationId": "runs-sync-datacraft-studio-france-companies-likely-to-hire", "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/datacraft-studio~france-companies-likely-to-hire/run-sync": { "post": { "operationId": "run-sync-datacraft-studio-france-companies-likely-to-hire", "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": { "jobKeywords": { "title": "Jobs (plain words)", "type": "array", "description": "Job titles in French, e.g. \"développeur\", \"plombier\", \"aide-soignant\". Each is matched to official ROME job codes (shown in the run summary). Accents and case do not matter.", "items": { "type": "string" } }, "romeCodes": { "title": "ROME job codes", "type": "array", "description": "Official ROME codes such as M1805 (software developer), D1102 (baker), J1501 (care assistant). Use this for exact control.", "items": { "type": "string" } }, "nafCodes": { "title": "NAF / APE activity codes", "type": "array", "description": "5-character NAF codes of the companies, e.g. 6202A or 62.02A. Searched separately from jobs.", "items": { "type": "string" } }, "departments": { "title": "Departments", "type": "array", "description": "Department codes such as 75, 69, 2A, 974. Use ALL for the whole of France.", "items": { "type": "string" } }, "regions": { "title": "Regions", "type": "array", "description": "INSEE region codes: 11 Ile-de-France, 84 Auvergne-Rhone-Alpes, 93 Provence-Alpes-Cote d'Azur, 75 Nouvelle-Aquitaine, 76 Occitanie, 32 Hauts-de-France, 44 Grand Est, 52 Pays de la Loire, 53 Bretagne, 28 Normandie, 27 Bourgogne-Franche-Comte, 24 Centre-Val de Loire, 94 Corse.", "items": { "type": "string" } }, "cityCodes": { "title": "City INSEE codes", "type": "array", "description": "INSEE city codes, searched with the radius below. Paris, Lyon and Marseille use district codes (75101, 69381, 13201).", "items": { "type": "string" } }, "postcodes": { "title": "Postcodes", "type": "array", "description": "5-digit postcodes, searched with the radius below.", "items": { "type": "string" } }, "distanceKm": { "title": "Radius (km)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Radius around each city or postcode.", "default": 10 }, "sirets": { "title": "SIRETs to check", "type": "array", "description": "Check mode: 14-digit SIRETs of establishments. Returns their hiring potential score when La Bonne Boite lists them.", "items": { "type": "string" } }, "minHeadcount": { "title": "Minimum headcount", "minimum": 0, "type": "integer", "description": "Keep only establishments whose headcount band reaches at least this number of employees. Companies with unknown headcount are dropped when set.", "default": 0 }, "onlyHighPotential": { "title": "Only high hiring potential", "type": "boolean", "description": "Keep only establishments flagged by France Travail as high hiring potential.", "default": false }, "minHiringPotential": { "title": "Minimum hiring score", "minimum": 0, "type": "integer", "description": "Keep only establishments with a hiring potential score at least this high." }, "maxItems": { "title": "Max companies", "minimum": 1, "type": "integer", "description": "Hard cap on delivered (and charged) companies. Best scores first.", "default": 200 }, "maxResultsPerQuery": { "title": "Max results read per query", "minimum": 100, "maximum": 10000, "type": "integer", "description": "Each job batch x location is one query. Raise this for large areas when you want more than the best few hundred companies.", "default": 1000 }, "onlyNew": { "title": "Only companies not delivered before", "type": "boolean", "description": "For scheduled runs: skip (and do not charge) SIRETs delivered by an earlier run that used the same state store.", "default": false }, "stateStoreName": { "title": "State store name", "type": "string", "description": "Named key-value store that remembers delivered SIRETs when onlyNew is on. Use one per search profile.", "default": "france-likely-to-hire-state" }, "addLabourMarketTension": { "title": "Add labour market tension score", "type": "boolean", "description": "Adds, for each company, how hard it is to recruit for its matched job in its department (1 = very low to 5 = very high), with the 7 drivers behind it. Official France Travail / DARES indicator from the Marché du travail API. Free: no extra charge.", "default": true }, "maxTensionLookups": { "title": "Max tension lookups", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Cap on job x department lookups for the tension score. Companies beyond the cap get null tension fields.", "default": 300 }, "franceTravailClientId": { "title": "Your France Travail client ID (optional)", "type": "string", "description": "Optional. The Actor works without it. Add your own free francetravail.io application credentials (subscribed to La Bonne Boite v2, ROME 4.0 - Metiers and, for the tension score, Marché du travail) if you want your own API quota." }, "franceTravailClientSecret": { "title": "Your France Travail client secret (optional)", "type": "string", "description": "Optional, goes with the client ID. Stored encrypted by Apify and never logged or written to the output." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }