{"openapi":"3.1.0","info":{"title":"Indeed API (Bowmark)","version":"e833508f87ff","description":"Job search on the US's largest job board — listings with salary, location and posted-date, straight off Indeed's own search results.\n\nEvery function Bowmark has for Indeed (indeed.com) as one HTTP call. Each runs on Bowmark's infrastructure with the same billing, rules and response envelope as `POST /v1/run`. The whole API: https://api.bowmark.ai/openapi.json. Guide: https://bowmark.ai/docs/api.","contact":{"email":"support@bowmark.ai","url":"https://bowmark.ai/docs/api"}},"servers":[{"url":"https://api.bowmark.ai"}],"security":[{"bearer":[]},{"apiKeyHeader":[]}],"paths":{"/v1/sites/indeed/searchJobs":{"post":{"operationId":"searchJobs","summary":"Runs Indeed's own job search and returns each listing's title, company, location, extracted salary (when the card carries one) and posted-date, off the site's own results page.","description":"Runs Indeed's own job search and returns each listing's title, company, location, extracted salary (when the card carries one) and posted-date, off the site's own results page. `location` is optional free text (e.g. \"New York, NY\", \"Remote\"); omitting it searches everywhere. `salary` is null when Indeed's own listing carries none — that is the site's answer, not a gap.\n\nCalls `bowmark.providers.indeed.searchJobs`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IndeedJobResult[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/IndeedSearchJobsArgs","description":"TypeScript: `IndeedSearchJobsArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/indeed/getJobDetails":{"post":{"operationId":"getJobDetails","summary":"Fetches one job listing's full details: title, company, location, salary (when the listing carries one), posted-date, job type and the full description as plain text.","description":"Fetches one job listing's full details: title, company, location, salary (when the listing carries one), posted-date, job type and the full description as plain text. Takes a job URL from searchJobs (or the bare job key). `experienceLevel` is null — Indeed's logged-out listing carries none. Throws, caller-fixable, when Indeed has no live listing for the key (filled or expired).\n\nCalls `bowmark.providers.indeed.getJobDetails`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IndeedJobDetails>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/GetJobDetailsArgs","description":"TypeScript: `GetJobDetailsArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/indeed/searchCompanies":{"post":{"operationId":"searchCompanies","summary":"Searches Indeed's own company directory by name or keyword and returns each match's rating, review count, sectors and its own `/cmp/…` page URLs (jobs, reviews, salaries), off the site's own results p","description":"Searches Indeed's own company directory by name or keyword and returns each match's rating, review count, sectors and its own `/cmp/…` page URLs (jobs, reviews, salaries), off the site's own results page. `sectors` is `[]` when the site's own card carries none.\n\nCalls `bowmark.providers.indeed.searchCompanies`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IndeedCompanyResult[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/IndeedSearchCompaniesArgs","description":"TypeScript: `IndeedSearchCompaniesArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/indeed/getCompanyDetails":{"post":{"operationId":"getCompanyDetails","summary":"Fetches a company's full profile off its own `/cmp/…` snapshot page: overall rating, review count, the site's five review-category scores, description, industry, founding year, headcount band, headqua","description":"Fetches a company's full profile off its own `/cmp/…` snapshot page: overall rating, review count, the site's five review-category scores, description, industry, founding year, headcount band, headquarters, website and CEO name. Takes a company URL (from searchCompanies' companyUrl field). Any field is null when the site's own profile carries none.\n\nCalls `bowmark.providers.indeed.getCompanyDetails`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IndeedCompanyDetails>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/GetCompanyDetailsArgs","description":"TypeScript: `GetCompanyDetailsArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/indeed/searchSalaries":{"post":{"operationId":"searchSalaries","summary":"Searches Indeed's own salary data by job title and location, returning salary ranges and the number of salary reports that contributed to each range, off the site's own /salaries page.","description":"Searches Indeed's own salary data by job title and location, returning salary ranges and the number of salary reports that contributed to each range, off the site's own /salaries page. `location` is optional free text; omitting it searches everywhere.\n\nCalls `bowmark.providers.indeed.searchSalaries`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IndeedSalarySearchResult[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/IndeedSearchSalariesArgs","description":"TypeScript: `IndeedSearchSalariesArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/indeed/getSalaryDetails":{"post":{"operationId":"getSalaryDetails","summary":"Fetches the full salary breakdown for one job title off its own `/career/<title>/salaries[/<location>]` page: pay-period estimates (min/median/max/mean) for the queried title+location AND nationally, ","description":"Fetches the full salary breakdown for one job title off its own `/career/<title>/salaries[/<location>]` page: pay-period estimates (min/median/max/mean) for the queried title+location AND nationally, the site's own top-paid cities, top-paying companies and related titles. `location` is optional free text; omitting it returns the national estimate. Throws when Indeed has no salary model for the title at all.\n\nCalls `bowmark.providers.indeed.getSalaryDetails`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<IndeedSalaryDetails>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/GetSalaryDetailsArgs","description":"TypeScript: `GetSalaryDetailsArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Your Bowmark API key."},"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-Bowmark-Key"}},"responses":{"NotFound":{"description":"No such site or function.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}},"schemas":{"RunEnvelope":{"type":"object","description":"What a run returns. `status` says whether the SCRIPT succeeded. A script that threw or paused for a login is still HTTP 200. Branch on `status`, not on the HTTP code.","required":["ok","status","result","logs","error","ms"],"properties":{"runId":{"type":"string","description":"Stable id for this run. Quote it in a support or `report` message."},"ok":{"type":"boolean","description":"False only when the run produced nothing usable."},"status":{"type":"string","enum":["ok","error","partial","needs_user"],"description":"`partial`: the result is real but some calls failed (see `incomplete`); `ok` stays true. `needs_user`: a person must sign in to a site first. Relay `meta.handoff.url` to them, then run again."},"egress":{"type":"string","enum":["default","link"],"description":"The egress the run was given, present only when the request asked for one. `link`: every request went through the caller's own Chrome (Bowmark Buddy)."},"result":{"description":"Whatever the script `return`ed. Any JSON value."},"logs":{"type":"array","items":{"type":"string"},"description":"Lines the script wrote with `log(...)`."},"error":{"type":["string","null"],"description":"Why the run failed, in plain words. Null on success."},"ms":{"type":"integer","description":"How long the script itself ran, in milliseconds."},"queuedMs":{"type":"integer","description":"How long the run waited for a worker before starting. Present only when it was a second or more."},"needs":{"type":"array","description":"The sign-ins this script is waiting on. Present when `status` is `needs_user`.","items":{"type":"object","required":["capability","provider","providerTitle","kind"],"properties":{"capability":{"type":"string"},"provider":{"type":"string"},"providerTitle":{"type":"string","description":"The site's name, to show a person."},"kind":{"type":"string"}}}},"incomplete":{"type":"object","description":"Present only when `status` is `partial`: which calls did not answer.","properties":{"summary":{"type":"string"},"totalCalls":{"type":"integer"}},"additionalProperties":true},"emptyHanded":{"type":"object","description":"Present when the script returned nothing while its calls returned rows, usually a filter that matched none of the site's own labels. Lists the label values the calls actually returned.","additionalProperties":true},"notes":{"type":"array","description":"Caveats a call attached to a complete answer. Never changes `status`.","items":{"type":"object","properties":{"path":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}}}}},"meta":{"type":"object","properties":{"handoff":{"type":"object","description":"A single-use sign-in link for a person to open. Expires at `expiresAt`.","properties":{"ref":{"type":"string"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}}},"concurrency":{"type":"object","description":"On a 429: how many runs are in flight and when to retry.","properties":{"limit":{"type":"integer"},"inFlight":{"type":"integer"},"retryAfterSeconds":{"type":"integer"}}}},"additionalProperties":true},"notice":{"type":"object","description":"Set when the account owner has not accepted the current Terms. Relay it to them.","additionalProperties":true}}},"GetCompanyDetailsArgs":{"type":"object","properties":{"url":{"type":"string"}},"required":["url"],"additionalProperties":true},"GetJobDetailsArgs":{"type":"object","properties":{"url":{"type":"string"}},"required":["url"],"additionalProperties":true},"GetSalaryDetailsArgs":{"type":"object","properties":{"query":{"type":"string"},"location":{"type":"string"}},"required":["query"],"additionalProperties":true},"IndeedSearchCompaniesArgs":{"type":"object","properties":{"query":{"type":"string"}},"required":["query"],"additionalProperties":true},"IndeedSearchJobsArgs":{"type":"object","properties":{"query":{"type":"string"},"location":{"type":"string"}},"required":["query"],"additionalProperties":true},"IndeedSearchSalariesArgs":{"type":"object","properties":{"query":{"type":"string"},"location":{"type":"string"}},"required":["query"],"additionalProperties":true}}}}