One HelloWork offer: title, company and its page, location, contract, salary (or HelloWork's estimate), sector, publication date, job family, domain, region, department and city, tags, skills, the job description and the profile sought (HTML and text), benefits, recruitment steps and where to apply. Removed offers answer 404. Give id/url, or q to open the first current result of a search.
Every response includes credits_used: the credits this call cost.
Parameters
name
type
description
id
string
Offer id or its hellowork.com/fr-fr/emplois/<id>.html URL (url is accepted too).
q
string
Instead of id: keywords; opens the first current result of that search (all /hellowork/v1/search filters apply). Example: comptable
location
string
With q: city, department or region. Example: Paris
import os, requests
res = requests.get(
"https://api.api.sh/hellowork/v1/job",
params={},
headers={"x-api-key": os.environ["APISH_KEY"]},
timeout=120,
)
res.raise_for_status()
data = res.json()
const url = new URL("https://api.api.sh/hellowork/v1/job");
const res = await fetch(url, { headers: { "x-api-key": process.env.APISH_KEY } });
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const data = await res.json();
Response
A JSON object with the fields described above, plus raw (the source's own data), cached, fetched_at and credits_used. Errors return {"success": false, "error": "…"} with the HTTP status (see errors). A lookup that ran but found nothing (404) costs the price above; refused calls and errors on our side are free (what's charged).
The fastest way to see the full response is the playground: it runs this endpoint with your account and shows the exact JSON.