Skip to main content
Hero Light

​
Key Features

Here’s what you’ll learn:
  • Seamless student and user management for educational institutions.
  • Page-based pagination for efficient handling of large datasets.
  • Comprehensive engagement tracking and analytics.
  • Auto-login URL generation for seamless student access.

​
How to get Authentication token

You will find the token under Configuration -> Domain Setup -> API Key Hero Light

​
Use Cases

​
1. Student Account Management

Efficiently manage student accounts with our APIs designed specifically for educational institutions. From creating new student accounts to tracking their progress, these endpoints empower you to:
  • Seamlessly Create Student Accounts: Add new students with essential details such as their first name, last name, email and unique user ID.
    Example: Create a new student account when they enroll in your career development program.
{
  firstName: "Jane",
  lastName: "Smith",
  email: "[email protected]",
  uniqueUserId: "STU001"
}
  • Search and Retrieve Student Profiles: Quickly fetch student data based on unique identifiers (e.g., email, userId, or uniqueUserId). Use this to build a detailed student dashboard or verify user details before providing services.
    Example: Search for a student by their university email.
GET /users?email=jane@university.edu
  • Update Student Information: Modify student details as needed, with partial update support for flexible management.
    Example: Update a student’s email address when they change their contact information.
PUT /users/{userId}
body {
  "email": "[email protected]",
  "uniqueUserId": "STU001_UPDATED"
}

​
2. Engagement Tracking and Analytics

Monitor student engagement and progress with comprehensive tracking features:
  • Page-based Pagination: Handle large datasets efficiently with page-based pagination for better performance.
    Example: Retrieve students with pagination for large institutions.
GET /users?page=1&limit=50
  • Advanced Filtering: Filter students by various criteria including account status, onboarding completion, and engagement metrics.
    Example: Find students who haven’t completed their resume.
GET /users?hasNoResumes=true&accountStatus=active
  • Engagement Statistics: Track detailed engagement metrics including resume creation, job applications, mock interviews, and more.

​
3. Seamless Student Access

Provide students with easy access to career development tools:
  • Auto-login URL Generation: Generate secure auto-login URLs for seamless student access without complex authentication.
    Example: Provide students with direct access links to their career dashboard.
{
  "autoLoginUrl": "https://domain.com/autologin/code",
  "autoLoginCode": "autologin_code"
}
  • Account Status Management: Activate or deactivate student accounts as needed while preserving their data for compliance or reactivation purposes.

​
Institution vs Reseller APIs

Institution APIs:
  • Designed for schools and educational institutions
  • No payment processing or subscription management
  • Page-based pagination for large datasets
  • Student-focused terminology (users instead of customers)
  • Simplified account management
Reseller APIs:
  • Designed for business partners and resellers
  • Full payment processing and subscription management
  • Offset-based pagination
  • Customer-focused terminology
  • Complete business workflow management
By integrating these features into your institution’s system, you ensure efficient student management, provide valuable career development tools, and maintain a strong educational workflow while focusing on student success rather than payment processing.