/usajobs/jobs/search

POST /api/usajobs/jobs/search

Price: 5 credits

Search open US federal government job announcements on USAJOBS by keyword, location and the full set of site filters: radius, exact job titles, salary range, pay plan, hiring path (who can apply), appointment type, supervisory status, work schedule, travel percentage, security clearance, occupational series, cyber workforce role and grouping, department and agency (include or exclude), and remote/telework work site. Results can be ordered by relevance, posting date, closing date or salary. Each item carries the control number (id), announcement number, title, URL, department/agency/sub-agency, salary, locations, schedule, appointment type, pay scale and grade range, relocation flag, open period, posting and closing timestamps, hiring paths and occupational series.

How to use it

Search USAJOBS — the official job board for US federal government vacancies. Filters: keyword, location (+radius in miles), job_title, min_salary/max_salary, pay_plan (GS, FV, WG…), hiring_path (public, vet, mspouse, student, ses, disability, native and more — this is the 'who can apply' eligibility), appointment_type (permanent, temporary, term, internships, seasonal…), is_supervisory, work_schedule (full-time, part-time, shift work…), travel_percentage, security_clearance, job_series (4-digit occupational series such as 2210 for IT management or 0801 for general engineering), cyber_work_role, department and agency codes with exclude_organizations to invert them, work_site (remote or telework), and sort_by. Department, agency and series codes can be looked up with the USAJOBS agencies endpoint. count is how many jobs to return. Each result exposes id — the 9-digit control number; pass it to the USAJOBS job get-by-id endpoint for the full announcement with duties, qualifications, benefits and contacts.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string nullable — Job title, occupation or keyword to search for (examples: "engineer")
• location string nullable — City, state, ZIP code or country to search in (examples: "New York, New York")
• radius string nullable — Search radius in miles around the location (one of: "5", "10", "25", "50", "100")
• job_title array nullable — Restrict results to these exact job titles
• min_salary integer nullable — Minimum yearly salary in USD (min: 0)
• max_salary integer nullable — Maximum yearly salary in USD (min: 0)
• pay_plan array nullable — Federal pay plan codes the position is paid under (examples: ["GS","FV"])
• hiring_path array nullable — Who is eligible to apply (multi-select) (one of: "public", "fed-competitive", "fed-excepted", "fed-internal-search", "fed-transition", "land", "vet", "mspouse", "nguard", "student", "graduates", "ses", "disability", "overseas", "native", "peace", "special-authorities")
• appointment_type array nullable — Type of appointment offered (multi-select) (one of: "15320", "15522", "15328", "15327", "15317", "15326", "15322", "15323", "15318", "15321", "15319")
• is_supervisory boolean nullable — Only supervisory positions
• work_schedule array nullable — Work schedule of the position (multi-select) (one of: "1", "2", "3", "4", "5", "6")
• travel_percentage array nullable — How much travel is required (multi-select) (one of: "0", "1", "2", "5", "7", "8")
• security_clearance array nullable — Required security clearance level (multi-select) (one of: "0", "1", "2", "3", "4", "5", "7", "8")
• job_series array nullable — Four-digit federal occupational series codes (examples: ["0801","2210"])
• cyber_work_role array nullable — Cyber workforce role codes (examples: ["422"])
• cyber_work_grouping array nullable — Cyber workforce grouping codes (examples: ["1"])
• department array nullable — Department codes to filter by (examples: ["VA","AR"])
• agency array nullable — Agency codes to filter by (examples: ["VATA","ARCE"])
• exclude_organizations boolean — Exclude the given departments and agencies instead of restricting to them (default: false)
• work_site string nullable — Restrict to remote or telework-eligible jobs (one of: "remote", "telework")
• sort_by string — Ordering of the results (default: "relevance"; one of: "relevance", "recently_posted", "closing_soon", "highest_salary", "lowest_salary")
• count integer required — Max number of jobs to return (min: 1)

Response

• @type string (default: "UsajobsJobSearchResult")
• id string required
• announcement_number string nullable
• job_title string nullable
• url string nullable
• department string nullable
• agency string nullable
• sub_agency string nullable
• salary_display string nullable
• salary_min number nullable
• location string nullable
• location_display string nullable
• location_name string nullable
• location_count integer nullable
• work_schedule string nullable
• appointment_type string nullable
• pay_scale string nullable
• low_grade string nullable
• high_grade string nullable
• is_relocation_reimbursed boolean nullable
• announcement_closing_type string nullable
• announcement_closing_option string nullable
• open_period_display string nullable
• posted_display string nullable
• starts_at integer nullable
• ends_at integer nullable
• hiring_paths array (default: [])
  • @type string (default: "UsajobsJobHiringPath")
  • code string required
  • name string nullable
  • description string nullable
• job_series array (default: [])
  • @type string (default: "UsajobsJobSeries")
  • code string required
  • name string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.