{ "openapi": "3.0.1", "info": { "title": "Unified ATS API Ashby, Breezy HR & Workable", "description": "Access multiple Applicant Tracking Systems through one unified interface. Search jobs, candidates, applications, interviews, and hiring metrics across Ashby, Breezy HR, and Workable with a single actor.", "version": "1.0", "x-build-id": "GaqLlSs0t9IoVckhr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~unified-ats-api-ashby-breezy-hr-workable/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-unified-ats-api-ashby-breezy-hr-workable", "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/alizarin_refrigerator-owner~unified-ats-api-ashby-breezy-hr-workable/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-unified-ats-api-ashby-breezy-hr-workable", "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/alizarin_refrigerator-owner~unified-ats-api-ashby-breezy-hr-workable/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-unified-ats-api-ashby-breezy-hr-workable", "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": [ "platform", "task" ], "properties": { "platform": { "title": "ATS Platform", "enum": [ "ashby", "breezy", "workable" ], "type": "string", "description": "Select which Applicant Tracking System to query", "default": "ashby" }, "task": { "title": "Task", "enum": [ "list_jobs", "get_job", "search_jobs", "list_candidates", "get_candidate", "search_candidates", "list_applications", "get_application", "list_interviews", "list_offers", "list_departments", "list_locations", "list_stages", "list_users", "get_company", "list_activities", "get_hiring_metrics", "export_candidates" ], "type": "string", "description": "The operation to perform on the selected ATS platform", "default": "list_jobs" }, "jobId": { "title": "Job ID", "type": "string", "description": "Job ID for operations requiring a specific job (get_job, list_applications)" }, "candidateId": { "title": "Candidate ID", "type": "string", "description": "Candidate ID for operations requiring a specific candidate (get_candidate)" }, "applicationId": { "title": "Application ID", "type": "string", "description": "Application ID for get_application task" }, "query": { "title": "Search Query", "type": "string", "description": "Search term for search_jobs or search_candidates tasks" }, "status": { "title": "Status Filter", "type": "string", "description": "Filter by status (e.g., 'open', 'closed', 'draft' for jobs; 'active', 'hired', 'rejected' for candidates)" }, "departmentId": { "title": "Department ID", "type": "string", "description": "Filter by department ID" }, "locationId": { "title": "Location ID", "type": "string", "description": "Filter by location ID" }, "limit": { "title": "Limit", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of results to return", "default": 50 }, "offset": { "title": "Offset", "type": "integer", "description": "Results offset for pagination", "default": 0 }, "apiKey": { "title": "API Key", "type": "string", "description": "Your ATS platform API key. Required for production use." }, "apiSecret": { "title": "API Secret (Ashby only)", "type": "string", "description": "API secret for Ashby (used with HTTP Basic Auth). Leave empty for other platforms." }, "subdomain": { "title": "Account Subdomain (Workable/Breezy)", "type": "string", "description": "Your account subdomain (e.g., 'yourcompany' from yourcompany.workable.com)" }, "companyId": { "title": "Company ID (Breezy only)", "type": "string", "description": "Breezy HR company ID for API requests" }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "URL to receive results via webhook for automation platforms" }, "demoMode": { "title": "Demo Mode", "type": "boolean", "description": "Run with sample data for testing (no API calls made)", "default": true } } }, "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 } } } } } } } } } }