{ "openapi": "3.0.1", "info": { "title": "ATS Job Monitor — Track New, Closed & Changed Jobs", "description": "Job alerts from company career pages: new, closed and edited roles since your last run. Recruiting and hiring signals without re-downloading the board.", "version": "0.1", "x-build-id": "5mjbNiOt3Q2JQwFqT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dev_web_col~ats-job-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dev_web_col-ats-job-monitor", "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/dev_web_col~ats-job-monitor/runs": { "post": { "operationId": "runs-sync-dev_web_col-ats-job-monitor", "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/dev_web_col~ats-job-monitor/run-sync": { "post": { "operationId": "run-sync-dev_web_col-ats-job-monitor", "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": { "oneShot": { "title": "One-shot mode (no history)", "type": "boolean", "description": "Return the CURRENT jobs instead of what changed. Use this for a single lookup or when calling from an AI agent — the monitor needs two runs to have anything to compare, one-shot answers immediately. It never touches your saved history.", "default": false }, "monitorKey": { "title": "Monitor name", "type": "string", "description": "Keep this the same across runs — it is how the actor remembers what it already saw. Use a different name to run several independent monitors (e.g. \"engineering\" and \"sales\").", "default": "default" }, "searchKeyword": { "title": "Job title keyword", "type": "string", "description": "Only watch jobs whose title contains this, e.g. \"backend engineer\". Leave empty to watch every job." }, "searchScope": { "title": "Where to search", "enum": [ "title", "title_and_description" ], "type": "string", "description": "Job title only is precise. Adding the description finds more, but also matches jobs that merely mention the keyword.", "default": "title" }, "trackChangeTypes": { "title": "What to report", "type": "array", "description": "Leave empty to get all three. New = a role just opened. Closed = it is gone, usually filled or cancelled. Modified = title, location, salary, department or employment type changed.", "items": { "type": "string", "enum": [ "new", "closed", "modified" ], "enumTitles": [ "New jobs", "Closed jobs", "Modified jobs" ] }, "default": [] }, "location": { "title": "Location contains", "type": "string", "description": "Free text match against the job location, e.g. \"New York\", \"London\", \"Germany\"." }, "remoteOnly": { "title": "Remote jobs only", "type": "boolean", "description": "Only watch jobs the company flags as remote.", "default": false }, "department": { "title": "Department contains", "type": "string", "description": "Free text match against the department or team, e.g. \"Engineering\", \"Sales\"." }, "atsPlatforms": { "title": "ATS platforms", "type": "array", "description": "Leave empty to watch all of them.", "items": { "type": "string", "enum": [ "greenhouse", "lever", "ashby", "workable" ], "enumTitles": [ "Greenhouse", "Lever", "Ashby", "Workable" ] }, "default": [] }, "companyTokens": { "title": "Specific companies (optional)", "type": "array", "description": "Only if you want to watch specific companies instead of the built-in index of 872 companies. Accepts \"greenhouse:stripe\" or a job board URL.", "default": [], "items": { "type": "string" } }, "maxCompanies": { "title": "Max companies to watch", "minimum": 1, "type": "integer", "description": "Keep this stable across runs. Changing it changes which companies are watched, which shows up as a burst of new and closed jobs.", "default": 200 }, "maxChanges": { "title": "Max changes to return", "minimum": 1, "type": "integer", "description": "Safety cap. You are charged per change returned.", "default": 5000 }, "resetBaseline": { "title": "Reset and start over", "type": "boolean", "description": "Forget everything seen before and take a fresh baseline. The baseline run is never charged per result.", "default": false } } }, "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 } } } } } } } } } }