API Documentation - Professional

POST /api/v2/user/signup

~100ms ▼

Registers a new user

📋 Body Parameters

firstName
lastName
email
password
dob
profilePic

Response

200 Success

400 Bad Request

401 Unauthorized

500 Server Error

{ "status": "success", "data": {}, "message": "Request completed successfully", "timestamp": "2024-12-20T10:30:45Z", "responseTime": "45ms", "version": "v1.0" }

{ "status": "error", "error": { "code": 400, "message": "Bad Request", "details": "Invalid input parameters provided", "field": "email", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please check the required parameters" } }

{ "status": "error", "error": { "code": 401, "message": "Unauthorized", "details": "Authentication required or invalid credentials", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please provide valid authentication token" } }

{ "status": "error", "error": { "code": 500, "message": "Internal Server Error", "details": "An unexpected server error occurred", "timestamp": "2024-12-20T10:30:45Z", "requestId": "req_5kjzadp8e" } }

POST /api/v2/user/signin

~38ms ▼

Logs in a user and returns a JWT token

📋 Body Parameters

email
password
FCMToken

Response

200 Success

400 Bad Request

401 Unauthorized

500 Server Error

{ "status": "success", "data": {}, "message": "Request completed successfully", "timestamp": "2024-12-20T10:30:45Z", "responseTime": "98ms", "version": "v1.0" }

{ "status": "error", "error": { "code": 400, "message": "Bad Request", "details": "Invalid input parameters provided", "field": "email", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please check the required parameters" } }

{ "status": "error", "error": { "code": 401, "message": "Unauthorized", "details": "Authentication required or invalid credentials", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please provide valid authentication token" } }

{ "status": "error", "error": { "code": 500, "message": "Internal Server Error", "details": "An unexpected server error occurred", "timestamp": "2024-12-20T10:30:45Z", "requestId": "req_ml7gqrz4q" } }

POST /api/v2/user/resetPassword

~51ms ▼

Resets user password

📋 Body Parameters

email
password

Response

200 Success

400 Bad Request

401 Unauthorized

500 Server Error

{ "status": "success", "data": {}, "message": "Request completed successfully", "timestamp": "2024-12-20T10:30:45Z", "responseTime": "95ms", "version": "v1.0" }

{ "status": "error", "error": { "code": 400, "message": "Bad Request", "details": "Invalid input parameters provided", "field": "email", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please check the required parameters" } }

{ "status": "error", "error": { "code": 401, "message": "Unauthorized", "details": "Authentication required or invalid credentials", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please provide valid authentication token" } }

{ "status": "error", "error": { "code": 500, "message": "Internal Server Error", "details": "An unexpected server error occurred", "timestamp": "2024-12-20T10:30:45Z", "requestId": "req_xdl6alr94" } }

PUT /api/v2/user/editUser

~23ms ▼

Edits a user's profile

📋 Body Parameters

userId
profilePic
updatedData

Response

200 Success

400 Bad Request

401 Unauthorized

500 Server Error

{ "status": "success", "data": {}, "message": "Request completed successfully", "timestamp": "2024-12-20T10:30:45Z", "responseTime": "76ms", "version": "v1.0" }

{ "status": "error", "error": { "code": 400, "message": "Bad Request", "details": "Invalid input parameters provided", "field": "email", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please check the required parameters" } }

{ "status": "error", "error": { "code": 401, "message": "Unauthorized", "details": "Authentication required or invalid credentials", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please provide valid authentication token" } }

{ "status": "error", "error": { "code": 500, "message": "Internal Server Error", "details": "An unexpected server error occurred", "timestamp": "2024-12-20T10:30:45Z", "requestId": "req_ruhln3258" } }

GET /api/v2/user/getUsers

~30ms ▼

Fetches users or a specific user(neasby user)

📋 Body Parameters

userId (optional)

Response

200 Success

400 Bad Request

401 Unauthorized

500 Server Error

{ "status": "success", "data": {}, "message": "Request completed successfully", "timestamp": "2024-12-20T10:30:45Z", "responseTime": "54ms", "version": "v1.0" }

{ "status": "error", "error": { "code": 400, "message": "Bad Request", "details": "Invalid input parameters provided", "field": "email", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please check the required parameters" } }

{ "status": "error", "error": { "code": 401, "message": "Unauthorized", "details": "Authentication required or invalid credentials", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please provide valid authentication token" } }

{ "status": "error", "error": { "code": 500, "message": "Internal Server Error", "details": "An unexpected server error occurred", "timestamp": "2024-12-20T10:30:45Z", "requestId": "req_vkfjw31v4" } }

POST /api/v2/otp

~47ms ▼

Generates an OTP for the user

📋 Body Parameters

email

Response

200 Success

400 Bad Request

401 Unauthorized

500 Server Error

{ "status": "success", "data": {}, "message": "Request completed successfully", "timestamp": "2024-12-20T10:30:45Z", "responseTime": "76ms", "version": "v1.0" }

{ "status": "error", "error": { "code": 400, "message": "Bad Request", "details": "Invalid input parameters provided", "field": "email", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please check the required parameters" } }

{ "status": "error", "error": { "code": 401, "message": "Unauthorized", "details": "Authentication required or invalid credentials", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please provide valid authentication token" } }

{ "status": "error", "error": { "code": 500, "message": "Internal Server Error", "details": "An unexpected server error occurred", "timestamp": "2024-12-20T10:30:45Z", "requestId": "req_k38in95yh" } }

DELETE /api/v2/user/account

~72ms ▼

Deletes the user account

📋 Body Parameters

userId

Response

200 Success

400 Bad Request

401 Unauthorized

500 Server Error

{ "status": "success", "data": {}, "message": "Request completed successfully", "timestamp": "2024-12-20T10:30:45Z", "responseTime": "76ms", "version": "v1.0" }

{ "status": "error", "error": { "code": 400, "message": "Bad Request", "details": "Invalid input parameters provided", "field": "email", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please check the required parameters" } }

{ "status": "error", "error": { "code": 401, "message": "Unauthorized", "details": "Authentication required or invalid credentials", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please provide valid authentication token" } }

{ "status": "error", "error": { "code": 500, "message": "Internal Server Error", "details": "An unexpected server error occurred", "timestamp": "2024-12-20T10:30:45Z", "requestId": "req_bk463qiay" } }

POST /api/v2/hunt/create

~63ms ▼

Creates a new hunt

📋 Body Parameters

title
genre
description
hunt_type
is_active
decision_tree_json

Response

200 Success

400 Bad Request

401 Unauthorized

500 Server Error

{ "status": "success", "data": {}, "message": "Request completed successfully", "timestamp": "2024-12-20T10:30:45Z", "responseTime": "30ms", "version": "v1.0" }

{ "status": "error", "error": { "code": 400, "message": "Bad Request", "details": "Invalid input parameters provided", "field": "email", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please check the required parameters" } }

{ "status": "error", "error": { "code": 401, "message": "Unauthorized", "details": "Authentication required or invalid credentials", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please provide valid authentication token" } }

{ "status": "error", "error": { "code": 500, "message": "Internal Server Error", "details": "An unexpected server error occurred", "timestamp": "2024-12-20T10:30:45Z", "requestId": "req_impvsnuoh" } }

PUT /api/v2/hunt/edit

~38ms ▼

Edits an existing hunt

📋 Body Parameters

huntId
updatedData
audioFile
imageFile

Response

200 Success

400 Bad Request

401 Unauthorized

500 Server Error

{ "status": "success", "data": {}, "message": "Request completed successfully", "timestamp": "2024-12-20T10:30:45Z", "responseTime": "21ms", "version": "v1.0" }

{ "status": "error", "error": { "code": 400, "message": "Bad Request", "details": "Invalid input parameters provided", "field": "email", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please check the required parameters" } }

{ "status": "error", "error": { "code": 401, "message": "Unauthorized", "details": "Authentication required or invalid credentials", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please provide valid authentication token" } }

{ "status": "error", "error": { "code": 500, "message": "Internal Server Error", "details": "An unexpected server error occurred", "timestamp": "2024-12-20T10:30:45Z", "requestId": "req_tfj8xg4aj" } }

GET /api/v2/hunt/getById

~37ms ▼

Gets hunt by ID

📋 Body Parameters

huntId

Response

200 Success

400 Bad Request

401 Unauthorized

500 Server Error

{ "status": "success", "data": {}, "message": "Request completed successfully", "timestamp": "2024-12-20T10:30:45Z", "responseTime": "40ms", "version": "v1.0" }

{ "status": "error", "error": { "code": 400, "message": "Bad Request", "details": "Invalid input parameters provided", "field": "email", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please check the required parameters" } }

{ "status": "error", "error": { "code": 401, "message": "Unauthorized", "details": "Authentication required or invalid credentials", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please provide valid authentication token" } }

{ "status": "error", "error": { "code": 500, "message": "Internal Server Error", "details": "An unexpected server error occurred", "timestamp": "2024-12-20T10:30:45Z", "requestId": "req_qlav1jqvu" } }

GET /api/v2/hunt/getAllHunts

~104ms ▼

Gets all hunts

Response

200 Success

400 Bad Request

401 Unauthorized

500 Server Error

{ "status": "success", "data": {}, "message": "Request completed successfully", "timestamp": "2024-12-20T10:30:45Z", "responseTime": "103ms", "version": "v1.0" }

{ "status": "error", "error": { "code": 400, "message": "Bad Request", "details": "Invalid input parameters provided", "field": "email", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please check the required parameters" } }

{ "status": "error", "error": { "code": 401, "message": "Unauthorized", "details": "Authentication required or invalid credentials", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please provide valid authentication token" } }

{ "status": "error", "error": { "code": 500, "message": "Internal Server Error", "details": "An unexpected server error occurred", "timestamp": "2024-12-20T10:30:45Z", "requestId": "req_wg3v8n2wh" } }

POST /api/v2/hunt-session/start

~33ms ▼

Start a new hunt session

📋 Body Parameters

hunt_id
team_id (optional)
user_id (optional)
difficulty_level

Response

200 Success

400 Bad Request

401 Unauthorized

500 Server Error

{ "status": "success", "data": {}, "message": "Request completed successfully", "timestamp": "2024-12-20T10:30:45Z", "responseTime": "48ms", "version": "v1.0" }

{ "status": "error", "error": { "code": 400, "message": "Bad Request", "details": "Invalid input parameters provided", "field": "email", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please check the required parameters" } }

{ "status": "error", "error": { "code": 401, "message": "Unauthorized", "details": "Authentication required or invalid credentials", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please provide valid authentication token" } }

{ "status": "error", "error": { "code": 500, "message": "Internal Server Error", "details": "An unexpected server error occurred", "timestamp": "2024-12-20T10:30:45Z", "requestId": "req_pkjeyb408" } }

GET /api/v2/hunt-session/current-step

~81ms ▼

Get current step for a session

📋 Body Parameters

session_code

Response

200 Success

400 Bad Request

401 Unauthorized

500 Server Error

{ "status": "success", "data": {}, "message": "Request completed successfully", "timestamp": "2024-12-20T10:30:45Z", "responseTime": "114ms", "version": "v1.0" }

{ "status": "error", "error": { "code": 400, "message": "Bad Request", "details": "Invalid input parameters provided", "field": "email", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please check the required parameters" } }

{ "status": "error", "error": { "code": 401, "message": "Unauthorized", "details": "Authentication required or invalid credentials", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please provide valid authentication token" } }

{ "status": "error", "error": { "code": 500, "message": "Internal Server Error", "details": "An unexpected server error occurred", "timestamp": "2024-12-20T10:30:45Z", "requestId": "req_xcyeyzwft" } }

POST /api/v2/hunt-session/submit-answer

~83ms ▼

Submit answer for current step

📋 Body Parameters

session_code
answer
step_number (optional)

Response

200 Success

400 Bad Request

401 Unauthorized

500 Server Error

{ "status": "success", "data": {}, "message": "Request completed successfully", "timestamp": "2024-12-20T10:30:45Z", "responseTime": "107ms", "version": "v1.0" }

{ "status": "error", "error": { "code": 400, "message": "Bad Request", "details": "Invalid input parameters provided", "field": "email", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please check the required parameters" } }

{ "status": "error", "error": { "code": 401, "message": "Unauthorized", "details": "Authentication required or invalid credentials", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please provide valid authentication token" } }

{ "status": "error", "error": { "code": 500, "message": "Internal Server Error", "details": "An unexpected server error occurred", "timestamp": "2024-12-20T10:30:45Z", "requestId": "req_lg49lj4jz" } }

GET /api/v2/hunt-session/hint

~75ms ▼

Get hint for current step

📋 Body Parameters

session_code
step_number
hint_index (optional)

Response

200 Success

400 Bad Request

401 Unauthorized

500 Server Error

{ "status": "success", "data": {}, "message": "Request completed successfully", "timestamp": "2024-12-20T10:30:45Z", "responseTime": "109ms", "version": "v1.0" }

{ "status": "error", "error": { "code": 400, "message": "Bad Request", "details": "Invalid input parameters provided", "field": "email", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please check the required parameters" } }

{ "status": "error", "error": { "code": 401, "message": "Unauthorized", "details": "Authentication required or invalid credentials", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please provide valid authentication token" } }

{ "status": "error", "error": { "code": 500, "message": "Internal Server Error", "details": "An unexpected server error occurred", "timestamp": "2024-12-20T10:30:45Z", "requestId": "req_vw34p5n9q" } }

POST /api/v2/hunt-session/make-decision

~22ms ▼

Make decision at decision point

📋 Body Parameters

session_code
decision
step_number (optional)

Response

200 Success

400 Bad Request

401 Unauthorized

500 Server Error

{ "status": "success", "data": {}, "message": "Request completed successfully", "timestamp": "2024-12-20T10:30:45Z", "responseTime": "22ms", "version": "v1.0" }

{ "status": "error", "error": { "code": 400, "message": "Bad Request", "details": "Invalid input parameters provided", "field": "email", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please check the required parameters" } }

{ "status": "error", "error": { "code": 401, "message": "Unauthorized", "details": "Authentication required or invalid credentials", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please provide valid authentication token" } }

{ "status": "error", "error": { "code": 500, "message": "Internal Server Error", "details": "An unexpected server error occurred", "timestamp": "2024-12-20T10:30:45Z", "requestId": "req_g8cr96loz" } }

GET /api/v2/hunt-session/progress

~104ms ▼

Get progress for session

📋 Body Parameters

session_code

Response

200 Success

400 Bad Request

401 Unauthorized

500 Server Error

{ "status": "success", "data": {}, "message": "Request completed successfully", "timestamp": "2024-12-20T10:30:45Z", "responseTime": "80ms", "version": "v1.0" }

{ "status": "error", "error": { "code": 400, "message": "Bad Request", "details": "Invalid input parameters provided", "field": "email", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please check the required parameters" } }

{ "status": "error", "error": { "code": 401, "message": "Unauthorized", "details": "Authentication required or invalid credentials", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please provide valid authentication token" } }

{ "status": "error", "error": { "code": 500, "message": "Internal Server Error", "details": "An unexpected server error occurred", "timestamp": "2024-12-20T10:30:45Z", "requestId": "req_4hsikhcru" } }

GET /api/v2/leaderboard/hunt/:hunt_id

~52ms ▼

Get leaderboard for a specific hunt

📋 Body Parameters

limit
offset
timeFilter
difficultyFilter

Response

200 Success

400 Bad Request

401 Unauthorized

500 Server Error

{ "status": "success", "data": {}, "message": "Request completed successfully", "timestamp": "2024-12-20T10:30:45Z", "responseTime": "84ms", "version": "v1.0" }

{ "status": "error", "error": { "code": 400, "message": "Bad Request", "details": "Invalid input parameters provided", "field": "email", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please check the required parameters" } }

{ "status": "error", "error": { "code": 401, "message": "Unauthorized", "details": "Authentication required or invalid credentials", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please provide valid authentication token" } }

{ "status": "error", "error": { "code": 500, "message": "Internal Server Error", "details": "An unexpected server error occurred", "timestamp": "2024-12-20T10:30:45Z", "requestId": "req_uq0fbnqhz" } }

GET /api/v2/leaderboard/global

~97ms ▼

Get global leaderboard across all hunts

📋 Body Parameters

limit
offset
timeFilter
difficultyFilter

Response

200 Success

400 Bad Request

401 Unauthorized

500 Server Error

{ "status": "success", "data": {}, "message": "Request completed successfully", "timestamp": "2024-12-20T10:30:45Z", "responseTime": "54ms", "version": "v1.0" }

{ "status": "error", "error": { "code": 400, "message": "Bad Request", "details": "Invalid input parameters provided", "field": "email", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please check the required parameters" } }

{ "status": "error", "error": { "code": 401, "message": "Unauthorized", "details": "Authentication required or invalid credentials", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please provide valid authentication token" } }

{ "status": "error", "error": { "code": 500, "message": "Internal Server Error", "details": "An unexpected server error occurred", "timestamp": "2024-12-20T10:30:45Z", "requestId": "req_6k5wy4x7r" } }

GET /api/v2/leaderboard/user/:user_id

~89ms ▼

Get user's personal stats

Response

200 Success

400 Bad Request

401 Unauthorized

500 Server Error

{ "status": "success", "data": {}, "message": "Request completed successfully", "timestamp": "2024-12-20T10:30:45Z", "responseTime": "85ms", "version": "v1.0" }

{ "status": "error", "error": { "code": 400, "message": "Bad Request", "details": "Invalid input parameters provided", "field": "email", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please check the required parameters" } }

{ "status": "error", "error": { "code": 401, "message": "Unauthorized", "details": "Authentication required or invalid credentials", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please provide valid authentication token" } }

{ "status": "error", "error": { "code": 500, "message": "Internal Server Error", "details": "An unexpected server error occurred", "timestamp": "2024-12-20T10:30:45Z", "requestId": "req_50yqrm3vf" } }

GET /api/v2/leaderboard/team/:team_id

~114ms ▼

Get team stats

Response

200 Success

400 Bad Request

401 Unauthorized

500 Server Error

{ "status": "success", "data": {}, "message": "Request completed successfully", "timestamp": "2024-12-20T10:30:45Z", "responseTime": "117ms", "version": "v1.0" }

{ "status": "error", "error": { "code": 400, "message": "Bad Request", "details": "Invalid input parameters provided", "field": "email", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please check the required parameters" } }

{ "status": "error", "error": { "code": 401, "message": "Unauthorized", "details": "Authentication required or invalid credentials", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please provide valid authentication token" } }

{ "status": "error", "error": { "code": 500, "message": "Internal Server Error", "details": "An unexpected server error occurred", "timestamp": "2024-12-20T10:30:45Z", "requestId": "req_j3pijyogw" } }

POST /api/v2/narrative-step/create

~107ms ▼

Create a new narrative step

📋 Body Parameters

hunt_id
step_number
step_type
title
narrative_text
audioFile
imageFile

Response

200 Success

400 Bad Request

401 Unauthorized

500 Server Error

{ "status": "success", "data": {}, "message": "Request completed successfully", "timestamp": "2024-12-20T10:30:45Z", "responseTime": "79ms", "version": "v1.0" }

{ "status": "error", "error": { "code": 400, "message": "Bad Request", "details": "Invalid input parameters provided", "field": "email", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please check the required parameters" } }

{ "status": "error", "error": { "code": 401, "message": "Unauthorized", "details": "Authentication required or invalid credentials", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please provide valid authentication token" } }

{ "status": "error", "error": { "code": 500, "message": "Internal Server Error", "details": "An unexpected server error occurred", "timestamp": "2024-12-20T10:30:45Z", "requestId": "req_jso94qy2q" } }

GET /api/v2/narrative-step/hunt/:hunt_id

~36ms ▼

Get all narrative steps for a hunt

📋 Body Parameters

branch_path (optional)

Response

200 Success

400 Bad Request

401 Unauthorized

500 Server Error

{ "status": "success", "data": {}, "message": "Request completed successfully", "timestamp": "2024-12-20T10:30:45Z", "responseTime": "84ms", "version": "v1.0" }

{ "status": "error", "error": { "code": 400, "message": "Bad Request", "details": "Invalid input parameters provided", "field": "email", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please check the required parameters" } }

{ "status": "error", "error": { "code": 401, "message": "Unauthorized", "details": "Authentication required or invalid credentials", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please provide valid authentication token" } }

{ "status": "error", "error": { "code": 500, "message": "Internal Server Error", "details": "An unexpected server error occurred", "timestamp": "2024-12-20T10:30:45Z", "requestId": "req_f1ry3xcjx" } }

PUT /api/v2/narrative-step/:step_id

~79ms ▼

Update a narrative step

📋 Body Parameters

step_id
updatedData
audioFile
imageFile

Response

200 Success

400 Bad Request

401 Unauthorized

500 Server Error

{ "status": "success", "data": {}, "message": "Request completed successfully", "timestamp": "2024-12-20T10:30:45Z", "responseTime": "64ms", "version": "v1.0" }

{ "status": "error", "error": { "code": 400, "message": "Bad Request", "details": "Invalid input parameters provided", "field": "email", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please check the required parameters" } }

{ "status": "error", "error": { "code": 401, "message": "Unauthorized", "details": "Authentication required or invalid credentials", "timestamp": "2024-12-20T10:30:45Z", "suggestion": "Please provide valid authentication token" } }

{ "status": "error", "error": { "code": 500, "message": "Internal Server Error", "details": "An unexpected server error occurred", "timestamp": "2024-12-20T10:30:45Z", "requestId": "req_sni7epvq3" } }

Api APIs