Skip to main content

Retrieve a list of occupations

Returns JSON array of occupation records including pagination metadata.

Supports filtering of occupations by major group, minor group, or last updated date

Cursor-based pagination is supported - see docs page for more information.

Query Parameters
Limit int32
Cursor string
Filter.MajorGroupCode string
Filter.MinorGroupCode string
Header Parameters
x-api-version string

Optional API version in header. Overrides URL version if provided.

Responses
200

Success

Schema OPTIONAL
nextCursor string OPTIONAL
currentCursor string OPTIONAL
totalCount int32 OPTIONAL
data object[] OPTIONAL
occupationCode string OPTIONAL
titleEnglish string OPTIONAL
titleMaori string OPTIONAL
titlePluralEnglish string OPTIONAL
titlePluralMaori string OPTIONAL
descriptionEnglish string OPTIONAL
descriptionMaori string OPTIONAL
isKaupapaMaori boolean OPTIONAL
kaupapaDescriptionEnglish string OPTIONAL
kaupapaDescriptionMaori string OPTIONAL
trainingDuration string OPTIONAL
lastUpdatedDate date-time OPTIONAL
entryRequirements object OPTIONAL
entrySummaryEnglish string OPTIONAL
entrySummaryMaori string OPTIONAL
entryInSchoolEnglish string OPTIONAL
entryInSchoolMaori string OPTIONAL
entryYouNeedEnglish string[] OPTIONAL
entryYouNeedMaori string[] OPTIONAL
entryYouMayNeedEnglish string[] OPTIONAL
entryYouMayNeedMaori string[] OPTIONAL
remuneration object OPTIONAL
payLowerBound double OPTIONAL
payMidLowerBound double OPTIONAL
payMidUpperBound double OPTIONAL
payUpperBound double OPTIONAL
payMedian double OPTIONAL
registrationAuthority object OPTIONAL
name string OPTIONAL
maoriName string OPTIONAL
email string OPTIONAL
telephone string OPTIONAL
websiteUrl string OPTIONAL
minorGroups object[] OPTIONAL
groupRelationType string OPTIONAL

Possible values: [Primary, Secondary]

minorGroup object OPTIONAL
code string OPTIONAL
nameEnglish string OPTIONAL
nameMaori string OPTIONAL
descriptionEnglish string OPTIONAL
tasks string[] OPTIONAL
majorGroups object[] OPTIONAL
groupRelationType string OPTIONAL

Possible values: [Primary, Secondary]

majorGroup object OPTIONAL
code string OPTIONAL
nameEnglish string OPTIONAL
nameMaori string OPTIONAL
descriptionEnglish string OPTIONAL
altJobTitlesEnglish string[] OPTIONAL
altJobTitlesMaori string[] OPTIONAL
detailedWorkActivitiesEnglish object[] OPTIONAL
activity string OPTIONAL
sortOrder double OPTIONAL
detailedWorkActivitiesMaori object[] OPTIONAL
activity string OPTIONAL
sortOrder double OPTIONAL
lifeOnTheJobsEnglish string[] OPTIONAL
lifeOnTheJobsMaori string[] OPTIONAL
resultsCount int32 OPTIONAL
400

BadRequest

Schema OPTIONAL
type string OPTIONAL
title string OPTIONAL
status int32 OPTIONAL
detail string OPTIONAL
instance string OPTIONAL
401

Unauthorized

Schema OPTIONAL
type string OPTIONAL
title string OPTIONAL
status int32 OPTIONAL
detail string OPTIONAL
instance string OPTIONAL
500

Server error