User/Profile API

Get Profile

Retrieves the authenticated user’s profile. Automatically creates a profile if one doesn’t exist.

Response

object

User profile object

Show Profile Object

string

User UUID

string

User email address

string

User display name

string

User role: “user” (learner), “instructor”, or “admin”

string

User biography/description

string

Profile image URL

string

Preferred currency (ISO 4217 code, e.g., “USD”, “NGN”)

string

Profile creation timestamp (ISO 8601)

string

Last update timestamp (ISO 8601)

Example Request

curl https://your-domain.com/api/profile

Example Response

{
  "profile": {
    "id": "uuid-here",
    "email": "user@example.com",
    "name": "John Doe",
    "user_type": "user",
    "bio": "Aspiring developer",
    "profile_image": "https://example.com/avatar.jpg",
    "currency": "USD",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}

Update Profile

Updates the authenticated user’s profile information.

Request Body

string

User display name

string

User biography/description

string

Profile image URL

string

Preferred currency (ISO 4217 code)

Response

object

Updated profile object

Example Request

curl -X PUT https://your-domain.com/api/profile \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Jane Doe",
    "bio": "Full-stack developer",
    "currency": "EUR"
  }'

Delete Account

Deletes the authenticated user’s account and all associated data.

Response

string

Success confirmation message

Example Request

curl -X DELETE https://your-domain.com/api/profile

Notes

This action is irreversible. It deletes:

User authentication account
Profile data
All enrollments
All progress records
All quiz results

List Learners (Admin/Instructor)

Retrieves a list of all learners (users with user_type = “user”). Requires admin or instructor authentication.

Query Parameters

string

Search by name or email

string

Filter by enrollment status: “all”, “enrolled”, “not-enrolled”

Response

array

Array of learner objects

Show Learner Object

string

User UUID

string

User name

string

User email

string

Profile image URL

array

Array of enrolled course IDs

array

Array of completed course IDs

object

Object mapping course IDs to progress percentages

Example Request

curl https://your-domain.com/api/learners?search=john&enrollmentFilter=enrolled

Example Response

{
  "learners": [
    {
      "id": "uuid-1",
      "name": "John Doe",
      "email": "john@example.com",
      "profileImage": "https://example.com/john.jpg",
      "enrolledCourses": [1, 2, 5],
      "completedCourses": [1],
      "progress": {
        "1": 100,
        "2": 45,
        "5": 10
      }
    }
  ]
}

Get Learner Purchases (Admin/Instructor)

Retrieves all purchases (payments) for a specific learner. Requires admin or instructor authentication.

Path Parameters

string

required

Learner UUID

Response

array

Array of purchase objects

Show Purchase Object

number

Purchase ID

number

Course ID

string

Course title

string

Course thumbnail URL

number

Payment amount

string

Payment currency

string

Payment gateway: “stripe”, “flutterwave”

string

Payment status: “pending”, “completed”, “failed”, “refunded”

string

Payment type: “one-time” or “recurring”

string

Purchase timestamp

Example Request

curl https://your-domain.com/api/learners/uuid-here/purchases

User Types

The platform supports three user types:

User Type	Description	Permissions
user	Regular learner	Enroll in courses, view content, submit quizzes
instructor	Course creator	All learner permissions + create courses
admin	Platform administrator	Full access to all features and data

Profile Auto-Creation

When a new user signs up, the GET /api/profile endpoint automatically:

Checks if a profile exists
If not, creates one with:
- user_type: “user” (default)
- name: Derived from email or user metadata
- currency: “USD” (default)
Returns the profile

This ensures every authenticated user always has a valid profile.

Error Codes

Status Code	Description
200	Success
400	Bad Request - Invalid parameters
401	Unauthorized - Authentication required
403	Forbidden - Insufficient permissions
404	Not Found - Profile or user not found
500	Internal Server Error

Overview

Resources

User/Profile API

Get Profile

Response

Example Request

Example Response

Update Profile

Request Body

Response

Example Request

Delete Account

Response

Example Request

Notes

List Learners (Admin/Instructor)

Query Parameters

Response

Example Request

Example Response

Get Learner Purchases (Admin/Instructor)

Path Parameters

Response

Example Request

User Types

Profile Auto-Creation

Error Codes

​Get Profile

​Response

​Example Request

​Example Response

​Update Profile

​Request Body

​Response

​Example Request

​Delete Account

​Response

​Example Request

​Notes

​List Learners (Admin/Instructor)

​Query Parameters

​Response

​Example Request

​Example Response

​Get Learner Purchases (Admin/Instructor)

​Path Parameters

​Response

​Example Request

​User Types

​Profile Auto-Creation

​Error Codes

Get Profile

Response

Example Request

Example Response

Update Profile

Request Body

Response

Example Request

Delete Account

Response

Example Request

Notes

List Learners (Admin/Instructor)

Query Parameters

Response

Example Request

Example Response

Get Learner Purchases (Admin/Instructor)

Path Parameters

Response

Example Request

User Types

Profile Auto-Creation

Error Codes