POST /api/nzqa/organizations/search
Price: 20 credits
Search New Zealand's register of education organisations (universities, polytechnics, wananga, private training establishments, schools and others) by name or place, region, type, evaluation category and Code of Practice signature. Each organisation carries its id, name and the name and place of every delivery site
With no filter it lists every organisation in the register. Pass a returned id to nzqa/organizations for contacts, sites and accreditations, or as organization to nzqa/qualifications/search.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)keyword string nullable — Words in the name of the organisation or one of its sites, or in a site's place (examples: "Auckland"; minLength: 1)region string nullable — Region of a delivery site (one of: "Northland", "Auckland", "Waikato", "Bay of Plenty", "Taranaki", "Whanganui", "Taupo", "East Coast", "Hawkes Bay", "Manawatu", "Wairarapa", "Wellington", "Nelson", "West Coast", "Canterbury", "South Canterbury", "Otago", "North Otago", "Central Otago", "Southland", "Pacific Islands"; examples: "Canterbury")organization_type string nullable — Organisation type (one of: "COW", "GTE", "ISB", "POLLY", "PTE", "SCHOOL", "UNI", "WANA", "WDC"; examples: "UNI")category string nullable — NZQA external evaluation category (one of: "1", "2", "3", "4"; examples: "1")is_code_of_practice_signatory boolean nullable — Whether the organisation signed the Code of Practice for the pastoral care of students (examples: true)count integer required — Max number of organisations to return (min: 1; max: 2000)@type string (default: "NzqaOrganizationResult")id string requiredname string nullablesites array (default: [])@type string (default: "NzqaSiteRef")name string nullablelocation 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 organisation 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.