Search for occupations based on specific criteria

Provides simple search capabilities across occupation titles and descriptions

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
KeyWord string — REQUIRED Search by keywords (title, description).  Example: Software developer, software engineer.
Limit int32 Number of records to return per page. Default: 20
Cursor string A cursor identifier for navigating large datasets (used for cursor-based pagination).  Example: T00001
Filter.MajorGroupCode string Filter records by major group code. Example: 11
Filter.MinorGroupCode string Filter records by minor group code. Example: 144
Filter.LastUpdatedAfter date-time Filter by records last updated after this UTC time (exclusive). Example: 2024-06-01T00:00:00Z
Filter.LastUpdatedBefore date-time Filter by records last updated before this UTC time (exclusive). Example: 2024-06-01T23:59:59Z

Header Parameters
x-api-version string Optional API version in header. Overrides URL version if provided.

Responses
200 Success Schema — OPTIONAL nextCursor string — OPTIONAL The first occupation code for the next page of data. currentCursor string — OPTIONAL The first occupation code for the current page of data. totalCount int32 — OPTIONAL The total number of records. data object[] — OPTIONAL The occupation data. occupationCode string — OPTIONAL A code which uniquely identifies the occupation. titleEnglish string — OPTIONAL The occupation title in NZ English. titleMaori string — OPTIONAL The occupation title in Te Reo Māori. titlePluralEnglish string — OPTIONAL The plural of the occupation title in NZ English. titlePluralMaori string — OPTIONAL The plural of the occupation title in Te Reo Māori. altJobTitlesEnglish string[] — OPTIONAL Up to seven ‘also known as’ titles and/or relevant Stats NZ synonyms for the occupation in NZ English. altJobTitlesMaori string[] — OPTIONAL Where available for Kaupapa Māori Occupations, up to seven ‘also known as’ titles and/or relevant Stats NZ synonyms for the occupation in Te Reo Māori. descriptionEnglish string — OPTIONAL A summary of the occupation in NZ English. descriptionMaori string — OPTIONAL Where available for Kaupapa Māori Occupations, a summary of the occupation in Te Reo Māori. kaupapaDescriptionEnglish string — OPTIONAL Where available for Kaupapa Māori Occupations, the Kaupapa summary in NZ English. kaupapaDescriptionMaori string — OPTIONAL Where available for Kaupapa Māori Occupations, the Kaupapa summary in Te Reo Māori. detailedWorkActivitiesEnglish string[] — OPTIONAL The list of Tasks in NZ English. detailedWorkActivitiesMaori string[] — OPTIONAL Where available for Kaupapa Māori Occupations, the list of Tasks in Te Reo Māori. trainingDuration string — OPTIONAL How long someone needs to train to be in this occupation. lifeOnTheJobEnglish string[] — OPTIONAL A description of day-to-day life (Typical working hours, locations, travel, working conditions, physical or emotional demands, and personal attributes) in this occupation in NZ English. lifeOnTheJobMaori string[] — OPTIONAL Where available for Kaupapa Māori Occupations, a description of day-to-day life (Typical working hours, locations, travel, working conditions, physical or emotional demands, and personal attributes) in this occupation in Te Reo Māori. entryRequirements object — OPTIONAL entrySummaryEnglish string — OPTIONAL A high-level description of the entry requirements to get into this occupation in NZ English. entrySummaryMaori string — OPTIONAL Where available for Kaupapa Māori Occupations, a high-level description of the entry requirements to get into this occupation in Te Reo Māori. entryInSchoolEnglish string — OPTIONAL A description of what you need to enter the occupation if you are in school in NZ English. entryInSchoolMaori string — OPTIONAL Where available for Kaupapa Māori Occupations, a description of what you need to enter the occupation if you are in school in Te Reo Māori. entryYouNeedEnglish string[] — OPTIONAL A description of the mandatory requirements you need to enter the occupation in NZ English. entryYouNeedMaori string[] — OPTIONAL Where available for Kaupapa Māori Occupations, a description of the mandatory requirements you need to enter the occupation in Te Reo Māori. entryYouMayNeedEnglish string[] — OPTIONAL A description of what you may need to enter the occupation in NZ English. entryYouMayNeedMaori string[] — OPTIONAL Where available for Kaupapa Māori Occupations, a description of what you may need to enter the occupation in Te Reo Māori. minorGroups object[] — OPTIONAL The minor groups associated with this occupation. minorGroupRelationType string — OPTIONAL Possible values: [Primary, Secondary] minorGroup object — OPTIONAL code string — OPTIONAL A unique identifier for the minor group that the occupation is associated to. nameEnglish string — OPTIONAL The minor group name in NZ English. nameMaori string — OPTIONAL Where available for Kaupapa Māori Occupations, the minor group name in Te Reo Māori. descriptionEnglish string — OPTIONAL A high-level description of the minor group in NZ English. tasks string[] — OPTIONAL A high-level description of the tasks associated with the minor group in NZ English. majorGroups object[] — OPTIONAL The major groups associated with this minor group. majorGroupRelationType string — OPTIONAL Possible values: [Primary, Secondary] majorGroup object — OPTIONAL code string — OPTIONAL A unique identifier for the major group that the minor group is associated to. nameEnglish string — OPTIONAL The major group name in NZ English. nameMaori string — OPTIONAL Where available for Kaupapa Māori Occupations, the major group name in Te Reo Māori. descriptionEnglish string — OPTIONAL A high-level description of the major group in NZ English. renumeration object — OPTIONAL payLowerBound double — OPTIONAL The tenth percentile annual pay for the occupation. All pay fields will be provided as annualised values. payMidLowerBound double — OPTIONAL The first quartile annual pay for the occupation. All pay fields will be provided as annualised values. payMidUpperBound double — OPTIONAL The third quartile annual pay for the occupation. All pay fields will be provided as annualised values. payUpperBound double — OPTIONAL The ninetieth percentile annual pay for the occupation. All pay fields will be provided as annualised values. registrationAuthority object — OPTIONAL nameEnglish string — OPTIONAL The name of the registration authority for the occupation in NZ English. This field will only appear if a Registration Authority exists for the occupation. nameMaori string — OPTIONAL The name of the registration authority for the occupation in Te Reo Māori. This may not be commonly available. This field will only appear if a Registration Authority exists for the occupation. email string — OPTIONAL The email address for the registration authority. This field will only appear if a Registration Authority exists for the occupation. telephone string — OPTIONAL The phone number for the registration authority. This field will only appear if a Registration Authority exists for the occupation. websiteUrl string — OPTIONAL The website address/URL for the registration authority. This field will only appear if a Registration Authority exists for the occupation. lastUpdatedDate date-time — OPTIONAL Contains datetime stamp of record created or last updated. resultsCount int32 — OPTIONAL The number of results returned on the page.
400 Bad Request 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
404 NotFound Schema — OPTIONAL type string — OPTIONAL title string — OPTIONAL status int32 — OPTIONAL detail string — OPTIONAL instance string — OPTIONAL
500 Server error