{ "openapi": "3.0.1", "info": { "title": "BambooHR Jobs Scraper — Company Job Boards", "description": "Every open role on any company's BambooHR careers site as structured data: title, department, location with country, on-site, hybrid or remote, employment type, posted date, pay where stated, full text on request. Incremental mode charges only for what changed. No personal data.", "version": "0.1", "x-build-id": "HeVsfJdfcxQL73gcA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/adderleydata~bamboohr-jobs-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-adderleydata-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/adderleydata~bamboohr-jobs-scraper/runs": { "post": { "operationId": "runs-sync-adderleydata-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/adderleydata~bamboohr-jobs-scraper/run-sync": { "post": { "operationId": "run-sync-adderleydata-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", "required": [ "boards" ], "properties": { "boards": { "title": "Job boards", "type": "array", "description": "One entry per company: its BambooHR name (in https://acme.bamboohr.com/careers it is \"acme\"), or any link on that address — the careers site, one of its job openings, an older /jobs/ link or the job list a company embeds in its own website. A company's own website does not say which BambooHR name is behind it, so the bamboohr.com name is needed. Up to 500 boards per run; each is one request for its list of openings, plus one request per opening saved.", "items": { "type": "string" } }, "keywords": { "title": "Title keywords", "type": "array", "description": "Keep openings whose title contains every word of any keyword, in any order — \"engineer data\" matches \"Senior Data Engineer\". Leave empty for all titles.", "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "Keep openings whose city, state or province contains this text (\"Melbourne\", \"Ontario\"), in this country (\"Canada\", \"Australia\", \"AU\") where the board's list states it — for a remote opening, or through a US state, Canadian province or Australian state — or with this location type (\"Remote\", \"Hybrid\", \"On-site\"). An office entered with a city and no state is found by its city. Leave empty for all locations.", "items": { "type": "string" } }, "departments": { "title": "Departments", "type": "array", "description": "Keep openings whose department contains this text, e.g. \"Engineering\". Leave empty for all departments.", "items": { "type": "string" } }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 50000, "type": "integer", "description": "The run stops once this many openings are saved. You are charged per opening saved, so this is also your cost cap. Each opening saved is also one request for its details.", "default": 100 }, "includeDescription": { "title": "Include full descriptions", "type": "boolean", "description": "On: the opening's full text comes back with each row, from the request already made for the opening's details, so it costs no extra requests. Off: listing fields only.", "default": false }, "descriptionFormat": { "title": "Description format", "enum": [ "text", "text_and_html" ], "type": "string", "description": "Plain text, or plain text plus sanitised HTML.", "default": "text" }, "redactContacts": { "title": "Redact contact details in descriptions", "type": "boolean", "description": "On by default: email addresses and phone numbers inside description text are replaced with [redacted]. This Actor never outputs recruiter names or contact fields.", "default": true }, "incremental": { "title": "Incremental mode", "type": "boolean", "description": "Remember what earlier runs saw and save only openings that are new, changed or gone. Unchanged openings are skipped, not charged and cost no request for their details. Put the Actor on a schedule with this on.", "default": false }, "stateKey": { "title": "State key", "type": "string", "description": "Optional name for this monitor, e.g. \"competitor-engineering\". Runs with the same key share memory. Left empty, a key is derived from the boards and filters themselves." }, "emitExpired": { "title": "Report expired openings", "type": "boolean", "description": "Incremental mode only. When a complete run no longer finds an opening it saw before, save one row with changeType EXPIRED.", "default": true }, "emitUnchanged": { "title": "Also save unchanged openings", "type": "boolean", "description": "Incremental mode only. Saves (and charges for) every opening, labelled UNCHANGED where nothing moved.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy, automatic group, is the default and is what this Actor is tested with.", "default": { "useApifyProxy": true } }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Parallel requests. The default is deliberately modest.", "default": 4 }, "maxRequestsPerMinute": { "title": "Maximum requests per minute", "minimum": 6, "maximum": 240, "type": "integer", "description": "An upper bound on request rate across the whole run.", "default": 90 } } }, "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 } } } } } } } } } }