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).

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.

Access and authentication

To get access to the API, you will need an account on careers.govt.nz.

Access to the careers.govt.nz API will be granted on receipt of a signed memorandum of understanding.

You will also need to request an access password. Please use the form on our contact page for this. (Select 'request for API access' in the subject field.)

The API has basic authentication via HTTP.

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:

  • have your password ready

  • 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 13 Jun 2024