How to get an API of our job profile content
Find out how to access job and industry information through the careers.govt.nz API (application program interface).
What's on this page?
Important update
- Careers.govt.nz will be retired by the end of 2025, and the API will no longer be available.
- Please factor this in if you're thinking of using it.
- We're transitioning to a new Careers planning website. It will have its own API with new data fields and will be available in 2025.
What does the API give you?
The careers.govt.nz jobs and industries application programming interface (API) lets you access information about more than 400 types of jobs in New Zealand.
Job information on careers.govt.nz covers:
-
jobs by industry
-
what a job involves
-
how to enter the job
-
opportunities associated with the job.
The API makes available two sections of this information:
-
Jobs.
-
Industries.
Getting started
The jobs and industries API is designed to be easy to use. There are, however, a few things you need to know before you start using it.
Pay, entry requirement and job opportunity information is specific to New Zealand, so this API isn't suitable for other countries.
Accessing the API
To get access to the API:
- Go to our contact page.
- Select 'Request for API access' as the subject.
- Send us a message telling us why you'd like the API, and the website you'd like it for.
- We will assess your request.
- We may send you a Memorandum of Understanding to sign and send back.
- After this, we may grant access to the API.
Note: To use the API, you will need an account on careers.govt.nz.
Formats supported
The careers.govt.nz API only supports JavaScript Object Notation (JSON) response format.
Creating an API request
To make an API request, you’ll need to know the section and, if applicable, the item you want to retrieve.
Here's an example of an API request in URI format:
https://api.careers.govt.nz/v2/{section}
or
https://api.careers.govt.nz/v2/{section}?{item}
Where the field:
-
section = pageType or controller (jobs or industry)
-
item = data parameters
Updated 5 Sep 2024