API Reference - GET /api/HistoricJoa
The Historic JOAs endpoint is designed to deliver all job postings to USAJOBS filtered by a set of standard parameters. This endpoint is intended to deliver a bulk data set to be parsed by the consumer.
Resource
GET /api/historicjoa
Authorization
The Historic JOAs endpoint does not require authorization or authentication. The data returned by this endpoint is publicly consumable.
Pagination
The Historic JOAs endpoint returns a potentially lengthy array of objects. In order to keep the response sizes manageable, the API endpoints will take advantage of pagination. Pagination is a mechanism to return a subset of the results for the request and allowing for subsequent requests to page through the rest of the results. Pagination endpoints follow a standard interface that accepts three query parameters, PageSize and PageNumber.
Parameter Name | Description |
---|---|
Pagesize |
Allows you to determine how many records to return per page. Current default and max page size is 1,000. |
PageNumber |
Allows you to request a specific page of data. Default will be page number 1. |
The endpoint will also return a payload providing pagination details including links to previous and next paged data as well as metadata on record count, page size, current page and total pages.
Query Parameters
The query parameters are appended to the URL to drive the specific results desired. Each consumer can leverage any combination of these parameters. The query parameters are:
Parameter Name | Description |
---|---|
PageSize |
Allows you to determine how many records to return per page. Current default and max page size are 1,000. |
PageNumber |
Allows you to request a specific page of data. Default will be page number 1. |
HiringAgencyCodes |
The code of the agency in which the position is located. |
HiringDepartmentCodes |
The code of the department in which the position is located. |
PositionSeries |
The occupational code identifying the position as indicated on the position description associated with a vacancy. |
AnnouncementNumbers |
The unique identifying number associated with an announcement. |
USAJOBSControlNumbers |
The USAJOBS provided announcement control number. |
StartPositionOpenDate |
The beginning of the calendar date range when an announcement opened. |
EndPositionOpenDate |
The end of the calendar date range when an announcement opened. |
StartPositionCloseDate |
The beginning of the calendar date range when an announcement closed. |
EndPositionCloseDate |
The end of the calendar date range when an announcement closed. |
Response
JSON:
{
"paging": {
"metadata": {
"totalCount": 26094,
"pageSize": 1000,
"currentPage": 2,
"totalPages": 2610
},
"previous": "/api/historicjoa?pagesize=10&pagenumber=1",
"next": "/api/historicjoa?pagesize=10&pagenumber=3"
},
"data": [
{
"usajobsControlNumber": 23968100,
"hiringAgencyCode": "TD03",
"hiringAgencyName": "Federal Aviation Administration",
"hiringDepartmentCode": "TD",
"hiringDepartmentName": "Department of Transportation",
"agencyLevel": 2,
"agencyLevelSort": "Department of Transportation\\Federal Aviation Administration",
"appointmentType": "Permanent",
"workSchedule": "Full-time",
"payScale": "FV",
"salaryType": "Per Year",
"vendor": "NA",
"travelRequirement": "NA",
"teleworkEligible": "N",
"serviceType": "NA",
"securityClearanceRequired": "N",
"securityClearance": "NA",
"whoMayApply": "Agency Employees Only",
"announcementClosingType": "0",
"announcementClosingTypeDescription": "NA",
"positionOpenDate": "2016-12-05T00:00:00",
"positionCloseDate": "2016-12-14T00:00:00",
"positionExpireDate": "1900-01-01T00:00:00",
"announcementNumber": "AAC-INT-17-AJW3111-51115",
"hiringSubelementName": "NA",
"positionTitle": "Management and Program Analyst",
"minimumGrade": "F",
"maximumGrade": "F",
"promotionPotential": "NA",
"minimumSalary": 41236.0000,
"maximumSalary": 61853.0000,
"supervisoryStatus": "Y",
"drugTestRequired": "N",
"relocationExpensesReimbursed": "Y",
"totalOpenings": "2",
"disableAppyOnline": "N",
"positionOpeningStatus": "Applications under review",
"hiringPaths": [],
"jobCategories": [
{
"series": "0343"
}
],
"positionLocations": [
{
"positionLocationCity": "Oklahoma City",
"positionLocationState": "Oklahoma",
"positionLocationCountry": "United States"
}
]
}
]
}
Name | Description | Type |
---|---|---|
AppointmentType | Identifies the type of appointment (e.g., permanent, temporary, term). | string |
HiringAgencyCode | The code of the agency in which the position is located. | string |
HiringAgencyName | The name of the agency in which the position is located. | string |
HiringDepartmentCode | The parent code of the department in which the position is located. | integer |
HiringDepartmentName | The name of the department in which the position is located. | string |
HiringSubelementName | The name of the administrative subdivision where the position is located. (manually entered by HR representative). | string |
AgencyLevel | The Agency Level defines the hierarchy of the Agency. | integer |
AgencyLevelSort | The Agency Level sort shows the drill path of the Agency. | string |
HiringPaths | The group(s) of job seekers who are eligible to apply for a position (e.g., The Public, Federal Employees - Competitive Service, Veterans). | string |
PositionOpeningStatus | The hiring status of the position. Indicates if it is currently accepting applications, reviewing applications, has selected an individual to hire, or has been canceled. | string |
KeyStandardRequirement | The code identifying the conditions of employment for the position. | string |
KeyStandardRequirementDescription | The conditions of employment for the position. | string |
MissionCriticalOccupations | Value indicating if position is tied to any mission critical occupations. Used to tag and search job announcements. | string |
Series | The occupational code identifying the position as indicated on the position description associated with a vacancy. | string |
PayScale | The table or array of pay rates as indicated on the position description associated with a vacancy. | string |
MaximumGrade | The pay rate level as indicated on the position description associated with a vacancy. | string |
MinimumGrade | The pay rate level as indicated on the position description associated with a vacancy. | string |
AnnouncementNumber | The unique identifying number associated with an announcement. | string |
PositionCloseDate | The calendar date that an announcement closed. | date |
PositionOpenDate | The calendar date that an announcement opened. | date |
PositionTitle | Official classification title description of the position of the employee associated with a request. | string |
PromotionPotential | Highest Grade Level for a position. | string |
SalaryType | The frequency of salary payment. Bi-weekly, Fee Basis, Per Year, etc. | string |
MaximumSalary | The maximum salary associated with the position being posted to USAJOBS. | decimal |
MinimumSalary | The minimum salary associated with the position being posted to USAJOBS. | decimal |
SecurityClearanceRequired | Flag indicating if a security clearance is required for the position. | boolean |
SecurityClearance | Description of the type security clearance required for the request: Not Required, Confidential, Secret, etc. | string |
ServiceType | The Federal government has 3 services that determine how you are hired:Competitive, Excepted and Senior Executive. | string |
SupervisoryStatus | Flag indicating if the position in the request is a supervisory position. | boolean |
TeleworkEligible | Flag indicating if the position in the vacancy is eligible for telework. | boolean |
TravelRequirement | Description of the travel requirement for the position: Occasional Travel, No Travel, etc. | string |
USAJOBSControlNumber | The USAJOBS provided announcement control number. | integer |
WhoMayApply | Description of the types of candidates that may apply for a job posting: Agency Employees Only, Public, United States Citizens, etc. | string |
AnnouncementClosingTypeDescription | Field Indicating how the announcement the circumstances that will cause it to close and stop receiving applications: Closing Date, Open Continuous, Applicant Cut-Off, or Closing Time. | string |
AnnouncementClosingTypeCode | Code Indicating how the announcement the circumstances that will cause it to close and stop receiving applications. | string |
RelocationExpensesReimbursed | Flag indicating if the candidates moving expenses are reimbursable. | boolean |
TotalOpenings | The number of position openings associated with the announcement. | string |
Vendor | The Talent Acquisition System (TAS) used to post the position on USAJOBS.gov. | string |
PositionExpireDate | Close date of position, if it is closed early. If this field is populated, this is the actual close date of the position. | date |
DrugTestRequired | Indicator showing if the position requires a drug test for employment. | boolean |
DisableApplyOnline | Indicates if an individual can start an application for a job announcement within USAJOBS, or must go to another site to start said application. | boolean |
PositionLocationCity | The city of the location for which a position is announced. | string |
PositionLocationState | The state of the location for which a position is announced. | string |
PositionLocationCountry | The country of the location for which a position is announced. | string |
PositionLocationIDs | The unique identifier assigned to an individual location. | |
WorkSchedule | Identifies the type of work schedule (e.g., full time, part time, intermittent, shift work, job sharing) for the position announced. | string |
ApplicationsStarted | Count of applications started for a position (applications started may not result in a completed application in a Talent Acquisition System) | integer |