POST /api/nzqa/organizations
Price: 10 credits
Get one education organisation from New Zealand's NZQA register: name, organisation number, address, phone, e-mail, Code of Practice signature, registration notes, every delivery site with its address, and the degrees, programmes and micro-credentials it is accredited to deliver
Pass an id from nzqa/organizations/search. moe_number is the number nzqa/programmes/search takes as owner.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)organization string required — NZQA organisation id, or its page URL (examples: "668369001", "https://www.nzqa.govt.nz/providers/details.do?providerId=668369001")@type string (default: "NzqaOrganization")id string requiredname string nullabletrading_as string nullablemoe_number string nullablelocation_number string nullablecontact_name string nullableaddress string nullablephone string nullablefreephone string nullablefax string nullableemail string nullablewebsite string nullablecategory integer nullableregistered_date integer nullablequality_status array (default: [])quality_reports array (default: [])@type string (default: "NzqaQualityReport")year integer nullableurl string nullableassessment_report_url string nullableis_code_of_practice_signatory boolean nullableoffers_qualifications boolean nullableoffers_micro_credentials boolean nullablehas_consent_to_assess boolean nullablestatutory_actions array (default: [])delivery_sites array (default: [])@type string (default: "NzqaDeliverySite")name string nullablelocation string nullablemoe_number string nullablesite_number string nullableaddress string nullablephone string nullableprovider_id string nullabledegree_accreditations array (default: [])@type string (default: "NzqaAccreditation")title string nullablelevel_from integer nullablelevel_to integer nullablecourse_version_id string nullablepartner object nullable@type string (default: "NzqaOrganizationRef")id string nullablemoe_number string nullablename string nullableprogramme_accreditations array (default: [])@type string (default: "NzqaAccreditation")title string nullablelevel_from integer nullablelevel_to integer nullablecourse_version_id string nullablepartner object nullable@type string (default: "NzqaOrganizationRef")id string nullablemoe_number string nullablename 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 with this id is in the register 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.