Skip to main content
Use GET /v1/subjects to retrieve all your subject profiles. Each subject includes its type, color, weekly time slots, and the syllabus associated with it.

Endpoint

Query Parameters

string
Filter subjects by type. Accepted values: study, training, inactive. Omit this parameter to return all subjects regardless of type.

Response

Returns an array of subject objects inside the data field.
string
Unique identifier for the subject.
string
Display name of the subject.
string
The subject type. One of study, training, or inactive.
string
Hex color code used to represent this subject in the app (e.g. #6366f1).
array
Array of weekly time slot objects. Each slot defines the days of the week and time range when this subject is scheduled.
array
An array of syllabus topic objects for this subject. Each object contains title (string), duration (integer, minutes), and done (boolean).
Example response

Examples

Omit the type query parameter to retrieve all subjects across all types in a single request.