NHSJobs API

Prev Next

Board URL: https://www.jobs.nhs.uk/
Purpose: This integration covers job posting for the NHSJobs_API job board.


Integration summary

  • Pipeline ID: NHSJobs_API
  • Delivery times (UTC): Every hour
  • Default posting period: 30 days

Special requirements

None


Known limitations

  • All jobs exported to NHS Jobs are delivered into the draft section of the employer dashboard.
  • An employer on the organisation account must log in to NHS Jobs and manually publish the job to make it live.

Administrator configuration

View administrator configuration fields

Below are the fields eQuest administrators will encounter during board setup.

Admin fields

Field name Type Required (Y/N) Description
Account Number Open text Y Provided by NHS Jobs.
Testing Boolean N If testing is required, set to true to use the NHS Jobs test server.

Poster-facing fields (job posters)

View job poster fields

User fields

Field name Type Required (Y/N) Description
Job Advert Short Description Open text Y Short job advert description, not the full job description.
Job Advert Overview Open text Y Job advert overview.
Organisation Description Open text Y Organisation description.
Person desirable skills description Open text N Enter an HTML line break tag between each skill.
Person essential skills description Open text N Enter an HTML line break tag between each skill.
Person desirable experience description Open text N Enter an HTML line break tag between each experience.
Person essential experience description Open text N Enter an HTML line break tag between each experience.
Person desirable qualifications description Open text N Enter an HTML line break tag between each qualification.
Person essential qualifications description Open text N Enter an HTML line break tag between each qualification.
PayType Dropdown Y Select from available values.
Contract Type Dropdown Y If not PERMANENT, Duration Length and Duration Unit are required.
Duration Length Dropdown Y Required if Contract Type is not PERMANENT.
Duration Unit Dropdown Y Required if Contract Type is not PERMANENT.
Work Type Dropdown Y Select from available values.
Contact Name Open text Y Contact name.
Recruiter Job Title Open text Y Recruiter job title.
Contact Email Open text Y Contact email.
Contact Phone Open text N Contact phone.
Does the job require applicants to be checked for any previous criminal convictions? Boolean Y Criminal conviction check required.
Is the job open to applicants outside the EU and EEA? Boolean Y Open to applicants outside EU/EEA.
Does the job require current UK professional registration? Boolean Y UK professional registration required.
Convictions Boolean Y Convictions field.
PoliceWarning Boolean Y Police warning field.
StaffGroup Dropdown Y Select from available values.
Area Of Work Dropdown Y Select from available values.
Location Postal Code Open text Y Location postal code.
Location Street Address Open text Y Location street address.
Additional Street Address Open text N Additional street address.
Salary Unit Dropdown Y Select from available values.
Additional Salary Details Open text N Additional salary details.
Salary Type Dropdown Y If not Negotiable, Salary Amount (Fixed Pay) or Minimum and Maximum Salary (Ranged Pay) are required.

Revision history

Date Changes
10/2/2024 Initial version.
8/28/2025 Updated configuration.