POST /api/opintopolku/programs
Price: 10 credits
Get one study programme from Opintopolku (Studyinfo), Finland's national study catalogue: names and description in Finnish, Swedish and English, type, qualification and degree titles, field of study, EQF level, credits, learning outcomes, the institutions providing it and every implementation with its provider
Look up one programme by the id opintopolku/programs/search returns. Each entry of `implementations` is one provider's offering; pass its `id` to opintopolku/implementations for fees, teaching and application options.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)program string required — Opintopolku programme id or its opintopolku.fi page URL (examples: "1.2.246.562.13.00000000000000000187", "https://opintopolku.fi/konfo/fi/koulutus/1.2.246.562.13.00000000000000011501"; minLength: 1)@type string (default: "OpintopolkuProgram")id string requiredurl string nullablename object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableprogram_type string nullableprogram_type_path string nullablestatus string nullableis_public boolean nullableis_degree_programme boolean nullabledescription object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablelearning_outcomes object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableadditional_info array (default: [])@type string (default: "OpintopolkuSection")heading object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullabletext object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablequalifications array (default: [])@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablequalification_classifications array (default: [])@type string (default: "OpintopolkuQualificationClassification")qualification_code string nullablefield_codes array (default: [])level_codes array (default: [])degree_titles array (default: [])@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablefields_of_study array (default: [])@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableeqf_levels array (default: [])@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablenqf_levels array (default: [])@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablecredits number nullablecredits_min number nullablecredits_max number nullablecredits_unit object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablecredits_code object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablestudy_type object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablecompetence_area object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablespecialisation object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablequalification_units array (default: [])@type string (default: "OpintopolkuQualificationUnit")unit object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableunit_id string nullableunit_reference_id string nullablequalification object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableeperuste_id string nullablecredits number nullablecredits_unit object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablehigher_education_types array (default: [])@type string (default: "OpintopolkuHigherEducationType")program_type string nullableprovider_ids array (default: [])keywords array (default: [])is_open_university boolean nullablecourse_code string nullablebadge_code string nullableeperuste_id string nullablequalification_basis object nullable@type string (default: "OpintopolkuQualificationBasis")id string nullableregister_number string nullablevalid_until integer nullableeperuste_url object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableadmission_restriction object nullable@type string (default: "OpintopolkuAdmissionRestriction")id string nullablename object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullabledescription object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableprogram_type string nullablestatus string nullableorganisation object nullable@type string (default: "OpintopolkuOrganisation")id string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablemunicipality object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullablelanguages array (default: [])modified_at integer nullableorganisation object nullable@type string (default: "OpintopolkuOrganisation")id string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablemunicipality object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableorganisation_ids array (default: [])providers array (default: [])@type string (default: "OpintopolkuOrganisation")id string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablemunicipality object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableimplementation_count integer (default: 0)implementations array (default: [])@type string (default: "OpintopolkuProgramImplementation")id string requiredurl string nullablename object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablestatus string nullableorganisation object nullable@type string (default: "OpintopolkuOrganisation")id string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablemunicipality object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable (see schema OpintopolkuText)organisation_ids array (default: [])providers array (default: [])@type string (default: "OpintopolkuOrganisation")id string requiredname object nullable (see schema OpintopolkuText)municipality object nullable (see schema OpintopolkuCode)modified_at integer nullableapplication_round_ids array (default: [])external_id string nullableimage string nullablelanguages array (default: [])modified_at integer nullableindexed_at 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 — No programme 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.