Location Tracker API — Documentation

🔐 Authentication

▼

POST /auth/register PUBLIC Register / Login user (phone-based) ▼

📥 Response (201)

{ "success": true, "data": { "user": {...}, "token": "1|abc...", "circles": [...] } }

📝 Request Form

URL:

nameRequired

string — max 255

phoneRequired

string — unique phone number

roleRequired

fcm_tokenOptional

string — push notification ke liye

circlesOptional

JSON array — register ke saath circles banao

GET /auth/me 🔒 Get current user profile + token info ▼

📥 Response (200)

{ "success": true, "data": { "user": {..., "latest_location": {...}}, "token_info": {...} } }

📝 Request Form

URL:

🔒 Bearer token header se authenticate hoga. Koi body field nahi.

PUT /auth/profile 🔒 Update user profile (name, avatar) ▼

📝 Request Form

URL:

nameOptional

avatar_urlOptional

string (URL) — profile picture link

PUT /auth/fcm-token 🔒 Update FCM push notification token ▼

📝 Request Form

URL:

fcm_tokenRequired

string — from Firebase SDK

POST /auth/logout 🔒 Logout — delete current token ▼

📝 Request Form

URL:

⚠️ Token server se delete ho jayega. Koi body field nahi.

⭕ Circles — CRUD

▼

GET /circles 🔒 List all my circles ▼

📝 Request Form

URL:

Koi parameter nahi. Bearer token se user identify hoga.

POST /circles 🔒 Create a new circle ▼

📝 Request Form

URL:

nameRequired

string — circle name

GET /circles/{id} 🔒 Get circle details with members & places ▼

📝 Request Form

URL:

{id}URL Param

integer — URL mein {id} replace hoga

PUT /circles/{id} 🔒 Update circle name (owner only) ▼

📝 Request Form

URL:

{id}URL Param

URL mein circle ka ID

nameRequired

DELETE /circles/{id} 🔒 Delete circle (owner only) ▼

📝 Request Form

URL:

{id}URL Param

⚠️ Circle permanently delete ho jayega!

⚡ Circle Actions

▼

POST /circles/join 🔒 Join circle with invite code ▼

📝 Request Form

URL:

invite_codeRequired

string — format: ABC-DEF (expires 24 hours)

POST /circles/{id}/leave 🔒 Leave a circle (non-owner) ▼

📝 Request Form

URL:

{id}URL Param

Owner leave nahi kar sakta

POST /circles/{id}/remove-member 🔒 Remove a member (owner only) ▼

📝 Request Form

URL:

{id}URL Param

Circle ka ID jis se member hatana hai

user_idRequired

integer — jis member ko remove karna hai us ka ID

POST /circles/{id}/regenerate-code 🔒 Regenerate invite code (owner only) ▼

📝 Request Form

URL:

{id}URL Param

Purana code expire ho jayega, naya generate hoga

GET /circles/{id}/members-locations 🔒 Get all members' latest locations ▼

📝 Request Form

URL:

{id}URL Param

Sab members ki live location aayegi

GET /circles/{id}/permissions 🔒 Get member permissions (owner only) ▼

📥 Response (200)

{ "success": true, "data": [
  { "user_id": 1, "name": "Owner", "role": "admin", "is_owner": true,
    "can_invite": true, "can_add_places": true, "can_receive_member_alerts": true },
  { "user_id": 2, "name": "Member", "role": "member", "is_owner": false,
    "can_invite": false, "can_add_places": false, "can_receive_member_alerts": false }
] }

📝 Request Form

URL:

{id}URL Param

Circle ID — sirf owner dekh sakta hai

PUT /circles/{id}/permissions 🔒 Update member permissions (owner only) ▼

📥 Response (200)

{ "success": true, "message": "Member permissions updated",
  "data": { "user_id": 2, "can_invite": true, "can_add_places": true, "can_receive_member_alerts": false } }

📝 Request Form

URL:

{id}URL Param

Circle ID — sirf owner update kar sakta hai

user_idRequired

Jis member ki permissions change karni hain

can_inviteOptional

Invite code share karne ki permission

can_add_placesOptional

Places add/update karne ki permission

can_receive_member_alertsOptional

Circle join/leave notifications receive karne ki permission

PUT /circles/{id}/location-sharing 🔒 Toggle apni location sharing on/off for a circle ▼

📥 Response (200)

{ "success": true, "message": "Location sharing enabled for this circle",
  "data": { "circle_id": 1, "is_location_sharing": true } }

📝 Request Form

URL:

{id}URL Param

Circle ID jisme location sharing toggle karni hai

is_enabledRequired

Owner by default OFF hota hai — enable karna hoga

📍 Locations

▼

POST /locations 🔒 Save single location (also emits Socket.IO) ▼

📝 Request Form

URL:

latitudeRequired

number — -90 to 90

longitudeRequired

number — -180 to 180

battery_levelOptional

integer — 0 to 100

activity_typeOptional

is_movingOptional

recorded_atOptional

datetime — kab record huyi thi

POST /locations/batch 🔒 Save multiple locations (offline sync) ▼

📝 Request Form

URL:

locationsRequired

JSON array — har item mein latitude, longitude, recorded_at required

GET /locations/history 🔒 Get location history (with date filter) ▼

📝 Request Form — Query Parameters

URL:

fromOptional

date — YYYY-MM-DD se filter

toOptional

date — YYYY-MM-DD tak filter

limitOptional

integer — default: 100, max: 1000

🏠 Places / Geofences

▼

GET /circles/{circleId}/places 🔒 List all places in a circle ▼

📝 Request Form

URL:

{circleId}URL Param

Circle ka ID jis ke places chahiye

POST /circles/{circleId}/places 🔒 Create a new place/geofence ▼

📝 Request Form

URL:

{circleId}URL Param

nameRequired

latitudeRequired

longitudeRequired

radiusRequired

integer (meters) — geofence ka radius

addressOptional

PUT /circles/{circleId}/places/{placeId} 🔒 Update a place ▼

📝 Request Form

URL:

{circleId}URL Param

{placeId}URL Param

nameOptional

radiusOptional

meters

addressOptional

DELETE /circles/{circleId}/places/{placeId} 🔒 Delete a place ▼

📝 Request Form

URL:

{circleId}URL Param

{placeId}URL Param

⚠️ Place permanently delete ho jayega

🔔 Notifications

▼

GET /notifications 🔒 List all notifications (paginated, unread first) ▼

📥 Response (200)

{ "success": true, "unread_count": 3, "data": { "current_page": 1, "data": [{"id": 5, "type": "place_entered", "title": "...", "is_read": false, ...}], "total": 5 } }

📝 Request Form — Query Parameters

URL:

per_pageOptional

integer — default: 20

pageOptional

integer — page number

GET /notifications/unread-count 🔒 Get unread notification count ▼

📥 Response (200)

{ "success": true, "data": { "unread_count": 3 } }

📝 Request Form

URL:

🔒 Sirf unread count return hoga. Koi body nahi.

PUT /notifications/{id}/read 🔒 Mark single notification as read ▼

📝 Request Form

URL:

{id}URL Param

integer — notification ka ID

PUT /notifications/read-all 🔒 Mark all notifications as read ▼

📝 Request Form

URL:

Saari unread notifications read mark ho jayengi.

DELETE /notifications/{id} 🔒 Delete single notification ▼

📝 Request Form

URL:

{id}URL Param

integer — notification ka ID

DELETE /notifications/clear 🔒 Clear all notifications ▼

📝 Request Form

URL:

⚠️ Saari notifications permanently delete ho jayengi!

POST /sos 🔒 🚨 Trigger SOS alert — auto sends to ALL joined circles ke members ▼

📥 Response (200)

{ "success": true, "message": "SOS alert sent to all circle members",
  "sent_to": 5, "circles_scanned": 3, "push_sent": 4, "push_failed": 1 }

📝 Request Form

URL:

🔑 Koi body field required nahi — Bearer Token se auto detect hota hai user ke saare joined circles aur unke members ko SOS bhejta hai

POST /fall-alert 🔒 Trigger fall alert — auto sends to all joined circles ke enabled members ▼

📥 Response (200)

{ "success": true, "message": "Fall alert sent to enabled members",
  "sent_to": 4, "circles_scanned": 3, "push_sent": 3, "push_failed": 1 }

📝 Request Form

URL:

🔑 Koi body field required nahi — Bearer Token se auto detect hota hai user ke saare joined circles aur jinke fall alert enabled hai unko notification jaata hai

POST /alert-settings/members 🔒 Toggle fall alert per member for a circle ▼

📥 Response (200)

{ "success": true, "message": "Member fall alert settings updated" }

📝 Request Form

URL:

circle_idRequired

Circle ID

membersRequired

JSON array — user_id aur is_enabled (true/false) for each member

⚙️ Alert Settings — Sender-Side Circle Selection

▼

GET /alert-settings/{alert_type} 🔒 Get circle selections for an alert type ▼

📥 Response (200)

{ "success": true, "data": { "alert_type": "place_alert", "circles": [{"id": 1, "name": "Family", "is_enabled": true}, {"id": 2, "name": "Work", "is_enabled": false}] } }

📝 Request Form

URL:

{alert_type}URL Param

Alert type select karo

POST /alert-settings 🔒 Update circle selections for an alert type ▼

📥 Response (200)

{ "success": true, "message": "Alert settings updated" }

📝 Request Form

URL:

alert_typeRequired

circlesRequired

JSON array — circle_id aur is_enabled (true/false) for each circle

🛠️ Dev Tools — Direct DB Queries

▼

GET /dev/member-locations 🔒 Circle owner kisi bhi member ki location history dekh sakta hai ▼

📥 Response (200)

{ "success": true, "user": "Ahmed", "user_id": 5, "total": 42, "data": [{"id": 1, "user_id": 5, "latitude": "31.5204000", "longitude": "74.3587000", ...}] }

📝 Request Form — 🔒 Circle Owner ka Token chahiye

URL:

user_idRequired

Jis member ki location history dekhni hai uski User ID

fromOptional

Start date se filter karo

toOptional

End date tak filter karo

GET /dev/locations 🔒 Get all locations for authenticated user (SELECT * FROM locations WHERE user_id = ?) ▼

📥 Response (200)

{ "success": true, "user": "Ali Khan", "total": 25, "data": [{"id": 1, "user_id": 4, "latitude": "31.5204000", "longitude": "74.3587000", ...}] }

📝 Request Form — 🔒 Bearer Token Required (first get token from Quick Login above)

URL:

fromOptional

Filter locations from this date

toOptional

Filter locations up to this date

Location Tracker API v1.0

👤 Quick User Switcher

🔐 Authentication

⭕ Circles — CRUD

⚡ Circle Actions

📍 Locations

🏠 Places / Geofences

🔔 Notifications

⚙️ Alert Settings — Sender-Side Circle Selection

🛠️ Dev Tools — Direct DB Queries