{ "openapi": "3.0.1", "info": { "title": "BambooHR Jobs API - Career Page Scraper for Small Employers", "description": "BambooHR jobs API and career page scraper. Read live postings from any BambooHR career site, or search thousands of known BambooHR employers in one run. Titles, locations, departments and direct apply links as JSON. Skews to small and mid-sized employers that large aggregators miss.", "version": "0.1", "x-build-id": "Q3qxNd8be0JWdeoXu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/starbright_overlap~bamboohr-jobs-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-starbright_overlap-bamboohr-jobs-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/starbright_overlap~bamboohr-jobs-scraper/runs": { "post": { "operationId": "runs-sync-starbright_overlap-bamboohr-jobs-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/starbright_overlap~bamboohr-jobs-scraper/run-sync": { "post": { "operationId": "run-sync-starbright_overlap-bamboohr-jobs-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": { "keywords": { "title": "Job title keywords (any match)", "type": "array", "description": "Keep only jobs whose title contains at least one of these. Case-insensitive. Leave empty for every job.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Exclude titles containing", "type": "array", "description": "Drop jobs whose title contains any of these, e.g. `senior`, `intern`.", "items": { "type": "string" } }, "locations": { "title": "Locations (any match)", "type": "array", "description": "Keep only jobs whose location contains one of these, e.g. `london`, `new york`, `germany`.", "items": { "type": "string" } }, "remoteOnly": { "title": "Remote jobs only", "type": "boolean", "description": "Keep only postings flagged remote by the ATS or with a remote-looking location.", "default": false }, "postedWithinDays": { "title": "Posted within the last N days", "minimum": 1, "type": "integer", "description": "Freshness filter. Defaults to 90 days because some employers leave postings open for years — measured across the registry, 15% of Greenhouse and about half of the largest SmartRecruiters boards are over a year old. Set a large number such as 3650 to include everything. Postings with no publication date (most Workday rows) are always kept.", "default": 90 }, "companies": { "title": "Limit to specific companies", "type": "array", "description": "Board slugs, e.g. `lanesgroup`. Leave empty to search all 9,711 known bamboohr employers.", "items": { "type": "string" } }, "maxBoards": { "title": "Max company boards to scan", "minimum": 1, "type": "integer", "description": "Boards are scanned largest-first, so a capped run still returns the most jobs. Raise it to sweep all 9,711 boards.", "default": 300 }, "maxJobs": { "title": "Max jobs to return", "minimum": 1, "type": "integer", "description": "Hard cap on results, so a run costs what you expect. Defaults to 150, which costs well under a dollar so you can try the feed without spending your free credit on it. Clearing the box falls back to that, so type a large number such as 500000 to sweep everything.", "default": 150 }, "concurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 20, "type": "integer", "description": "Higher is faster but more likely to hit ATS rate limits.", "default": 8 }, "maxJobsPerCompany": { "title": "Max postings per company", "minimum": 1, "type": "integer", "description": "Keeps one huge employer from filling the whole run. Boards are scanned largest-first, so without this the first few boards use up the entire result budget. Raise it when you want depth on a few employers rather than breadth across many. Lower values spread a capped run across more employers rather than filling it from the largest board.", "default": 10 } } }, "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 } } } } } } } } } }