Developer
Build on top of RedeemOS
The RedeemOS API gives Enterprise plan customers programmatic access to their school data, enabling custom integrations, third-party dashboard connections, workflow automation, and data exports.
Authentication
The RedeemOS API uses API key authentication. Each Enterprise school is issued a unique API key from their administrator settings. Keys are scoped to a single school database and cannot access data from other schools.
Bearer token (API key)Authorization: Bearer {api_key}Single school databaseVia administrator settings1,000 requests/hour (default)Example request
# List students
curl https://api.redeemos.com/v1/students \
-H "Authorization: Bearer {api_key}" \
-H "Content-Type: application/json"
# Response
{
"data": [{
"id": "stu_01abc...",
"name": "Ama Owusu",
"class": "JHS 2A"
} ],
"total": 247,
"page": 1
}
API endpoint groups
List, create, update, and manage student records and enrollments.
GET /studentsPOST /studentsGET /students/{id}PATCH /students/{id}Retrieve and submit attendance records by class and date.
GET /attendancePOST /attendance/bulkQuery invoices, payments, and balances. Create payment records.
GET /invoicesGET /invoices/{id}POST /paymentsAccess staff records, roles, and HR data.
GET /staffGET /staff/{id}Trigger report generation and retrieve report data.
POST /reports/generateGET /reports/{id}Subscribe to real-time events from the platform.
POST /webhooksGET /webhooksDELETE /webhooks/{id}Webhooks
RedeemOS webhooks deliver real-time event notifications to your endpoint when actions occur on the platform. Configure webhook endpoints from your administrator settings.
Available events
student.enrolledstudent.updatedattendance.markedpayment.receivedinvoice.createdreport_card.publishedstaff.addedannouncement.sentMore events available in full documentation.
Enterprise API Standards
The RedeemOS Developer Platform is designed for mission-critical institutional operations, providing strict SLA guarantees, deterministic rate limits, and cryptographic payload verification.
Granular Scope Tokens
Generate read-only or read-write API keys scoped strictly to specific domains, such as student admissions or fee balance checks.
High Throughput SLAs
Process batch enrollments and attendance uploads with up to 2,500 requests per minute and sub-80ms global API response times.
Immutable Audit Logging
Every API mutation and query is logged with IP origin, timestamp, user agent, and response status for compliance auditing.
Frequently Asked Questions
Ready to build on RedeemOS?
API access is included with Enterprise plans. Contact us to discuss your integration requirements.