API Reference
Integration endpoints for the Viddarpan ERP platform.
Version: v1Updated: 11/20/2023
Authentication
All API endpoints require a Bearer token in the Authorization header.
bash
Endpoints
GET/v1/users
Retrieve a list of users associated with your institution.
Parameters:
rolestringFilter by user role (student, parent, teacher, admin)
limitnumberPagination limit (default 50)
Response
POST/v1/attendance
Submit daily attendance records in bulk.
Parameters:
classIdstringThe ID of the class
recordsarrayArray of student IDs and their attendance status
Response
Rate Limits
The API is strictly rate-limited to 1000 requests per minute per IP address.
Error Codes
401 Unauthorized: Invalid or missing API key.403 Forbidden: API key lacks sufficient permissions.429 Too Many Requests: Rate limit exceeded.