Get started with the recruitment APIs as an employer
How employers can access recruitment APIs and API keys using their apprenticeship service account.
Applies to England
What do our APIs do?
APIs (Application Programming Interfaces) let applications share information and data with each other.
We have two APIs you can use:
-
Recruitment API – our Recruitment API allows you to create adverts on Find an apprenticeship using your own systems
-
Display adverts API – our Display adverts API allows you to display adverts from Find an apprenticeship on your own websites
How do I use the APIs?
You’ll need someone with technical knowledge to connect your system with the API, for example a software developer.
You can share this developer get started page with the person who is going to connect your system with the API, they can access the API from there.
You will need to give your developer API keys. The keys give your developer permission to connect to the API on your behalf.
Your developer will also be able able to try out the API using the sandbox provided.
Where do I access the API Key?
If you have owner permissions you will be able to access the API keys here.