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 professions endpoints give you access to the full catalog of career paths available on FinkiOpenDesk. This page also documents the GET /api/tags and GET /api/profession-program support endpoints used for tag-based filtering and profession-program relationship lookups. Each profession represents a distinct job role or field of work that FCSE students can explore, complete with an optional alternative name, a description, a linked discussion thread, a list of recommended subjects, and the degree programs from which that career is reachable.

​
GET /api/professions

Returns every profession in the system. When the optional query parameter is supplied, only professions whose name matches the search term are returned. The endpoint is public and requires no authentication.

​
Query parameters

​
query
string
Search term to filter professions by name. Omit this parameter to retrieve all professions.

​
Response

An array of ProfessionDto objects. Returns an empty array when no professions match the query.
​
professionId
string
required
Unique identifier for the profession.
​
name
string
required
Display name of the profession (for example, “Software Engineer”).
​
alternativeName
string
Secondary or colloquial name for the profession. May be null if no alternative name is defined.
​
description
string
A longer prose description of the profession’s responsibilities and context. May be null.
​
discussion
object
The discussion thread associated with this profession.
​
recommendedSubjects
object[]
Array of subjects recommended for this profession.
​
programs
object[]
Degree programs from which this profession is reachable (only applicable programs are included).

​
Examples

curl https://finkiopendesk.onrender.com/api/professions

​
GET /api/professions/{professionId}

Fetches a single profession by its ID. The response shape is identical to a single element from the list endpoint above.

​
Path parameters

​
professionId
string
required
The unique identifier of the profession to retrieve.

​
Response

A single ProfessionDto object. Returns 404 if no profession with the given ID exists.

​
Example

curl https://finkiopendesk.onrender.com/api/professions/sw-engineer

​
GET /api/tags

Returns all tags in the system. Tags encode the program, format, hardness, and semester type metadata used to filter subjects via GET /api/subjects.
This endpoint is public and requires no authentication.

​
Response

An array of TagDto objects.
​
tagId
string
Unique tag identifier.
​
name
string
Display name for the tag.
​
program
string
The academic program this tag belongs to.
​
format
string
Teaching format (e.g. theoretical, practical).
​
hardness
string
Perceived difficulty level (e.g. easy, medium, hard).
​
semesterType
string
Semester type (e.g. winter, summer).
curl https://finkiopendesk.onrender.com/api/tags

​
GET /api/profession-program/pid/{id}

Returns the profession-program relationship records for a given profession. Use applicable to get only the programs that cover a sufficient number of the profession’s recommended subjects.
This endpoint is public and requires no authentication.

​
Variants

EndpointDescription
GET /api/profession-program/pid/{id}All program associations for a profession
GET /api/profession-program/pid/{id}/applicablePrograms that adequately cover the profession’s subjects
GET /api/profession-program/ppid/{id}/applicableProfessions covered by a given program

​
Path parameters

​
id
string
required
Profession ID (for the pid variants) or program ID (for the ppid variant).

​
Response

An array of ProfessionProgramDto objects representing the relationships between the profession and its associated degree programs. 
curl https://finkiopendesk.onrender.com/api/profession-program/pid/sw-engineer/applicable

Build docs developers (and LLMs) love

Get started for freeTalk to us