Company Job Openings
Lists a company's open roles from its public job board, with title, department, location, remote flag, employment type, posting date and link.
- Price per call
- 1 credit
- per successful call
- Price ceiling
- 1 credit
- every call, same price
- Failed calls
- Free
- retried automatically
- Billed
- Per call
- only on success
Endpoint
api.primaryapi.com/ v1/ run/ jobs. openingsAuth: API key with run or full access, or a dashboard session
Send the input below as a JSON body. The call is routed to a healthy upstream; if an attempt fails, it is retried automatically inside the same request and you pay only for the answer you get. To check an input and see the exact price without running anything, call POST /v1/quote/jobs.openings with the same body (free).
Example request
curl -sS -X POST "https://api.primaryapi.com/v1/run/jobs.openings" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"domain":"airtable.com"}'const res = await fetch('https://api.primaryapi.com/v1/run/jobs.openings', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.PRIMARYAPI_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
domain: 'airtable.com',
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.code}: ${body.error}`);
// found:false is a successful answer ("does not exist"), not an error
console.log(body.output.found ? body.output.data : body.output.reason, body.credits);import os
import requests
res = requests.post(
"https://api.primaryapi.com/v1/run/jobs.openings",
headers={"Authorization": f"Bearer {os.environ['PRIMARYAPI_API_KEY']}"},
json={
"domain": "airtable.com",
},
timeout=60,
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['code']}: {body['error']}")
# found=False is a successful answer ("does not exist"), not an error
print(body["output"]["data"] if body["output"]["found"] else body["output"]["reason"], body["credits"]){
"name": "run_api",
"arguments": {
"sku": "jobs.openings",
"input": {
"domain": "airtable.com"
}
}
}Price this exact input first (free)
curl -sS -X POST "https://api.primaryapi.com/v1/quote/jobs.openings" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"domain":"airtable.com"}'Returns credits (what the call is expected to cost) and maxCredits (the most it can cost, which is set aside while it runs). Invalid input fails here the same way it would on run.
Input
JSON body fields. Unknown fields are rejected with 400 invalid_input (never silently ignored). You may add the routing controls preferLatencyUnderMs and maxCredits to the same object.
domainstring- Company domain, e.g. "airtable.com". Its careers page is read to find the job board.max 2048 chars
boardstring- Job board token when you know it: the last part of the board URL (jobs.lever.co/<board>).pattern: ^[A-Za-z0-9][A-Za-z0-9._-]{0,99}$
atsenum- Job board platform of `board`. Without it every platform is tried with that token.one of: greenhouse, lever, ashby, workable, smartrecruiters, recruitee
departmentstring- Only roles whose department contains this text.max 100 chars
remoteOnlybooleandefaultfalse- Only roles marked remote.
limitintegerdefault100- Maximum number of results to return (1-500, default 100).1–500
Output
When output.found is true, output.data has these fields (a list under jobs, billed per item returned).
companystring | null- Company name the board publishes, when it does.
atsenum- one of: greenhouse, lever, ashby, workable, smartrecruiters, recruitee
boardstringboardUrlstring- Public careers board URL.
detectedViaenum- input: you gave board (+ ats). careers_page: linked from the company site. token_guess: a board named like the domain exists; check `company` before relying on it.one of: input, careers_page, token_guess
totalinteger- Open roles on the board that match the filters (before `limit`).
jobsobject[]- Newest first, then by title.
jobs[].idstring- The posting id on the job board.
jobs[].titlestringjobs[].departmentstring | nulljobs[].locationstring | null- Location as the board shows it ("Remote - US", "London, UK").
jobs[].remoteboolean | null- true when the board marks the role remote (or the location says so); null when unknown.
jobs[].employmentTypestring | null- full_time, part_time, contract, temporary, intern, or the board's own label; null when not published.
jobs[].postedAtstring | null- When the role was first published (ISO 8601), when the board says.
jobs[].urlstring | null- Public job page.
nextCursorstring | null
TypeScript type
/** output.data when output.found is true */
type JobsOpenings = {
/** Company name the board publishes, when it does. */
company: string | null;
ats: "greenhouse" | "lever" | "ashby" | "workable" | "smartrecruiters" | "recruitee";
board: string;
/** Public careers board URL. */
boardUrl: string;
/** input: you gave board (+ ats). careers_page: linked from the company site. token_guess: a board named like the domain exists; check `company` before relying on it. */
detectedVia: "input" | "careers_page" | "token_guess";
/** Open roles on the board that match the filters (before `limit`). */
total: number;
/** Newest first, then by title. */
jobs: {
/** The posting id on the job board. */
id: string;
title: string;
department: string | null;
/** Location as the board shows it ("Remote - US", "London, UK"). */
location: string | null;
/** true when the board marks the role remote (or the location says so); null when unknown. */
remote: boolean | null;
/** full_time, part_time, contract, temporary, intern, or the board's own label; null when not published. */
employmentType: string | null;
/** When the role was first published (ISO 8601), when the board says. */
postedAt: string | null;
/** Public job page. */
url: string | null;
}[];
nextCursor: string | null;
};If what you asked about does not exist, is private, or a search matches nothing, the call still succeeds: output.found is false, output.data is null and output.reason says why. Such misses are free unless the notes below say misses are billed, in which case a miss costs the price of one call.
Example response
Values are placeholders that follow the output schema (strings as "string", numbers as 0); credits shows what this call would cost at the usual price.
{
"output": {
"found": true,
"data": {
"company": "string",
"ats": "greenhouse",
"board": "string",
"boardUrl": "https://example.com",
"detectedVia": "input",
"total": 0,
"jobs": [
{
"id": "string",
"title": "string",
"department": "string",
"location": "string",
"remote": true,
"employmentType": "string",
"postedAt": "string",
"url": "https://example.com"
}
],
"nextCursor": null
}
},
"provider": "PrimaryAPI",
"credits": 1,
"items": 1,
"requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z",
"nextCursor": null
}Pricing and reliability
Calls go only to upstreams that are healthy right now. If an attempt fails, the call is retried automatically inside the same request; a failed attempt costs nothing, and a call never costs more than its quote’s maxCredits. Live figures below are measured on real traffic.
Success rate, uptime, latency and call counts are measured live from real traffic over 30 days and show “—” until there is data.
Errors
Errors are JSON { code, error, requestId } and are never charged. The ones to handle for this endpoint:
- invalid_inputThe request failed validation before anything ran.
- unauthorizedNo valid API key or session was presented.
- insufficient_balanceThe balance cannot cover the most this call could cost.
- key_limit_reachedThe key’s own spend limit is used up for the current window.
- trial_cap_reachedAn agent trial key has used its whole trial budget.
- forbiddenThe credential is valid but may not do this.
- not_foundThe thing addressed by the URL does not exist for you.
- idempotency_conflictThe
Idempotency-Keyis already bound to a different request. - rate_limitedToo many requests in the current window.
- all_sources_failedThe call could not be answered, even after automatic retries.
- service_unavailableThis API cannot run in this deployment right now.
- timeoutThe request passed its deadline before it finished.
Notes
Pass `domain`, or `board` (with `ats` when known). A company without a public board on a supported platform is a free miss (reason board_not_found); a board with no open roles is a free miss (reason no_openings). Sorted newest first with no fetch timestamps, so a monitor fires when a role opens or closes.
Generated from the PrimaryAPI catalog. Machine-readable contract: GET https://api.primaryapi.com/v1/apis/jobs.openings.