Overview

The display advert API displays the vacancies listed on our flagship Find an Apprenticeship (FAA) website. Using this API, you are able to return a full list of all live vacancies (or subsets thereof based on parameters like distance, employer, how recently (in days) they were posted, or whether they're linked to your UKPRN if you're a training provider), or drill down into individual vacancies to return more detail.

Documents

display-advert-api.json
Uploaded schema

Who can use this API

This is primarily aimed at training providers, but anybody that wants to return a list of apprenticeship vacancies can use this API.

If you are working with a specific employer or training provider, you can request an API key from them directly, which will return results specific to that organisation. Otherwise, you can request your own unfiltered subscription by visiting the project site.

Instructions for how to subscribe to this API are available here: https://developer.apprenticeships.education.gov.uk/

Technologies

C#; JSON; RESTful

Environments

Environment Base URL
live https://api.apprenticeships.education.gov.uk/vacancies

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
2 08 April 2026

Operations

GET GET list of Account Legal Entities.

Description

Get a list of Account Legal Entities that are connected to your subscription. This can be used to further filter results in GET vacancy request. If you are a provider only Accounts that have given permission for you to act on there behalf will show in the list. If you are an employer then only legal entities that have a signed agreement will be in the list. If you are not an employer or provider a forbidden response will be returned.

URL template
/accountlegalentities

GET GET list of course routes. The routes can then be used to filter results in `GET Vacancy` endpoint.

Description

GET list of course routes. The routes can then be used to filter results in GET Vacancy endpoint.

URL template
/referencedata/courses/routes

GET GET list of courses.

Description

GET list of courses.

URL template
/referencedata/courses

GET GET list of vacancies

Description

Returns list of Vacancies based on your subscription.

  • If FilterBySubscription is true then for employer subscriptions this will automatically filter by your account.
  • If FilterBySubscription is true then for providers it will automatically filter by UKPRN.
  • If you provide a AccountLegalEntityPublicHashedId it must come from GET accountslegalentities or a forbidden result will be returned.

Examples

Get all of a subscription's vacancies sorted by age descending (oldest first):

/vacancy?Sort=AgeDesc&FilterBySubscription=true

Get all vacancies within a 20 mile radius of Coventry (52.408056, -1.510556), sorted by distance (closest first) for standards 123 and 345:

/vacancy?Lat=52.408056&Lon=-1.510556&Sort=DistanceAsc&DistanceInMiles=20&StandardLarsCode=123&StandardLarsCode=345

Get all nationwide vacancies for route 'example' posted within the last 30 days, page 5, size 10:

/vacancy?PageNumber=5&PageSize=10&Routes=example&NationWideOnly=true&PostedInLastNumberOfDays=30
URL template
/vacancy

GET GET vacancy by reference number

Description

Returns details of a specific vacancy. If no vacancy found then a 404 response is returned.

URL template
/vacancy/{vacancyReference}
Back to top