Overview

The Teaching Vacancies ATS API lets an applicant tracking system create, update, list and delete job listings for the schools and trusts it acts for. Listings published through it appear on the Teaching Vacancies service, where people looking for school jobs can search for them and subscribe to alerts.

Access is by API key, issued as part of onboarding. To start an integration, email teachingvacancies.ats@education.gov.uk.

Documents

v1
Uploaded schema

Who can use this API

Applicant tracking system and HR software vendors acting for schools and trusts

Service level

24/7

Technologies

REST, Ruby on Rails

Environments

Environment Base URL
staging
production

You need to sign in to subscribe to an API environment or view your existing subscriptions.

Sign in here using GOV.UK One Login

Current release

Release name Available from
v1

Operations

GET Returns a paginated list of vacancies that were created through the client's ATS.

Description

Returns a paginated list of vacancies that were created through the client's ATS.

URL template
/ats-api/v1/vacancies

POST Creates a new vacancy for the client's ATS.

Description

Creates a new vacancy for the client's ATS.

URL template
/ats-api/v1/vacancies

DELETE Deletes a vacancy with the given ID, if it belongs to the client's ATS.

Description

Deletes a vacancy with the given ID, if it belongs to the client's ATS.

URL template
/ats-api/v1/vacancies/{id}

GET Retrieves details for a single vacancy by its unique ID, if it belongs to the requesting client.

Description

Retrieves details for a single vacancy by its unique ID, if it belongs to the requesting client.

URL template
/ats-api/v1/vacancies/{id}

PUT Updates an existing vacancy. The request body must include all required fields. Optional fields keep existing values if not provided.

Description

Updates an existing vacancy. The request body must include all required fields. Optional fields keep existing values if not provided.

URL template
/ats-api/v1/vacancies/{id}
Back to top