Students API
The Students API allows you to manage student accounts, enrollments, and progress programmatically.
Base URL
https://api.euronsystems.com/v1/students
Endpoints
List Students
GET /v1/students
Query Parameters:
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number |
| limit | integer | Items per page (max: 100) |
| search | string | Search by name or email |
| status | string | active, inactive, blocked |
| course_id | string | Filter by enrolled course |
| created_after | ISO date | Filter by registration date |
Response:
{
"data": [
{
"id": "student_xyz789",
"name": "Priya Sharma",
"email": "priya@example.com",
"phone": "+91-9876543210",
"status": "active",
"enrollments_count": 3,
"total_spent": 8997,
"created_at": "2025-02-10T08:15:00Z",
"last_active_at": "2025-03-20T16:45:00Z"
}
],
"meta": {
"total": 1250,
"page": 1,
"limit": 20,
"total_pages": 63
}
}
Get Student Details
GET /v1/students/:id
Returns the full student profile including enrollments, progress, and activity history.
Create Student
POST /v1/students
{
"name": "Rahul Kumar",
"email": "rahul@example.com",
"phone": "+91-9876543210",
"send_welcome_email": true
}
Update Student
PATCH /v1/students/:id
Get Student Progress
GET /v1/students/:id/progress
Returns progress data for all enrolled courses:
{
"data": [
{
"course_id": "course_abc123",
"course_title": "Complete Python Bootcamp",
"progress_percentage": 68,
"lessons_completed": 34,
"total_lessons": 50,
"quiz_average_score": 82,
"last_accessed": "2025-03-20T14:30:00Z"
}
]
}
Get Student Certificates
GET /v1/students/:id/certificates
Related Documentation
- Authentication — API key setup
- Courses API — Course management
- Payments API — Transaction data