POST /api/opintopolku/institutions/programs
Price: 20 credits
List everything one Finnish institution teaches according to Opintopolku (Studyinfo): one row per programme implementation with its name, programme id, type, municipalities, teaching languages and times, fees, scholarship, planned duration and whether the application is open. Filter by teaching language, region, municipality, teaching method, an application opening soon, planned duration, programme type and field of study
Pass a row's `program_id` to opintopolku/programs or its `implementation_id` to opintopolku/implementations.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)program_types array nullable — Study offering types, any of; a broad type covers its narrower ones (one of: "university", "university_bachelor", "university_bachelor_and_master", "university_master", "university_doctorate", "university_open_course", "university_course", "university_open_study_module", "university_study_module", "teacher_pedagogical_studies", "medical_specialist_training", "university_specialisation", "uas", "uas_bachelor", "uas_master", "vocational_teacher_training", "uas_open_course", "uas_course", "uas_open_study_module", "uas_study_module", "uas_specialisation", "vocational", "vocational_upper_secondary", "further_vocational", "specialist_vocational", "other_vocational_qualification", "vocational_competence_area", "vocational_qualification_unit", "other_vocational", "general_upper_secondary", "preparatory", "preparatory_for_upper_secondary", "preparatory_for_work_and_independent_living", "folk_high_school_year", "special_needs", "special_needs_vocational", "special_needs_preparatory", "liberal_adult_education", "liberal_adult_education_course", "liberal_adult_education_badge", "basic_education_for_adults", "basic_art_education", "other"; examples: ["uas_master"])fields_of_study array nullable — Fields of study, any of; a broad field covers narrower ones (one of: "generic_programmes", "education", "arts_and_humanities", "arts_and_humanities_broad", "arts", "humanities", "languages", "social_sciences_journalism_and_information", "social_and_behavioural_sciences", "journalism_and_information", "business_administration_and_law", "business_and_administration", "law", "natural_sciences_mathematics_and_statistics", "natural_sciences_broad", "biological_sciences", "environment", "physical_sciences", "mathematics_and_statistics", "ict", "engineering_manufacturing_and_construction", "engineering", "manufacturing_and_processing", "architecture_and_construction", "agriculture_forestry_fisheries_and_veterinary", "agriculture_broad", "agriculture", "forestry", "fisheries", "veterinary", "health_and_welfare", "health_and_welfare_broad", "health", "welfare", "services", "services_broad", "personal_services", "security_services", "transport_services", "unknown"; examples: ["ict","health"])teaching_languages array nullable — Languages of instruction, any of (one of: "finnish", "swedish", "finnish_and_swedish", "english", "sami", "other"; examples: ["english"])regions array nullable — Finnish regions where it is taught, any of (one of: "uusimaa", "southwest_finland", "satakunta", "kanta_hame", "pirkanmaa", "paijat_hame", "kymenlaakso", "south_karelia", "south_savo", "north_savo", "north_karelia", "central_finland", "south_ostrobothnia", "ostrobothnia", "central_ostrobothnia", "north_ostrobothnia", "kainuu", "lapland", "aland"; examples: ["uusimaa"])municipalities array nullable — Municipality codes where it is taught, any of (examples: ["091","049"])teaching_methods array nullable — Ways the teaching is delivered, any of (one of: "contact", "distance", "online", "blended", "independent", "apprenticeship"; examples: ["online"])is_application_opening_soon boolean nullable — Only offerings whose application period opens within 30 days (examples: true)duration_months_min integer nullable — Shortest planned duration in months (examples: 12; min: 0)duration_months_max integer nullable — Longest planned duration in months (examples: 24; min: 0)institution string required — Opintopolku institution id or its opintopolku.fi page URL (examples: "1.2.246.562.10.56753942459", "https://opintopolku.fi/konfo/fi/oppilaitos/1.2.246.562.10.38515028629"; minLength: 1)count integer required — Max number of implementations to return (min: 1; max: 2000)@type string (default: "OpintopolkuOffering")implementation_id string requiredimplementation_url string nullablename object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableprogram_id string nullableinstitution_id string nullableinstitution_name object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableinstitution_status string nullabledescription object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableprogram_type string nullabledegree_titles array (default: [])@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableteaching_language_codes array (default: [])teaching_times array (default: [])@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablemunicipalities array (default: [])@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablefee_types array (default: [])fee number nullabletuition_fee number nullablehas_scholarship boolean nullableduration_months integer nullableis_application_open boolean nullableis_special_needs_education boolean nullableis_special_needs_vocational boolean nullablehas_athlete_vocational_training boolean nullableimage 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 — No institution is published under this id 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.