{ "openapi": "3.0.1", "info": { "title": "Ashby Jobs Scraper API", "description": "Job postings from public Ashby job boards (jobs.ashbyhq.com) through Ashby's public Job Postings API. Title, location, department, employment type, pay summary, posting date and clean job descriptions, with recruiter contacts removed.", "version": "0.1", "x-build-id": "hNbf9BbEVGlthJBFR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kman-br~ashby-jobs/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kman-br-ashby-jobs", "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/kman-br~ashby-jobs/runs": { "post": { "operationId": "runs-sync-kman-br-ashby-jobs", "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/kman-br~ashby-jobs/run-sync": { "post": { "operationId": "run-sync-kman-br-ashby-jobs", "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": [ "organizations" ], "properties": { "organizations": { "title": "Job board organizations", "type": "array", "description": "Ashby job board slugs or URLs, for example ramp or https://jobs.ashbyhq.com/ramp. A job URL such as https://jobs.ashbyhq.com/ramp/ also works. Only jobs.ashbyhq.com is accepted. Maximum 50 per run.", "items": { "type": "string" } }, "searchText": { "title": "Search text", "type": "string", "description": "Case- and accent-insensitive text that must appear in the job title or description, for example \"engineer\". Leave empty for all jobs." }, "maxItems": { "title": "Maximum jobs", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of job items charged in the run. The hard cap is 1000, enforced in the code.", "default": 50 }, "includeDescription": { "title": "Include description", "type": "boolean", "description": "Adds each job's description as clean text and as HTML. Turn off for a lighter run with the job fields only. Search text still reads the description when this is off.", "default": true }, "includeCompensation": { "title": "Include compensation", "type": "boolean", "description": "Adds the compensation summary strings that Ashby publishes for each job, when the board publishes them.", "default": true }, "remoteOnly": { "title": "Remote jobs only", "type": "boolean", "description": "Keeps only jobs that Ashby flags as remote (isRemote).", "default": false }, "employmentType": { "title": "Employment type", "enum": [ "FullTime", "PartTime", "Intern", "Contract", "Temporary" ], "type": "string", "description": "Keeps only jobs with this employment type as Ashby publishes it. Leave empty for all types." }, "departmentContains": { "title": "Department contains", "type": "string", "description": "Case- and accent-insensitive text that must appear in the job department." }, "postedWithinDays": { "title": "Posted within days", "minimum": 0, "type": "integer", "description": "Keeps only jobs published within this many days, counted from Ashby's publishedAt date (whole days). Jobs without a readable publishedAt are dropped when this filter is set." }, "locationContains": { "title": "Location contains", "type": "string", "description": "Case- and accent-insensitive text that must appear in the job location or in any of its secondary locations." } } }, "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 } } } } } } } } } }