QuickSense API
  • Introduction
  • Authentication
  • Errors
  • Core Resources
    • Enrolments
      • The enrolment object
      • Create a user and add into a course
      • Create a user and add into a classroom
      • Remove user from a course
      • Remove user from a classroom
    • Users
      • The user object
      • Retrieve a user
      • Update a user
      • Delete a user
      • List all users
    • Courses/Classrooms
      • The courses object
      • List all clasrooms/courses
Powered by GitBook
On this page

Was this helpful?

  1. Core Resources
  2. Users

Retrieve a user

Get User by Email

GET https://api.cakes.com/api/v2/public/user

Fetch information on user based on email address

Headers

Name
Type
Description

ApiKey

string

School's API Key

Email

string

User's email address

{

    firstName: string,
    lastName: string,
    Email: string,
    lastLogin: datetime,
    enrolledClasses: [
        ...
        {
            courseId: string,
            courseName: string,
            classId: string,
            className: string
       },
       ...
   ]
}  
{
    "message": "User does not belong to the given School ID!" 
}
{
    "message": "The user with given email address could not be found!" 
}

PreviousThe user objectNextUpdate a user

Last updated 4 years ago

Was this helpful?