POST /api/gtec/institutions/search
Price: 30 credits
Search the Ghana Tertiary Education Commission register of accredited tertiary institutions by name, location, category and accreditation status. Each record carries the GTEC institution id, name, category, location, accreditation status and the start and end dates of the accreditation.
Use this to find a Ghanaian tertiary institution and its GTEC id; gtec/institutions takes that id.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)count integer required — Max number of institutions to return (min: 1; max: 1000)name string nullable — Words of the institution name, each matched anywhere in it, ignoring letter case (examples: "University of Ghana", "Nursing Kumasi")location string nullable — Words of the institution location, each matched anywhere in it, ignoring letter case (examples: "Accra", "Kumasi")category string nullable — GTEC institution category (one of: "College of Agriculture", "Private Polytechnic", "Tutorial College", "Distance Learning Institution", "Private College of Education", "Registered Foreign Institution", "Chartered Private Tertiary Institution", "Traditional University", "Regionally-Owned (West Africa) Tertiary Institution", "Public Technical University", "Private Tertiary Institutions Offering HND/Degree Programmes", "Public College of Education", "Private University", "Public Degree Awarding and Professional Institution", "Public Nurses/Health Training College", "Private Nurses/Health Training College")accreditation_status string nullable — Accreditation status of the institution (one of: "active", "expired")@type string (default: "GtecInstitution")id string requiredname string requiredcategory string nullablelocation string nullableaccreditation_status string nullableaccreditation_start_date integer nullableaccreditation_end_date integer nullable422 — 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 — The entity was not found, or a precondition failed 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.