{ "openapi": "3.0.1", "info": { "title": "Personio Jobs Scraper — Company Job Boards", "description": "Every open position on any company's Personio job page as structured data: title, company, department, offices, employment type, pay where stated, date created, full text on request in the language you choose. One request per board. Incremental mode charges only for what changed. No personal data.", "version": "0.1", "x-build-id": "LNP6krN3a4dr9s9vB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/adderleydata~personio-jobs-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-adderleydata-personio-jobs-scraper", "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/adderleydata~personio-jobs-scraper/runs": { "post": { "operationId": "runs-sync-adderleydata-personio-jobs-scraper", "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/adderleydata~personio-jobs-scraper/run-sync": { "post": { "operationId": "run-sync-adderleydata-personio-jobs-scraper", "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": [ "boards" ], "properties": { "boards": { "title": "Job boards", "type": "array", "description": "One entry per company: its Personio name (in https://acme.jobs.personio.de it is \"acme\"), or any link on that page — the job page itself, one of its jobs, or the XML feed. Links on acme.jobs.personio.com work too, and rows then link to that host. A company that shows its jobs on its own domain (careers.example.com) still has a Personio name, and that name is needed: the company's own domain does not say which Personio account is behind it. Up to 500 boards per run; each is one request.", "items": { "type": "string" } }, "language": { "title": "Language", "pattern": "^[a-zA-Z]{2}$", "type": "string", "description": "The language the job text is read in, as a two-letter code: \"en\" for English, \"de\" for German, and so on. Personio keeps each job's text per language and returns no text for a job not written in the language asked for; titles, offices and the other facts come back either way. English by default.", "default": "en" }, "keywords": { "title": "Title keywords", "type": "array", "description": "Keep jobs whose title contains every word of any keyword, in any order — \"engineer data\" matches \"Senior Data Engineer\". Leave empty for all titles.", "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "Keep jobs with an office whose name contains this text (\"Munich\", \"Remote\"), or open in this country where an office's name states it (\"Spain\" for \"Hybrid - Barcelona, Spain\"). Every office a job lists counts. Leave empty for all locations.", "items": { "type": "string" } }, "departments": { "title": "Departments", "type": "array", "description": "Keep jobs whose department contains this text, e.g. \"Engineering\". Leave empty for all departments.", "items": { "type": "string" } }, "postedWithinDays": { "title": "Created within (days)", "minimum": 1, "maximum": 365, "type": "integer", "description": "Keep jobs created on Personio in the last N days. Leave empty for any time." }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 50000, "type": "integer", "description": "The run stops once this many jobs are saved. You are charged per job saved, so this is also your cost cap.", "default": 100 }, "includeDescription": { "title": "Include full descriptions", "type": "boolean", "description": "On: the full job text — each section of it under its own heading — comes back with each row, read from the same request as the listing, so it costs no extra requests. Off: listing fields only.", "default": false }, "descriptionFormat": { "title": "Description format", "enum": [ "text", "text_and_html" ], "type": "string", "description": "Plain text, or plain text plus sanitised HTML.", "default": "text" }, "redactContacts": { "title": "Redact contact details in descriptions", "type": "boolean", "description": "On by default: email addresses and phone numbers inside description text are replaced with [redacted]. A section Personio headed as the contact person is never included, under any setting, and this Actor never outputs recruiter names or contact fields.", "default": true }, "incremental": { "title": "Incremental mode", "type": "boolean", "description": "Remember what earlier runs saw and save only jobs that are new, changed or gone. Unchanged jobs are skipped and not charged. Put the Actor on a schedule with this on.", "default": false }, "stateKey": { "title": "State key", "type": "string", "description": "Optional name for this monitor, e.g. \"competitor-engineering\". Runs with the same key share memory. Left empty, a key is derived from the boards, the language and the filters themselves." }, "emitExpired": { "title": "Report expired jobs", "type": "boolean", "description": "Incremental mode only. When a complete run no longer finds a job it saw before, save one row with changeType EXPIRED.", "default": true }, "emitUnchanged": { "title": "Also save unchanged jobs", "type": "boolean", "description": "Incremental mode only. Saves (and charges for) every job, labelled UNCHANGED where nothing moved.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy, automatic group, is the default and is what this Actor is tested with.", "default": { "useApifyProxy": true } }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Parallel requests. The default is deliberately modest.", "default": 4 }, "maxRequestsPerMinute": { "title": "Maximum requests per minute", "minimum": 6, "maximum": 240, "type": "integer", "description": "An upper bound on request rate across the whole run.", "default": 90 } } }, "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 } } } } } } } } } }