POST /api/campusfrance/institutions/search
Price: 10 credits
List the French universities, schools and university components in the Campus France master and licence (bachelor-level) directories by name, region, city, kind and directory. Each institution carries its Campus France code, city, region, its number of master and licence programmes and its Bienvenue en France star rating.
Pass an institution `id` as `institution` to campusfrance/programs/search for its programmes; a university's `id` also matches the programmes of its components.
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)name string nullable — Text contained in the institution name, in any letter case (examples: "Sorbonne"; minLength: 1)region array nullable — French regions; several values match any of them (one of: "Grand Est", "Nouvelle-Aquitaine", "Auvergne-Rhône-Alpes", "Bourgogne-Franche-Comté", "Bretagne", "Centre-Val de Loire", "Corse", "Ile-de-France", "Occitanie", "Hauts-de-France", "Normandie", "Pays de la Loire", "Provence-Alpes-Côte d'Azur", "Dom Tom")city string nullable — City of the school, in any letter case (examples: "Lyon"; minLength: 1)kind string nullable — Universities or schools and university components (one of: "university", "school")catalogue string nullable — Only institutions with master programmes, or only those with licence programmes (one of: "master", "licence")@type string (default: "CampusfranceInstitution")id string requiredinstitution_number string nullablename string nullablekind string nullable (one of: "university", "school")city string nullableregion string nullableregion_id integer nullablemaster_program_count integer nullablelicence_program_count integer nullablewelcome_label object nullable@type string (default: "CampusfranceWelcomeLabel")stars integer nullableurl string 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.