Content management

API Documentation

Interactive REST API reference for all backend endpoints, payloads, required & optional fields, and response schemas.

⚡

Bytecode REST API Specification

v1.0.0

All endpoints use standard JSON request/response formats with HTTP status codes. Click on any endpoint below to inspect schema requirements, sample cURL commands, and responses.

Base URL: /apiTotal Endpoints: 58
Showing 58 matching endpoints

Register a new user account with unique username/phone credentials and an optional role.

Request Payload (application/json)

Payload Fields (Required & Optional)
Field NameTypeRequirementDefaultDescription & Notes
usernamestringRequired—Unique username or phone number (e.g. +919876543210)e.g. +919876543210
roleIdstring | nullOptional—ID of the Role to assigne.g. cmvntewju000810vw8vabpoym
statusstringOptionalactive'active' or 'inactive'e.g. active
Example Request BodyJSON
{
  "username": "+919876543210",
  "roleId": "cmvntewju000810vw8vabpoym",
  "status": "active"
}

Responses & Status Codes

{
  "data": {
    "id": "usr_cmvntgetn000910vwq7a0bjca",
    "username": "+919876543210",
    "status": "active",
    "roleId": "cmvntewju000810vw8vabpoym",
    "createdAt": "2026-10-25T12:40:59.147Z",
    "updatedAt": "2026-10-25T12:40:59.147Z"
  }
}
cURL Request Command
curl -X POST "https://admin.bytecodeitsolutions.co.in/api/users" \
  -H "Content-Type: application/json" \
  -d '{  "username": "+919876543210",  "roleId": "cmvntewju000810vw8vabpoym",  "status": "active"}'

Register a student for a course & batch. If the registration number exists, re-links it to the current profile and returns 200 without duplicate failure.

Request Payload (application/json)

Payload Fields (Required & Optional)
Field NameTypeRequirementDefaultDescription & Notes
courseIdstringRequired—ID of selected Coursee.g. cmvntcwnu000110vw26pp8vqq
profileIdstringRequired—ID of Student Profilee.g. cmvnth5ak000a10vwuf3c3jom
registrationNostringOptional—Formula format: REG_BATCH_NAME_PROFILENAME (auto-generated if omitted)e.g. REG_BATCH_2026_A_AARAV_SHARMA
batchIdstring | nullOptional—ID of assigned Batche.g. cmvntd1r7000610vw1fzyxq6g
Example Request BodyJSON
{
  "courseId": "cmvntcwnu000110vw26pp8vqq",
  "batchId": "cmvntd1r7000610vw1fzyxq6g",
  "profileId": "cmvnth5ak000a10vwuf3c3jom",
  "registrationNo": "REG_BATCH_2026_A_AARAV_SHARMA"
}

Responses & Status Codes

{
  "data": {
    "id": "reg_123",
    "registrationNo": "REG_BATCH_2026_A_AARAV_SHARMA",
    "courseId": "cmvntcwnu000110vw26pp8vqq",
    "batchId": "cmvntd1r7000610vw1fzyxq6g",
    "profileId": "cmvnth5ak000a10vwuf3c3jom"
  }
}
cURL Request Command
curl -X POST "https://admin.bytecodeitsolutions.co.in/api/registrations" \
  -H "Content-Type: application/json" \
  -d '{  "courseId": "cmvntcwnu000110vw26pp8vqq",  "batchId": "cmvntd1r7000610vw1fzyxq6g",  "profileId": "cmvnth5ak000a10vwuf3c3jom",  "registrationNo": "REG_BATCH_2026_A_AARAV_SHARMA"}'

Log a student payment linked to their profile, registration, or enrollment.

Request Payload (application/json)

Payload Fields (Required & Optional)
Field NameTypeRequirementDefaultDescription & Notes
profileIdstringRequired—Student Profile IDe.g. cmvnth5ak000a10vwuf3c3jom
rupeesnumber | stringRequired—Amount received in INR (>= 0)e.g. 5000
paymentMethodstringRequired—upi | cash | bank_transfer | card | cheque | othere.g. upi
registrationIdstring | nullOptional—Linked Registration IDe.g. reg_123
enrollmentIdstring | nullOptional—Linked Enrollment IDe.g. null
paymentProofstring | nullOptional—UTR / Transaction reference ID / receipt screenshot URLe.g. UTR: 324109847291
isVerifiedbooleanOptionalfalseVerification statuse.g. true
Example Request BodyJSON
{
  "profileId": "cmvnth5ak000a10vwuf3c3jom",
  "registrationId": "reg_123",
  "rupees": 5000,
  "paymentMethod": "upi",
  "paymentProof": "UTR: 324109847291",
  "isVerified": true
}

Responses & Status Codes

{
  "data": {
    "id": "pay_789",
    "profileId": "cmvnth5ak000a10vwuf3c3jom",
    "registrationId": "reg_123",
    "rupees": 5000,
    "paymentMethod": "upi",
    "isVerified": true
  }
}
cURL Request Command
curl -X POST "https://admin.bytecodeitsolutions.co.in/api/payments" \
  -H "Content-Type: application/json" \
  -d '{  "profileId": "cmvnth5ak000a10vwuf3c3jom",  "registrationId": "reg_123",  "rupees": 5000,  "paymentMethod": "upi",  "paymentProof": "UTR: 324109847291",  "isVerified": true}'