{ "openapi": "3.0.1", "info": { "title": "GCC Jobs API - Direct Employers, ATS, Visa Signals & Alerts", "description": "Search direct employer career sites across the GCC. Get canonical apply links, normalized hiring requirements, evidence-backed GCC signals, deduplication, and incremental monitoring.", "version": "0.1", "x-build-id": "UbYdEzVM6htpUVww3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fetchfinch~gcc-jobs-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fetchfinch-gcc-jobs-intelligence", "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/fetchfinch~gcc-jobs-intelligence/runs": { "post": { "operationId": "runs-sync-fetchfinch-gcc-jobs-intelligence", "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/fetchfinch~gcc-jobs-intelligence/run-sync": { "post": { "operationId": "run-sync-fetchfinch-gcc-jobs-intelligence", "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": [ "countries", "sources" ], "properties": { "keywords": { "title": "Job keywords", "type": "array", "description": "Keep jobs matching any phrase in the title or description. Leave empty for all roles.", "default": [], "items": { "type": "string" } }, "countries": { "title": "GCC countries", "type": "array", "description": "One or more GCC countries. Structured ISO locations take precedence over text matching.", "items": { "type": "string", "enum": [ "AE", "SA", "QA", "KW", "BH", "OM" ], "enumTitles": [ "United Arab Emirates", "Saudi Arabia", "Qatar", "Kuwait", "Bahrain", "Oman" ] }, "default": [ "AE", "SA", "QA", "KW", "BH", "OM" ] }, "cities": { "title": "Cities", "type": "array", "description": "Optional city filter, for example Dubai, Abu Dhabi, Riyadh, or Doha.", "default": [], "items": { "type": "string" } }, "sources": { "title": "ATS providers", "type": "array", "description": "Verified public job-posting APIs to query.", "items": { "type": "string", "enum": [ "greenhouse", "lever", "ashby", "smartrecruiters" ], "enumTitles": [ "Greenhouse", "Lever", "Ashby", "SmartRecruiters" ] }, "default": [ "greenhouse", "lever", "ashby", "smartrecruiters" ] }, "employers": { "title": "Registry employers", "type": "array", "description": "Optional employer keys from the maintained registry. Empty means every compatible registry employer.", "default": [], "items": { "type": "string" } }, "careerUrls": { "title": "Additional career URLs", "type": "array", "description": "Greenhouse, Lever, Ashby, or SmartRecruiters board/job URLs. The Actor detects the provider and board token.", "default": [], "items": { "type": "string" } }, "postedWithinDays": { "title": "Posted within days", "minimum": 0, "maximum": 3650, "type": "integer", "description": "Keep jobs published within this many days. Set 0 to disable the date filter.", "default": 0 }, "includeKeywords": { "title": "Required keywords", "type": "array", "description": "Require at least one phrase in the title or description.", "default": [], "items": { "type": "string" } }, "excludeKeywords": { "title": "Excluded keywords", "type": "array", "description": "Drop jobs containing any phrase in the title or description.", "default": [], "items": { "type": "string" } }, "workplaceTypes": { "title": "Workplace types", "type": "array", "description": "Optional on-site, hybrid, or remote filter. Unknown values are excluded when this filter is set.", "items": { "type": "string", "enum": [ "onsite", "hybrid", "remote" ] }, "default": [] }, "employmentTypes": { "title": "Employment types", "type": "array", "description": "Optional normalized employment-type filter. Unknown source values are excluded when this filter is set.", "items": { "type": "string", "enum": [ "full_time", "part_time", "contract", "temporary", "internship", "other" ] }, "default": [] }, "includeDetails": { "title": "Include descriptions and evidence", "type": "boolean", "description": "Fetch or retain full job descriptions where the public source provides them.", "default": true }, "outputMode": { "title": "Output detail", "enum": [ "standard", "compact", "raw" ], "type": "string", "description": "Standard returns normalized details and evidence; compact is optimized for MCP and LLM contexts; raw also retains source payloads.", "default": "standard" }, "maxResults": { "title": "Maximum emitted jobs", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Hard cap on billable dataset rows across the run.", "default": 1000 }, "maxResultsPerSource": { "title": "Maximum fetched jobs per employer source", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Safety cap per employer board. Reaching it marks that board partial and disables expiry detection for it.", "default": 500 }, "monitorMode": { "title": "Incremental monitoring", "type": "boolean", "description": "Persist state and classify jobs as new, updated, reappeared, unchanged, or expired.", "default": false }, "stateKey": { "title": "Monitor state key", "type": "string", "description": "Stable name for this watchlist. Query filters are fingerprinted automatically to prevent collisions.", "default": "default" }, "changeTypes": { "title": "Changes to emit", "type": "array", "description": "Choose which monitoring events become billable dataset rows.", "items": { "type": "string", "enum": [ "NEW", "UPDATED", "REAPPEARED", "EXPIRED", "UNCHANGED" ] }, "default": [ "NEW", "UPDATED", "REAPPEARED", "EXPIRED" ] }, "baselineMode": { "title": "First monitor run", "enum": [ "emit", "state_only" ], "type": "string", "description": "Emit returns the initial snapshot. State only creates a free baseline with no dataset rows.", "default": "emit" }, "missingRunsBeforeExpiry": { "title": "Successful absences before expiry", "minimum": 1, "maximum": 10, "type": "integer", "description": "A job is expired only after this many complete, successful source runs no longer contain it.", "default": 2 }, "requestTimeoutSecs": { "title": "Request timeout", "minimum": 5, "maximum": 120, "type": "integer", "description": "Timeout for an individual public API request.", "default": 30 }, "maxConcurrency": { "title": "Maximum request concurrency", "minimum": 1, "maximum": 25, "type": "integer", "description": "Maximum number of simultaneous job-detail requests within a source.", "default": 8 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional proxy. Public ATS APIs normally work without one.", "default": { "useApifyProxy": 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 } } } } } } } } } }