Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/aakash811/Student-Progress-Tracker/llms.txt

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

The list endpoint returns every student stored in SkillSync’s database as a JSON array. Each element is a full student object containing profile fields, Codeforces ratings, sync metadata, and the complete contestData and submissions arrays. Because submissions can reach up to 10,000 entries per student, response payloads can be large for active users.

​
Request

GET /api/students
No authentication, query parameters, or request body is required.

​
Example

curl https://your-app.onrender.com/api/students

​
Response

Returns 200 OK with a JSON array of student objects. 
[
  {
    "_id": "664a1f2e8c3b2a001f4e7d91",
    "name": "Alice Sharma",
    "email": "alice@example.com",
    "phoneNo": "+91-9876543210",
    "codeforcesHandle": "tourist",
    "currRating": 3779,
    "rank": "Legendary Grandmaster",
    "maxRating": 3979,
    "lastSyncedAt": "2026-05-07T08:00:00.000Z",
    "lastActiveAt": "2026-05-06T14:32:11.000Z",
    "emailRemindersSent": 0,
    "emailRemindersDisabled": false,
    "contestData": [
      {
        "contestId": 1991,
        "contestName": "Codeforces Round 957 (Div. 1)",
        "handle": "tourist",
        "rank": 1,
        "ratingUpdateTimeSeconds": 1716825600,
        "oldRating": 3756,
        "newRating": 3779
      }
    ],
    "submissions": [
      {
        "id": 262144001,
        "contestId": 1991,
        "creationTimeSeconds": 1716823412,
        "problem": { "name": "Subsequence Update", "rating": 2800, "tags": ["dp"] },
        "verdict": "OK",
        "programmingLanguage": "GNU C++20 (64)"
      }
    ],
    "createdAt": "2026-04-01T10:00:00.000Z",
    "updatedAt": "2026-05-07T08:00:01.000Z"
  },
  {
    "_id": "664a1f2e8c3b2a001f4e7d92",
    "name": "Bob Patel",
    "email": "bob@example.com",
    "phoneNo": "+91-9123456780",
    "codeforcesHandle": "Um_nik",
    "currRating": 3536,
    "rank": "Legendary Grandmaster",
    "maxRating": 3600,
    "lastSyncedAt": "2026-05-07T08:00:05.000Z",
    "lastActiveAt": "2026-05-01T09:14:55.000Z",
    "emailRemindersSent": 1,
    "emailRemindersDisabled": false,
    "contestData": [],
    "submissions": [],
    "createdAt": "2026-04-10T12:30:00.000Z",
    "updatedAt": "2026-05-07T08:00:06.000Z"
  }
]

​
Response fields

​
_id
string
MongoDB ObjectId uniquely identifying the student record.
​
name
string
The student’s full name.
​
email
string
The student’s unique email address.
​
phoneNo
string
The student’s phone number.
​
codeforcesHandle
string
The student’s Codeforces username.
​
currRating
number
Current Codeforces rating. 0 for unrated users.
​
rank
string
Codeforces rank label (e.g., "Newbie", "Expert", "Legendary Grandmaster").
​
maxRating
number
Highest Codeforces rating ever achieved by this student.
​
lastSyncedAt
string (ISO 8601 date)
Timestamp of the most recent Codeforces data sync.
​
lastActiveAt
string (ISO 8601 date) | null
Timestamp of the student’s most recent accepted Codeforces submission. null if none recorded.
​
emailRemindersSent
number
Number of inactivity reminder emails sent in the current inactive streak.
​
emailRemindersDisabled
boolean
Whether automated inactivity emails are disabled for this student.
​
contestData
array
Array of rating-change objects from all rated Codeforces contests the student has participated in.
​
submissions
array
Array of the student’s most recent Codeforces submissions (up to 10,000).
​
createdAt
string (ISO 8601 date)
Timestamp when the student record was first created.
​
updatedAt
string (ISO 8601 date)
Timestamp of the most recent update to the student document.

​
Errors

StatusBodyCause
500 Internal Server Error{ "error": "..." }Database query failed.

Build docs developers (and LLMs) love

Get started for freeTalk to us