POST /api/nzqa/qualifications/search
Price: 10 credits
Search New Zealand's NZQF qualification register by title words or number, type, level, credits, status, subject area and organisation. Each qualification carries its number, title, status, type, level and credit range and the organisation it belongs to
Returns at most 200 qualifications per query; narrow by type, level or credits to reach the rest. Pass a returned id to nzqa/qualifications for the full record.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)keyword string nullable — Words in the qualification title, or a qualification number (examples: "nursing"; minLength: 1)qualification_type string nullable — Qualification type group (one of: "Certificate", "Diploma", "Degree", "PostGrad"; examples: "Degree")level integer nullable — NZQF level (examples: 7; min: 1; max: 10)credits string nullable — Credit band (one of: "0-120", "121-240", "241-360", "361-999"; examples: "241-360")status string nullable — Qualification status; every status when omitted (one of: "Current", "Expiring", "Discontinued"; examples: "Current")subject integer nullable — NZSCED subject area id from the register's subject tree (examples: 76453; min: 1)organization string nullable — NZQA organisation id, or its page URL (examples: "668369001", "https://www.nzqa.govt.nz/providers/details.do?providerId=668369001")count integer required — Max number of qualifications to return (min: 1; max: 200)@type string (default: "NzqaQualificationResult")id string requiredtitle string nullablestatus string nullablequalification_type string nullablelevel_from integer nullablelevel_to integer nullablecredits_from integer nullablecredits_to integer nullableorganization object nullable@type string (default: "NzqaOrganizationRef")id string nullablemoe_number string nullablename string nullableorganization_count integer nullableorganization_note string nullableurl string required422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.412 — No qualification in the register matches these filters Retrying will not help: either the entity does not exist, or the input points at a different one.429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.X-Error — Error message text (present only on error)X-Request-ID — Unique request identifierX-Execution-Time — Execution time in secondsX-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.X-Retry-After — Seconds to wait before retrying. Present only on 429.