Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Daniel-Stojanovski/finkiopendesk/llms.txt

Use this file to discover all available pages before exploring further.

The subjects endpoints let you browse and filter the full catalogue of FCSE course subjects. All endpoints are publicly accessible — no authentication token is required. Use the query parameters on GET /api/subjects to narrow results by program, teaching format, difficulty, or semester; use GET /api/subjects/pid/{professionId} when you already know the profession and want every subject that belongs to it. The GET /api/program and GET /api/program-subjects/pid/{professionId} endpoints provide supporting data for program-based filtering and roadmap views.

GET /api/subjects

Returns a filtered list of all subjects. Every parameter is optional; omitting all parameters returns the full catalogue.

Query parameters

query
string
Free-text search against the subject name and description. Case-insensitive.
program
string
Filter by academic program identifier or program name (e.g. "Computer Science").
format
string
Filter by teaching format. Typical values are theoretical and practical, sourced from the Tag.format field on each subject’s tags.
hardness
string
Filter by perceived difficulty. Sourced from the Tag.hardness field (e.g. "easy", "medium", "hard").
semesterType
string
Filter by semester type. Sourced from the Tag.semesterType field (e.g. "winter", "summer").

Response

Returns an array of SubjectDto objects.
subjectId
string
required
Unique identifier for the subject.
name
string
required
Display name of the subject.
description
string
Long-form description of the subject. May be null.
discussion
object
The subject’s associated discussion thread. Present when a discussion has been created for the subject.
tags
SubjectTagDto[]
Active subject-tag associations. Only tags with statusActive: true are included.
curl https://finkiopendesk.onrender.com/api/subjects

GET /api/subjects/pid/

Returns all subjects associated with the given profession. The response shape is identical to the filtered list endpoint above.
Use this endpoint when rendering a subject list for a specific study program or profession page. It is more efficient than fetching all subjects and filtering on the client.

Path parameters

professionId
string
required
The unique identifier of the profession whose subjects you want to retrieve.

Response

An array of SubjectDto objects — same schema as described in the section above.
curl https://finkiopendesk.onrender.com/api/subjects/pid/profession-42

GET /api/program

Returns the list of all academic programs. Use this endpoint to populate program filter dropdowns when calling GET /api/subjects.
This endpoint is public and requires no authentication.

Response

An array of ProgramDto objects.
programId
string
Unique program identifier (e.g. "CS", "SE").
name
string
Short program name.
fullName
string
Full official program name.
aliasFullNameEn
string
English-language alias for the program’s full name.
description
string
Prose description of the program.
curl https://finkiopendesk.onrender.com/api/program

GET /api/program-subjects/pid/{professionId}

Returns subjects linked to a profession with program-subject relationship data including type classification and dependencies. Supports the same optional filters as GET /api/subjects.
This endpoint is public and requires no authentication.

Path parameters

professionId
string
required
The unique identifier of the profession.

Query parameters

query
string
Free-text search against subject name.
program
string
Filter by academic program identifier.
format
string
Filter by teaching format.
hardness
string
Filter by difficulty level.
semesterType
string
Filter by semester type.

Response

An array of ProgramSubjectDto objects. Each entry includes the subject, its type within the program (MANDATORY, ELECTIVE, or OTHER), and a list of prerequisite subject IDs.
curl https://finkiopendesk.onrender.com/api/program-subjects/pid/sw-engineer

Build docs developers (and LLMs) love