USAJOBS (Independent Publisher) (Preview)
USAJOBS.gov is the Federal Government's official job board, providing free access to thousands of job opportunities across hundreds of federal agencies and organizations. As the primary source for federal job listings, applications, and employment opportunity information, USAJOBS.gov offers a diverse range of positions to job seekers. With over 17 million users, it helps connect candidates with federal careers, ensuring fair and equal opportunity in the hiring process.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Richard Wilson |
| URL | https://www.richardawilson.com/ |
| richard.a.wilson@microsoft.com |
| Connector Metadata | |
|---|---|
| Publisher | Richard Wilson |
| Website | https://developer.usajobs.gov/ |
| Privacy policy | https://help.usajobs.gov/privacy |
| Categories | Human Resources |
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | The API Key for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| List academic honors |
Retrieve a list of academic honors values and corresponding codes. |
| List academic levels |
Retrieve a list of academic levels values and corresponding codes. |
| List action codes |
Retrieve a list of action codes values and corresponding codes. |
| List agency subelements |
Retrieve a list of agencies and corresponding organization codes. |
| List announcement closing types |
Retrieve a list of announcement closing type values and corresponding codes. |
| List applicant suppliers |
Retrieve a list of applicant suppliers values and corresponding codes. |
| List application statuses |
Retrieve a list of application status values and corresponding codes. |
| List countries |
Retrieve a list of countries and corresponding codes. |
| List country subdivisions |
Retrieve a list of states, provinces, or territories within countries. |
| List cyber work groupings |
Retrieve a list of cyber work grouping values and corresponding codes. |
| List cyber work roles |
Retrieve a list of cyber work role values and corresponding codes. |
| List degree type codes |
Retrieve a list of degree type values and corresponding codes. |
| List disabilities |
Retrieve a list of disability values and corresponding codes. |
| List document formats |
Retrieve a list of document formats values and corresponding codes. |
| List documentations |
Retrieve a list of documentation values and corresponding codes. |
| List ethnicities |
Retrieve a list of ethnicity values and corresponding codes. |
| List federal employment statuses |
Retrieve a list of federal employment status values and corresponding codes. |
| List geographic locations |
Retrieve a list of geographic location values and corresponding codes. |
| List GSA geographic locations |
Retrieve a list of GSA geographic location values and corresponding codes. |
| List hiring paths |
Retrieve a list of hiring paths and corresponding codes. |
| List key standard requirements |
Retrieve a list of Key Standard Requirements values and corresponding codes. |
| List language codes |
Retrieve a list of Languages values and corresponding codes. |
| List language proficiencies |
Retrieve a list of Language Proficiencies values and corresponding codes. |
| List location expansions |
Retrieve a list of Location Expansions values and corresponding codes. |
| List military status codes |
Retrieve a list of Military Status values and corresponding codes. |
| List mission critical codes |
Retrieve a list of Mission Critical values and corresponding codes. |
| List occupational series |
Retrieve a list of job categories and corresponding codes. |
| List pay plans |
Retrieve a list of pay plans and corresponding codes. |
| List position offering types |
Retrieve a list of position offering types and corresponding codes. |
| List position opening statuses |
Retrieve a list of position opening status values and corresponding codes. |
| List position schedule types |
Retrieve a list of position schedule types values and corresponding codes. |
| List postal codes |
Retrieve a list of postal code values. |
| List race codes |
Retrieve a list of Race values and the corresponding codes. |
| List referee type codes |
Retrieve a list of Referee Type values and the corresponding codes. |
| List remuneration rate interval codes |
Retrieve a list of Remuneration Rate Interval values and the corresponding codes. |
| List required standard documents |
Retrieve a list of Required Standard Documents values and the corresponding codes. |
| List security clearances |
Retrieve a list of Security Clearances values and the corresponding codes. |
| List service types |
Retrieve a list of Service Types values and the corresponding codes. |
| List special hirings |
Retrieve a list of Special Hirings values and the corresponding codes. |
| List travel percentages |
Retrieve a list of travel values and the corresponding codes. |
| List Who May Apply |
Retrieve a list of Who May Apply values and the corresponding codes. |
| Search for jobs |
Search USAJOBS for job opportunity announcements. |
List academic honors
Retrieve a list of academic honors values and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Academic Honors code. |
|
Value
|
CodeList.ValidValue.Value | string |
Academic Honors value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the Academic Honors code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List academic levels
Retrieve a list of academic levels values and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Academic Levels Interval code. |
|
Value
|
CodeList.ValidValue.Value | string |
Academic Levels Interval value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the Academic Levels code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List action codes
Retrieve a list of action codes values and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Action code. |
|
Value
|
CodeList.ValidValue.Value | string |
Action code value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the action code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List agency subelements
Retrieve a list of agencies and corresponding organization codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Organizational code used for searching by agency. |
|
Value
|
CodeList.ValidValue.Value | string |
Agency name. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the agency code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List announcement closing types
Retrieve a list of announcement closing type values and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Announcement Closing Type code. |
|
Value
|
CodeList.ValidValue.Value | string |
Announcement Closing Type value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the Announcement Closing Type code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List applicant suppliers
Retrieve a list of applicant suppliers values and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Applicant Suppliers code. |
|
Value
|
CodeList.ValidValue.Value | string |
Applicant Suppliers value. |
|
Group
|
CodeList.ValidValue.Group | string |
Group category of the applicant supplier. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the Applicant Suppliers code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List application statuses
Retrieve a list of application status values and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Application Status Interval code. |
|
Value
|
CodeList.ValidValue.Value | string |
Application Status Interval value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the Application Status code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List countries
Retrieve a list of countries and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Country code. |
|
Value
|
CodeList.ValidValue.Value | string |
Country name. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the country code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List country subdivisions
Retrieve a list of states, provinces, or territories within countries.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Country
|
country | string |
The 2 character Country Code. This is an optional field. |
|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Country subdivisions code. |
|
Value
|
CodeList.ValidValue.Value | string |
State, province or territory name. |
|
Parent Code
|
CodeList.ValidValue.ParentCode | string |
Country code. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the country subdivisions code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List cyber work groupings
Retrieve a list of cyber work grouping values and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | integer |
Cyber Work Grouping code. |
|
Value
|
CodeList.ValidValue.Value | string |
Cyber Work Grouping value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | boolean |
Indicates if the Cyber Work Grouping code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List cyber work roles
Retrieve a list of cyber work role values and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | integer |
Cyber Work Role code. |
|
Value
|
CodeList.ValidValue.Value | string |
Cyber Work Role value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | boolean |
Indicates if the Cyber Work Role code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List degree type codes
Retrieve a list of degree type values and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Degree Type code. |
|
Value
|
CodeList.ValidValue.Value | string |
Degree Type value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the Degree Type code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List disabilities
Retrieve a list of disability values and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Disability code. |
|
Value
|
CodeList.ValidValue.Value | string |
Disability value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the Disability has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List document formats
Retrieve a list of document formats values and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Document format code. |
|
Value
|
CodeList.ValidValue.Value | string |
Document format value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the Document Format has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List documentations
Retrieve a list of documentation values and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Documentation code. |
|
Value
|
CodeList.ValidValue.Value | string |
Documentation value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the Documentation has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List ethnicities
Retrieve a list of ethnicity values and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Ethnicity code. |
|
Value
|
CodeList.ValidValue.Value | string |
Ethnicity value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the Ethnicity code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List federal employment statuses
Retrieve a list of federal employment status values and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Federal Employment Status code. |
|
Value
|
CodeList.ValidValue.Value | string |
Federal Employment Status value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the Federal Employment Status code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List geographic locations
Retrieve a list of geographic location values and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Geographic location code. |
|
City
|
CodeList.ValidValue.City | string |
City the postal area is located. |
|
US County
|
CodeList.ValidValue.USCounty | string |
If US postal code then county the postal code is located. |
|
Country Subdivision
|
CodeList.ValidValue.CountrySubdivision | string |
State, province, or territory the postal code is located. |
|
Country
|
CodeList.ValidValue.Country | string |
Country the postal code is located. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the geographic location code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List GSA geographic locations
Retrieve a list of GSA geographic location values and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Geographic location code. |
|
City
|
CodeList.ValidValue.City | string |
City the postal area is located. |
|
US County
|
CodeList.ValidValue.USCounty | string |
If US postal code then county the postal code is located. |
|
Country Subdivision
|
CodeList.ValidValue.CountrySubdivision | string |
State, province, or territory the postal code is located. |
|
Country
|
CodeList.ValidValue.Country | string |
Country the postal code is located. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the geographic location code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List hiring paths
Retrieve a list of hiring paths and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
HiringPath code. |
|
Value
|
CodeList.ValidValue.Value | string |
HiringPath value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the HiringPath code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List key standard requirements
Retrieve a list of Key Standard Requirements values and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Key Standard Requirements code. |
|
Value
|
CodeList.ValidValue.Value | string |
Key Standard Requirements value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the Key Standard Requirements code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List language codes
Retrieve a list of Languages values and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Language code. |
|
Value
|
CodeList.ValidValue.Value | string |
Language value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the Language code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List language proficiencies
Retrieve a list of Language Proficiencies values and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Language Proficiency code. |
|
Value
|
CodeList.ValidValue.Value | string |
Language Proficiency value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the Language Proficiency code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List location expansions
Retrieve a list of Location Expansions values and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Location Expansions code. |
|
City
|
CodeList.ValidValue.City | string |
Location Expansions city name. |
|
Country Subdivision
|
CodeList.ValidValue.CountrySubdivision | string |
Location Expansions Country Subdivision name. |
|
Country
|
CodeList.ValidValue.Country | string |
Location Expansions Country name. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the Location Expansions code has been disabled. Values are Yes or No. |
|
Expansion
|
CodeList.ValidValue.Expansion | array of object |
List of locations grouped under the Location Expansion item. |
|
Geo Location Code
|
CodeList.ValidValue.Expansion.GeoLocCode | string |
Geographic location code. |
|
City
|
CodeList.ValidValue.Expansion.City | string |
City name. |
|
Country Subdivision
|
CodeList.ValidValue.Expansion.CountrySubdivision | string |
Country subdivision name. |
|
Country
|
CodeList.ValidValue.Expansion.Country | string |
Country name. |
|
Last Modified
|
CodeList.ValidValue.Expansion.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.Expansion.IsDisabled | string |
Indicates if the geographic location code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List military status codes
Retrieve a list of Military Status values and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Military Status code. |
|
Value
|
CodeList.ValidValue.Value | string |
Military Status value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the Military Status code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List mission critical codes
Retrieve a list of Mission Critical values and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Mission Critical code. |
|
Value
|
CodeList.ValidValue.Value | string |
Mission Critical value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the Mission Critical code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List occupational series
Retrieve a list of job categories and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Job category code used for searching by job category. |
|
Value
|
CodeList.ValidValue.Value | string |
Job category name. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the occupational series code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List pay plans
Retrieve a list of pay plans and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Pay plan code. |
|
Value
|
CodeList.ValidValue.Value | string |
Pay plan description. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the pay plan code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List position offering types
Retrieve a list of position offering types and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Position offering type code. |
|
Value
|
CodeList.ValidValue.Value | string |
Position offering type value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the position offering type code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List position opening statuses
Retrieve a list of position opening status values and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Position opening status code. |
|
Value
|
CodeList.ValidValue.Value | string |
Position opening status value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the position opening status code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List position schedule types
Retrieve a list of position schedule types values and corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Position schedule type code. |
|
Value
|
CodeList.ValidValue.Value | string |
Position schedule type value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the position schedule type code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List postal codes
Retrieve a list of postal code values.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Postal code. |
|
Reference Location ID
|
CodeList.ValidValue.RefLocID | integer |
Reference location ID. |
|
City
|
CodeList.ValidValue.City | string |
City the postal area is located. |
|
US County
|
CodeList.ValidValue.USCounty | string |
If US postal code then county the postal code is located. |
|
Country Subdivision
|
CodeList.ValidValue.CountrySubdivision | string |
State or province the postal code is located. |
|
Country
|
CodeList.ValidValue.Country | string |
Country the postal code is located. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the postal code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List race codes
Retrieve a list of Race values and the corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Race code. |
|
Value
|
CodeList.ValidValue.Value | string |
Race value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the race code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List referee type codes
Retrieve a list of Referee Type values and the corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Referee Type code. |
|
Value
|
CodeList.ValidValue.Value | string |
Referee Type value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the referee type code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List remuneration rate interval codes
Retrieve a list of Remuneration Rate Interval values and the corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Remuneration Rate Interval code. |
|
Value
|
CodeList.ValidValue.Value | string |
Remuneration Rate Interval value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the remuneration rate interval code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List required standard documents
Retrieve a list of Required Standard Documents values and the corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Required Standard Documents code. |
|
Value
|
CodeList.ValidValue.Value | string |
Required Standard Documents value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the Required Standard Documents code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List security clearances
Retrieve a list of Security Clearances values and the corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Security Clearance code. |
|
Value
|
CodeList.ValidValue.Value | string |
Security Clearance value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the Security Clearance code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List service types
Retrieve a list of Service Types values and the corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Service Type code. |
|
Value
|
CodeList.ValidValue.Value | string |
Service Type value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the Service Type code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List special hirings
Retrieve a list of Special Hirings values and the corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Special Hiring code. |
|
Value
|
CodeList.ValidValue.Value | string |
Special Hiring value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the Special Hiring code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List travel percentages
Retrieve a list of travel values and the corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Travel code. |
|
Value
|
CodeList.ValidValue.Value | string |
Travel value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the Travel code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
List Who May Apply
Retrieve a list of Who May Apply values and the corresponding codes.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Last Modified
|
lastmodified | date |
Only return items modified on or after the date supplied. This is an optional field. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code List
|
CodeList | array of object |
List of code lists. |
|
Valid Value
|
CodeList.ValidValue | array of object |
List of valid values. |
|
Code
|
CodeList.ValidValue.Code | string |
Who May Apply code. |
|
Value
|
CodeList.ValidValue.Value | string |
Who May Apply value. |
|
Last Modified
|
CodeList.ValidValue.LastModified | date-time |
Date value or code was last modified. |
|
Is Disabled
|
CodeList.ValidValue.IsDisabled | string |
Indicates if the Who May Apply code has been disabled. Values are Yes or No. |
|
ID
|
CodeList.id | string |
Identifier for the codelist. |
|
Date Generated
|
DateGenerated | date-time |
Date of the request. |
Search for jobs
Search USAJOBS for job opportunity announcements.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Keyword
|
Keyword | string |
Search based on a keyword. |
|
|
Position Title
|
PositionTitle | string |
Search for job announcements containing this title. |
|
|
Remuneration Minimum Amount
|
RemunerationMinimumAmount | integer |
Minimum salary for the job. |
|
|
Remuneration Maximum Amount
|
RemunerationMaximumAmount | integer |
Maximum salary for the job. |
|
|
Pay Grade High
|
PayGradeHigh | string |
Maximum pay grade for the job. |
|
|
Pay Grade Low
|
PayGradeLow | string |
Minimum pay grade for the job. |
|
|
Job Category Code
|
JobCategoryCode | string |
Job category series code. |
|
|
Remote Indicator
|
RemoteIndicator | boolean |
Indicates if the job is remote. |
|
|
Location Name
|
LocationName | string |
Location name for the job. |
|
|
Radius
|
Radius | integer |
Radius for location-based search. |
|
|
Relocation Indicator
|
RelocationIndicator | boolean |
Indicates if the job offers relocation. |
|
|
Travel Percentage
|
TravelPercentage | string |
Travel percentage for the job. |
|
|
Organization
|
Organization | string |
Agency subelement code. |
|
|
Position Offering Type Code
|
PositionOfferingTypeCode | string |
Position offering type code. |
|
|
Position Schedule Type Code
|
PositionScheduleTypeCode | string |
Position schedule type code. |
|
|
Security Clearance Required
|
SecurityClearanceRequired | string |
Security clearance required for the job. |
|
|
Position Sensitivity
|
PositionSensitivity | string |
Position sensitivity and risk level. |
|
|
Supervisory Status
|
SupervisoryStatus | boolean |
Supervisory status of the job. |
|
|
Days Posted
|
DatePosted | integer |
Number of days since the job was posted. |
|
|
Job Grade Code
|
JobGradeCode | string |
Grade code for the job. |
|
|
Who May Apply
|
WhoMayApply | string |
Candidate designation for the job. |
|
|
Salary Bucket
|
SalaryBucket | string |
Salary range grouping. |
|
|
Grade Bucket
|
GradeBucket | string |
Grade level grouping. |
|
|
Hiring Path
|
HiringPath | string |
Hiring paths for the job. |
|
|
Mission Critical Tags
|
MissionCriticalTags | string |
Mission-critical tags for the job. |
|
|
Posting Channel
|
PostingChannel | string |
Posting channel for the job. |
|
|
Fields
|
Fields | string |
Level of detail in the job data. |
|
|
Sort Field
|
SortField | string |
Field to sort the results by. |
|
|
Sort Direction
|
SortDirection | string |
Direction to sort the results. |
|
|
Page
|
Page | integer |
Page number for the results. |
|
|
Results Per Page
|
ResultsPerPage | integer |
Number of results per page, up to 500. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Language Code
|
LanguageCode | string |
The response language code. |
|
Search Parameters
|
SearchParameters | object |
The parameters used in the search request. |
|
Search Result Count
|
SearchResult.SearchResultCount | integer |
Number of records returned in the response. |
|
Search Result Count All
|
SearchResult.SearchResultCountAll | integer |
Total number of records that matched the search criteria. |
|
Search Result Items
|
SearchResult.SearchResultItems | array of object |
Array of job opportunity announcement objects that matched the search criteria. |
|
Matched Object Id
|
SearchResult.SearchResultItems.MatchedObjectId | string |
Control number. |
|
Position ID
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionID | string |
Job announcement number. |
|
Position Title
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionTitle | string |
Title of the job offering. |
|
Position URI
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionURI | string |
URI to view the job offering. |
|
Apply URI
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.ApplyURI | array of string |
URI to apply for the job offering. |
|
Position Location
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionLocation | array of object |
Location details of the position. |
|
Location Name
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionLocation.LocationName | string |
Name of the location. |
|
Country Code
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionLocation.CountryCode | string |
Country code of the location. |
|
Country Subdivision Code
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionLocation.CountrySubDivisionCode | string |
Subdivision code of the country. |
|
City Name
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionLocation.CityName | string |
Name of the city. |
|
Longitude
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionLocation.Longitude | float |
Longitude of the location. |
|
Latitude
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionLocation.Latitude | float |
Latitude of the location. |
|
Organization Name
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.OrganizationName | string |
Name of the organization or agency offering the position. |
|
Department Name
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.DepartmentName | string |
Name of the department within the organization or agency offering the position. |
|
Job Category
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.JobCategory | array of object |
List of job category objects. |
|
Job Category Name
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.JobCategory.Name | string |
Name of the job category. |
|
Job Category Code
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.JobCategory.Code | string |
Code of the job category. |
|
Job Grade
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.JobGrade | array of object |
List of job grade objects. |
|
Job Grade Code
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.JobGrade.Code | string |
Code of the job grade. |
|
Position Schedule
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionSchedule | array of object |
List of position schedule objects. |
|
Position Schedule Name
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionSchedule.Name | string |
Name of the position schedule. |
|
Position Schedule Code
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionSchedule.Code | string |
Code of the position schedule. |
|
Position Offering Type
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionOfferingType | array of object |
List of position offering type objects. |
|
Position Offering Type Name
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionOfferingType.Name | string |
Name of the position offering type. |
|
Position Offering Type Code
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionOfferingType.Code | string |
Code of the position offering type. |
|
Qualification Summary
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.QualificationSummary | string |
Summary of qualifications for the job offering. |
|
Position Remuneration
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionRemuneration | array of object |
List of position remuneration objects. |
|
Minimum Range
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionRemuneration.MinimumRange | string |
Minimum salary range. |
|
Maximum Range
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionRemuneration.MaximumRange | string |
Maximum salary range. |
|
Rate Interval Code
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionRemuneration.RateIntervalCode | string |
Rate interval code for the salary. |
|
Description
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionRemuneration.Description | string |
Description of the salary range. |
|
Position Start Date
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionStartDate | string |
The date the job opportunity will be open to applications. |
|
Position End Date
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionEndDate | string |
Last date the job opportunity will be posted. |
|
Publication Start Date
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PublicationStartDate | string |
Date the job opportunity is posted. |
|
Application Close Date
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.ApplicationCloseDate | string |
Last date applications will be accepted for the job opportunity. |
|
Position Formatted Description
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionFormattedDescription | array of object |
List of objects providing a quick summary of the job opportunity. |
|
Content
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionFormattedDescription.Content | string |
Content of the description. |
|
Label
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionFormattedDescription.Label | string |
Label for the description. |
|
Label Description
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.PositionFormattedDescription.LabelDescription | string |
Description of the label. |
|
Major Duties
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.UserArea.Details.MajorDuties | array of string |
Description of the duties of the job. |
|
Education
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.UserArea.Details.Education | string |
Education required or preferred by applicants. |
|
Requirements
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.UserArea.Details.Requirements | string |
Key requirements of the job opportunity. |
|
Evaluations
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.UserArea.Details.Evaluations | string |
Qualification requirements of the job opportunity. |
|
How To Apply
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.UserArea.Details.HowToApply | string |
Description of the steps to take to apply for the job opportunity. |
|
What To Expect Next
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.UserArea.Details.WhatToExpectNext | string |
Description of what can be expected during the application process. |
|
Required Documents
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.UserArea.Details.RequiredDocuments | string |
Required documents when applying for the job opportunity. |
|
Benefits
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.UserArea.Details.Benefits | string |
Benefits being offered as part of the job opportunity. |
|
Benefits Url
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.UserArea.Details.BenefitsUrl | string |
URL to view benefit details being offered. |
|
Other Information
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.UserArea.Details.OtherInformation | string |
Additional information about the job opportunity. |
|
Key Requirements
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.UserArea.Details.KeyRequirements | array of string |
List of requirements for the job opportunity. |
|
Job Summary
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.UserArea.Details.JobSummary | string |
Summary of the job opportunity. |
|
Name
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.UserArea.Details.WhoMayApply.Name | string |
Name of the candidate designation. |
|
Code
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.UserArea.Details.WhoMayApply.Code | string |
Code of the candidate designation. |
|
Low Grade
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.UserArea.Details.LowGrade | string |
Lowest potential grade level for the job opportunity. |
|
High Grade
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.UserArea.Details.HighGrade | string |
Highest potential grade level for the job opportunity. |
|
Sub Agency Name
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.UserArea.Details.SubAgencyName | string |
Name of the sub agency. |
|
Organization Codes
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.UserArea.Details.OrganizationCodes | string |
Organization codes separated by a slash (/). |
|
Is Radial Search
|
SearchResult.SearchResultItems.MatchedObjectDescriptor.UserArea.IsRadialSearch | boolean |
Indicates if a radial search was performed. |
|
Relevance Rank
|
SearchResult.SearchResultItems.RelevanceRank | number |
Relevance rank of the search result. |
|
Number Of Pages
|
SearchResult.UserArea.NumberOfPages | string |
Number of pages based on SearchResultCount divided by SearchResultCountAll. |
|
Is Radial Search
|
SearchResult.UserArea.IsRadialSearch | boolean |
Indicates if a radial search was performed. |