/usajobs/agencies/search

POST /api/usajobs/agencies/search

Price: 10 credits

List the US federal departments and agencies that post jobs on USAJOBS, with their filter code, full name, acronym and parent department. Optionally narrow the catalog by a keyword matched against name, acronym and code, or restrict it to top-level departments only. The codes returned here are exactly the values accepted by the department and agency filters of the USAJOBS job search, facets and events endpoints.

How to use it

Look up US federal department and agency codes for USAJOBS. Use this to translate a name like 'Veterans Health Administration' into the code (VATA) that the department/agency filters of the USAJOBS job search, facets and events endpoints expect, or to resolve codes returned by the facets endpoint back into names. keyword matches name, acronym and code; departments_only returns just the ~26 cabinet-level departments instead of the full ~780-organization catalog. Each item has code, name, acronym, parent and is_department.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string nullable — Only return organizations whose name, acronym or code contains this text
• departments_only boolean — Return only top-level departments instead of departments and their agencies (default: false)
• count integer required — Max number of organizations to return (min: 1)

Response

• @type string (default: "UsajobsAgency")
• code string required
• name string required
• acronym string nullable
• parent string nullable
• is_department boolean (default: false)

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.