API Documentation - Professional

POST /api/v2/user/signup

~109ms ▼

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": "78ms", "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_xf2ywhn3q" } }

POST /api/v2/user/signin

~73ms ▼

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": "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_ra2jqe01y" } }

POST /api/v2/user/resetPassword

~64ms ▼

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": "62ms", "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_ez3cp84ey" } }

PUT /api/v2/user/editUser

~59ms ▼

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": "112ms", "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_qubzk5okh" } }

GET /api/v2/user/getUsers

~113ms ▼

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": "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_nofjjc29h" } }

POST /api/v2/otp

~41ms ▼

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": "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_a3d6dft9h" } }

DELETE /api/v2/user/account

~50ms ▼

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": "26ms", "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_4lvkkefhb" } }

POST /api/v2/hunt/create

~71ms ▼

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": "111ms", "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_wxux3r8lt" } }

PUT /api/v2/hunt/edit

~63ms ▼

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": "25ms", "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_pkbomcysk" } }

GET /api/v2/hunt/getById

~52ms ▼

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": "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_tecxpqk38" } }

GET /api/v2/hunt/getAllHunts

~80ms ▼

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": "86ms", "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_e6ad619ei" } }

POST /api/v2/hunt-session/start

~41ms ▼

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": "88ms", "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_38h3rl43a" } }

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

~25ms ▼

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": "86ms", "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_2nq92mn15" } }

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

~67ms ▼

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": "74ms", "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_w66cr3cob" } }

GET /api/v2/hunt-session/hint

~54ms ▼

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": "113ms", "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_p8kah6ey0" } }

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

~58ms ▼

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": "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_2y13r2tsh" } }

GET /api/v2/hunt-session/progress

~115ms ▼

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": "28ms", "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_vvvi33i4o" } }

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

~101ms ▼

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": "100ms", "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_7vcasw3re" } }

GET /api/v2/leaderboard/global

~79ms ▼

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": "99ms", "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_rye2sas9w" } }

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

~99ms ▼

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": "32ms", "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_mgr79t1o4" } }

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

~25ms ▼

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_wnnx4jlqs" } }

POST /api/v2/narrative-step/create

~94ms ▼

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": "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_5hdpv943s" } }

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

~40ms ▼

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": "73ms", "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_mqvce1bxd" } }

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

~113ms ▼

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": "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_ycqman56j" } }

Api APIs