{
  "openapi": "3.0.1",
  "info": {
    "title": "ATS Job Scraper: Greenhouse, Lever, Ashby, Workable & More",
    "description": "Open jobs and hiring signals for any company from its domain. Auto-detects Greenhouse, Lever, Ashby, Workable, Recruitee and SmartRecruiters. Returns jobs, salary ranges, tech stack and a compact company summary, and flags NEW and CLOSED jobs since the last run. $0.05 per company found.",
    "version": "1.2",
    "x-build-id": "yqfHSpKynnS9au6GY"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/hirepulse~ats-job-pulse/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-hirepulse-ats-job-pulse",
        "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/hirepulse~ats-job-pulse/runs": {
      "post": {
        "operationId": "runs-sync-hirepulse-ats-job-pulse",
        "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/hirepulse~ats-job-pulse/run-sync": {
      "post": {
        "operationId": "run-sync-hirepulse-ats-job-pulse",
        "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": [
          "companies"
        ],
        "properties": {
          "companies": {
            "title": "Companies",
            "minItems": 1,
            "uniqueItems": true,
            "type": "array",
            "description": "Company website domains (e.g. \"stripe.com\") or job-board slugs (e.g. \"stripe\"). To force a specific ATS, prefix the slug: \"greenhouse:stripe\", \"lever:spotify\", \"ashby:linear\", \"workable:huggingface\", \"recruitee:bunq\", \"smartrecruiters:BoschGroup\". Each successfully processed company is charged once, regardless of how many jobs it has.",
            "items": {
              "type": "string"
            }
          },
          "output_mode": {
            "title": "What to return",
            "enum": [
              "jobs_and_summary",
              "summary_only",
              "jobs_only"
            ],
            "type": "string",
            "description": "\"jobs_and_summary\": one company_summary record per company followed by its job records. \"summary_only\": only the company_summary records (job counts, new/closed counts, departments, locations, technologies) — the smallest output, best for a quick hiring-signal check. \"jobs_only\": only job records.",
            "default": "jobs_and_summary"
          },
          "track_diff": {
            "title": "Track changes between runs",
            "type": "boolean",
            "description": "Compare with the previous run that used the same \"state_id\" and set each job's \"status\" to NEW, EXISTING or CLOSED. On the first run every job is NEW (the summary marks this with is_first_run = true). When off, every job has status ACTIVE and nothing is remembered.",
            "default": true
          },
          "state_id": {
            "title": "State ID",
            "type": "string",
            "description": "Name of the saved history used for change tracking. Runs that share a state_id are compared with each other. Use a different value per watchlist or per schedule.",
            "default": "default_state"
          },
          "extract_tech_keywords": {
            "title": "Extract technology keywords",
            "type": "boolean",
            "description": "Scan each job title and description for core technologies (Python, AWS, React, Kubernetes, LLMs, ...) and return them in \"detected_technologies\" and in the summary's \"top_technologies\".",
            "default": true
          },
          "only_changes": {
            "title": "Only new and closed jobs",
            "type": "boolean",
            "description": "Return only jobs whose status is NEW or CLOSED. Use it on scheduled runs to get just what changed since the last run.",
            "default": false
          },
          "title_keywords": {
            "title": "Job title contains",
            "uniqueItems": true,
            "type": "array",
            "description": "Return only jobs whose title contains at least one of these words or phrases (case-insensitive). Example: [\"engineer\", \"data scientist\"].",
            "items": {
              "type": "string"
            }
          },
          "departments": {
            "title": "Department contains",
            "uniqueItems": true,
            "type": "array",
            "description": "Return only jobs whose department contains at least one of these words (case-insensitive). Example: [\"engineering\", \"sales\"].",
            "items": {
              "type": "string"
            }
          },
          "locations": {
            "title": "Location contains",
            "uniqueItems": true,
            "type": "array",
            "description": "Return only jobs whose location contains at least one of these words (case-insensitive). Example: [\"london\", \"new york\", \"germany\"].",
            "items": {
              "type": "string"
            }
          },
          "technologies": {
            "title": "Mentions technology",
            "uniqueItems": true,
            "type": "array",
            "description": "Return only jobs that mention at least one of these technologies, using the names from \"detected_technologies\" (case-insensitive). Example: [\"Python\", \"Kubernetes\", \"LLMs\"].",
            "items": {
              "type": "string"
            }
          },
          "remote_only": {
            "title": "Remote jobs only",
            "type": "boolean",
            "description": "Return only jobs marked or described as remote.",
            "default": false
          },
          "max_jobs_per_company": {
            "title": "Max jobs per company",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum number of job records returned per company, after the other filters. 0 means no limit. When the limit cuts the list, NEW jobs are kept first, then CLOSED, then the rest. The summary's \"matching_jobs\" tells how many matched in total.",
            "default": 0
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}