API Documentation - Professional

POST /api/v2/user/signup

~23ms ▼

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": "50ms", "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_tnklm6y5e" } }

POST /api/v2/user/signin

~88ms ▼

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": "72ms", "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_agfzk4gq0" } }

POST /api/v2/user/resetPassword

~108ms ▼

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

PUT /api/v2/user/editUser

~73ms ▼

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": "43ms", "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_sdijoaqdl" } }

GET /api/v2/user/getUsers

~49ms ▼

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": "70ms", "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_jev6lvxki" } }

POST /api/v2/otp

~57ms ▼

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": "70ms", "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_vsqncjz3d" } }

DELETE /api/v2/user/account

~56ms ▼

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

POST /api/v2/hunt/create

~41ms ▼

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

PUT /api/v2/hunt/edit

~84ms ▼

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": "118ms", "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_uuuinvbo5" } }

GET /api/v2/hunt/getById

~117ms ▼

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

GET /api/v2/hunt/getAllHunts

~68ms ▼

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

POST /api/v2/hunt-session/start

~83ms ▼

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": "39ms", "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_5ktlw2g27" } }

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

~91ms ▼

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": "72ms", "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_qq4hh6lia" } }

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

~26ms ▼

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": "51ms", "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_zor9ppes8" } }

GET /api/v2/hunt-session/hint

~66ms ▼

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": "105ms", "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_rrwo9vx21" } }

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

~119ms ▼

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

GET /api/v2/hunt-session/progress

~26ms ▼

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

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

~22ms ▼

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

GET /api/v2/leaderboard/global

~62ms ▼

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": "90ms", "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_loirymwqg" } }

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

~23ms ▼

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": "71ms", "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_gmezipi63" } }

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

~51ms ▼

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": "90ms", "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_sy21uan9c" } }

POST /api/v2/narrative-step/create

~80ms ▼

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": "61ms", "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_dej9vemtl" } }

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

~55ms ▼

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": "59ms", "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_3kpyzckr9" } }

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

~80ms ▼

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

Api APIs