Campus
Retrieve Campus Details Public.
JWT Token Authentication. Enter "Bearer "
falseExample: false200Example: 200GET /api/v1/dashboard/campus/{org_id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"text"
]
},
"response": {
"org_id": "text",
"college_name": "text",
"campus_code": "text",
"campus_zone": "text",
"campus_level": "text",
"total_karma": "text",
"total_members": "text",
"active_members": "text",
"rank": "text",
"social_links": "text"
}
}Retrieve Campus Karma By Cluster.
JWT Token Authentication. Enter "Bearer "
falseExample: false200Example: 200GET /api/v1/dashboard/campus/{org_id}/karma-by-cluster/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"text"
]
},
"response": {
"hasError": true,
"statusCode": 1,
"message": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"response": {
"total_karma": 1,
"member_count": 1
}
}
}Retrieve Campus Student Leaderboard.
JWT Token Authentication. Enter "Bearer "
falseExample: false200Example: 200GET /api/v1/dashboard/campus/{org_id}/leaderboard/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"text"
]
},
"response": {
"user_id": "text",
"full_name": "text",
"muid": "text",
"karma": 1,
"rank": "text",
"level": "text",
"join_date": "text",
"last_karma_gained": "text",
"graduation_year": "text",
"department": "text",
"is_alumni": true,
"ig_count": 0,
"lc_count": 0,
"profile_pic": "text"
}
}JWT Token Authentication. Enter "Bearer "
No response body
No content
GET /api/v1/dashboard/campus/analytics/growth/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
JWT Token Authentication. Enter "Bearer "
No response body
No content
GET /api/v1/dashboard/campus/analytics/karma-trend/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
JWT Token Authentication. Enter "Bearer "
No response body
No content
POST /api/v1/dashboard/campus/assign-mentor/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
Campus Details API
This API view allows authorized users with specific roles (Campus Lead or Enabler) to access details about their campus
Attributes: authentication_classes (list): A list containing the CustomizePermission class for authentication.
Method: get(request): Handles GET requests to retrieve campus details for the authenticated user.
JWT Token Authentication. Enter "Bearer "
No response body
No content
GET /api/v1/dashboard/campus/campus-details/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
Retrieve Campus List.
JWT Token Authentication. Enter "Bearer "
falseExample: false200Example: 200GET /api/v1/dashboard/campus/campus-list/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"text"
]
},
"response": {
"id": "text",
"title": "text",
"code": "text"
}
}JWT Token Authentication. Enter "Bearer "
No response body
No content
PATCH /api/v1/dashboard/campus/change-student-type/{member_id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
Retrieve Campus Circle Health.
falseExample: false200Example: 200GET /api/v1/dashboard/campus/circle-health/ HTTP/1.1
Accept: */*
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"text"
]
},
"response": {
"hasError": true,
"statusCode": 1,
"message": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"response": {
"data": [
{
"circle_id": "text",
"circle_name": "text",
"ig_id": "text",
"ig_name": "text",
"member_count": 1,
"sessions_per_month": 1,
"last_session_at": "text",
"status": "text"
}
]
}
}
}GET campus/events/ Returns paginated campus-scoped and campus-IG-scoped events for the authenticated campus lead's campus.
JWT Token Authentication. Enter "Bearer "
No response body
No content
GET /api/v1/dashboard/campus/events/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
GET campus/events/distribution/ Returns ranked tag distribution for all campus events. Aggregates from Event.tags JSONField using Counter.
JWT Token Authentication. Enter "Bearer "
No response body
No content
GET /api/v1/dashboard/campus/events/distribution/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
GET campus/execom/ — list all execom role holders POST campus/execom/ — appoint a member to a role DELETE campus/execom/<member_id>/ — remove a role link
JWT Token Authentication. Enter "Bearer "
No response body
No content
GET /api/v1/dashboard/campus/execom/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
GET campus/execom/ — list all execom role holders POST campus/execom/ — appoint a member to a role DELETE campus/execom/<member_id>/ — remove a role link
JWT Token Authentication. Enter "Bearer "
No response body
No content
POST /api/v1/dashboard/campus/execom/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
GET campus/execom/ — list all execom role holders POST campus/execom/ — appoint a member to a role DELETE campus/execom/<member_id>/ — remove a role link
JWT Token Authentication. Enter "Bearer "
No response body
No content
DELETE /api/v1/dashboard/campus/execom/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
GET campus/execom/ — list all execom role holders POST campus/execom/ — appoint a member to a role DELETE campus/execom/<member_id>/ — remove a role link
JWT Token Authentication. Enter "Bearer "
No response body
No content
GET /api/v1/dashboard/campus/execom/{member_id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
GET campus/execom/ — list all execom role holders POST campus/execom/ — appoint a member to a role DELETE campus/execom/<member_id>/ — remove a role link
JWT Token Authentication. Enter "Bearer "
No response body
No content
POST /api/v1/dashboard/campus/execom/{member_id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
GET campus/execom/ — list all execom role holders POST campus/execom/ — appoint a member to a role DELETE campus/execom/<member_id>/ — remove a role link
JWT Token Authentication. Enter "Bearer "
No response body
No content
DELETE /api/v1/dashboard/campus/execom/{member_id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
GET campus/execom/roles/ — list all assignable roles POST campus/execom/roles/ — explicitly create a custom role
JWT Token Authentication. Enter "Bearer "
No response body
No content
GET /api/v1/dashboard/campus/execom/roles/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
GET campus/execom/roles/ — list all assignable roles POST campus/execom/roles/ — explicitly create a custom role
JWT Token Authentication. Enter "Bearer "
No response body
No content
POST /api/v1/dashboard/campus/execom/roles/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
GET campus/execom/search/?q=
Searches campus members by full_name or muid (case-insensitive partial match). Returns all matching members regardless of whether they already hold an Execom role — this fixes the inconsistency where some existing Execom members were missing from search results because a plain exact-muid lookup was used.
JWT Token Authentication. Enter "Bearer "
No response body
No content
GET /api/v1/dashboard/campus/execom/search/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
Retrieve Campus Dashboard Summary.
falseExample: false200Example: 200GET /api/v1/dashboard/campus/home-summary/ HTTP/1.1
Accept: */*
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"text"
]
},
"response": {
"hasError": true,
"statusCode": 1,
"message": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"response": {
"campus": {
"org_id": "text",
"college_name": "text",
"campus_code": "text",
"campus_zone": "text"
},
"stat_cards": [
{
"key": "text",
"label": "text",
"value": 1,
"delta": 1,
"delta_type": "text",
"period": "text"
}
],
"member_funnel": {
"max": 1,
"stages": [
{
"key": "text",
"label": "text",
"count": 1,
"percentage": 1
}
]
},
"circle_health": [
{
"circle_id": "text",
"circle_name": "text",
"ig_id": "text",
"ig_name": "text",
"member_count": 1,
"sessions_per_month": 1,
"last_session_at": "text",
"status": "text"
}
],
"recent_activity": [
{
"id": "text",
"type": "text",
"title": "text",
"description": "text",
"created_at": "text",
"actor": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
]
}
}
}JWT Token Authentication. Enter "Bearer "
No response body
No content
GET /api/v1/dashboard/campus/ig-chapters/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
JWT Token Authentication. Enter "Bearer "
No response body
No content
POST /api/v1/dashboard/campus/ig-chapters/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
JWT Token Authentication. Enter "Bearer "
No response body
No content
DELETE /api/v1/dashboard/campus/ig-chapters/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
JWT Token Authentication. Enter "Bearer "
No response body
No content
PATCH /api/v1/dashboard/campus/ig-chapters/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
JWT Token Authentication. Enter "Bearer "
No response body
No content
GET /api/v1/dashboard/campus/ig-chapters/{chapter_id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
JWT Token Authentication. Enter "Bearer "
No response body
No content
POST /api/v1/dashboard/campus/ig-chapters/{chapter_id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
JWT Token Authentication. Enter "Bearer "
No response body
No content
DELETE /api/v1/dashboard/campus/ig-chapters/{chapter_id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
JWT Token Authentication. Enter "Bearer "
No response body
No content
PATCH /api/v1/dashboard/campus/ig-chapters/{chapter_id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
Join a Campus IG Chapter. The authenticated user must be a verified member of the same campus organization that hosts this chapter.
JWT Token Authentication. Enter "Bearer "
No response body
No content
POST /api/v1/dashboard/campus/ig-chapters/{chapter_id}/join/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
Leave a Campus IG Chapter. The authenticated user's active learner link to the Interest Group is deactivated. History is preserved.
JWT Token Authentication. Enter "Bearer "
No response body
No content
DELETE /api/v1/dashboard/campus/ig-chapters/{chapter_id}/leave/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
JWT Token Authentication. Enter "Bearer "
No response body
No content
GET /api/v1/dashboard/campus/igs/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
JWT Token Authentication. Enter "Bearer "
No response body
No content
GET /api/v1/dashboard/campus/igs/{ig_id}/members/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
JWT Token Authentication. Enter "Bearer "
No response body
No content
GET /api/v1/dashboard/campus/learning-circles/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
JWT Token Authentication. Enter "Bearer "
No response body
No content
GET /api/v1/dashboard/campus/learning-circles/{circle_id}/members/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
Retrieve Campus Member Funnel.
falseExample: false200Example: 200GET /api/v1/dashboard/campus/member-funnel/ HTTP/1.1
Accept: */*
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"text"
]
},
"response": {
"hasError": true,
"statusCode": 1,
"message": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"response": {
"max": 1,
"stages": [
{
"key": "text",
"label": "text",
"count": 1,
"percentage": 1
}
]
}
}
}Retrieve Campus Recent Activity.
falseExample: false200Example: 200GET /api/v1/dashboard/campus/recent-activity/ HTTP/1.1
Accept: */*
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"text"
]
},
"response": {
"hasError": true,
"statusCode": 1,
"message": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"response": {
"data": [
{
"id": "text",
"type": "text",
"title": "text",
"description": "text",
"created_at": "text",
"actor": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
]
}
}
}List campus mentorship sessions. Admins, campus leads, enablers, and approved campus mentors see all statuses; other users see only scheduled sessions.
falseExample: false200Example: 200GET /api/v1/dashboard/campus/sessions/list/ HTTP/1.1
Accept: */*
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"text"
]
},
"response": [
{
"id": "text",
"entity_id": "text",
"entity_name": "text",
"session_type": "ig_session",
"title": "text",
"description": "text",
"mode": "ONLINE",
"starts_at": "2026-01-01T00:00:00.000Z",
"ends_at": "2026-01-01T00:00:00.000Z",
"status": "REQUESTED",
"created_by_id": "text",
"created_by_name": "text",
"created_at": "2026-01-01T00:00:00.000Z",
"max_participants": 1,
"meeting_link": "text",
"venue": "text",
"is_recurring": true,
"parent_session_id": "text",
"recurrence_type": "DAILY",
"recurrence_interval": 1,
"recurrence_end_date": "2026-01-01"
}
]
}JWT Token Authentication. Enter "Bearer "
No response body
No content
GET /api/v1/dashboard/campus/showcase/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
JWT Token Authentication. Enter "Bearer "
No response body
No content
PATCH /api/v1/dashboard/campus/showcase/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
JWT Token Authentication. Enter "Bearer "
No response body
No content
PUT /api/v1/dashboard/campus/social-links/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
JWT Token Authentication. Enter "Bearer "
No response body
No content
DELETE /api/v1/dashboard/campus/social-links/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
JWT Token Authentication. Enter "Bearer "
No response body
No content
PUT /api/v1/dashboard/campus/social-links/{link_id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
JWT Token Authentication. Enter "Bearer "
No response body
No content
DELETE /api/v1/dashboard/campus/social-links/{link_id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
JWT Token Authentication. Enter "Bearer "
No response body
No content
GET /api/v1/dashboard/campus/student-details/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
JWT Token Authentication. Enter "Bearer "
No response body
No content
GET /api/v1/dashboard/campus/student-details/csv/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
Retrieve Campus Student In Each Level.
JWT Token Authentication. Enter "Bearer "
falseExample: false200Example: 200GET /api/v1/dashboard/campus/student-level/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"text"
]
},
"response": {
"hasError": true,
"statusCode": 1,
"message": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"response": [
{
"level": 1,
"students": 1
}
]
}
}Retrieve Campus Student In Each Level.
JWT Token Authentication. Enter "Bearer "
falseExample: false200Example: 200GET /api/v1/dashboard/campus/student-level/{org_id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"text"
]
},
"response": {
"hasError": true,
"statusCode": 1,
"message": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"response": [
{
"level": 1,
"students": 1
}
]
}
}JWT Token Authentication. Enter "Bearer "
No response body
No content
GET /api/v1/dashboard/campus/student-list/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
JWT Token Authentication. Enter "Bearer "
No response body
No content
GET /api/v1/dashboard/campus/students/{muid}/activity/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
JWT Token Authentication. Enter "Bearer "
No response body
No content
POST /api/v1/dashboard/campus/transfer-enabler-role/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
JWT Token Authentication. Enter "Bearer "
No response body
No content
GET /api/v1/dashboard/campus/transfer-ig-role/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
JWT Token Authentication. Enter "Bearer "
No response body
No content
POST /api/v1/dashboard/campus/transfer-ig-role/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
JWT Token Authentication. Enter "Bearer "
No response body
No content
POST /api/v1/dashboard/campus/transfer-lead-role/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
Retrieve Weekly Karma.
JWT Token Authentication. Enter "Bearer "
falseExample: false200Example: 200GET /api/v1/dashboard/campus/weekly-karma/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"text"
]
},
"response": {
"college_name": "text"
}
}Retrieve Weekly Karma.
JWT Token Authentication. Enter "Bearer "
falseExample: false200Example: 200GET /api/v1/dashboard/campus/weekly-karma/{org_id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"text"
]
},
"response": {
"college_name": "text"
}
}Last updated
Was this helpful?

