{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"7aa36c99-ceec-4c08-b4a9-c5243ff12398","name":"Tour Booking App","description":"# Tour Booking App API Documentation\n\n## Overview\n\nNatours is a RESTful API for managing tours, users, reviews, and authentication.  \nIt supports role-based access control (User / Admin) and JWT authentication.\n\n---\n\n## Base URL\n\n```\n{{URL}}/api/v1\n\n ```\n\n---\n\n## Authentication\n\nNatours uses **JWT (Bearer Token)** authentication.\n\n```\nAuthorization: Bearer {{jwt}}\n\n ```\n\n- Token is returned on **login / signup**\n    \n- Required for protected routes\n    \n- Admin-only routes require `role: admin`\n    \n\n---\n\n## API Modules\n\n### 1️⃣ Authentication\n\n- **POST** `/users/signup` – Create new user\n    \n- **POST** `/users/login` – Login user\n    \n- **POST** `/users/forgotPassword`\n    \n- **PATCH** `/users/resetPassword/:token`\n    \n- **PATCH** `/users/updateMyPassword`\n    \n\n---\n\n### 2️⃣ Users\n\n#### User (Authenticated)\n\n- **GET** `/users/me` – Get current user\n    \n- **PATCH** `/users/updateMe` – Update own data\n    \n- **DELETE** `/users/deleteMe` – Deactivate own account\n    \n\n#### Admin Only\n\n- **GET** `/users` – Get all users\n    \n- **GET** `/users/:id` – Get user by ID\n    \n- **PATCH** `/users/:id` – Update user\n    \n- **DELETE** `/users/:id` – Delete user\n    \n\n---\n\n### 3️⃣ Tours\n\n#### Public\n\n- **GET** `/tours` – Get all tours\n    \n- **GET** `/tours/:id` – Get tour by ID\n    \n\n#### Admin / Lead-Guide\n\n- **POST** `/tours` – Create tour\n    \n- **PATCH** `/tours/:id` – Update tour\n    \n- **DELETE** `/tours/:id` – Delete tour\n    \n\n#### Advanced\n\n- **GET** `/tours/top-5-cheap`\n    \n- **GET** `/tours/tour-stats`\n    \n- **GET** `/tours/monthly-plan/:year`\n    \n- **GET** `/tours-within/:distance/center/:latlng/unit/:unit`\n    \n- **GET** `/tours/distances/:latlng/unit/:unit`\n    \n\n---\n\n### 4️⃣ Reviews\n\nReviews are **nested under tours**.\n\n- **GET** `/tours/:tourId/reviews` – Get tour reviews\n    \n- **POST** `/tours/:tourId/reviews` – Create review (User)\n    \n\nAdmin:\n\n- **GET** `/reviews`\n    \n- **DELETE** `/reviews/:id`\n    \n\n---\n\n## Roles & Permissions\n\n| Role | Permissions |\n| --- | --- |\n| user | Book tours, write reviews, manage own profile |\n| admin | Full access to users, tours, and reviews |\n| lead-guide | Manage tours |\n\n---\n\n## Common Response Format\n\n``` json\n{\n  \"status\": \"success\",\n  \"data\": {\n    \"data\": {}\n  }\n}\n\n ```\n\n---\n\n## Error Response Format\n\n``` json\n{\n  \"status\": \"fail\",\n  \"message\": \"Error description\"\n}\n\n ```\n\n---\n\n## Notes\n\n- Uses MongoDB with Mongoose\n    \n- Uses REST best practices\n    \n- Supports filtering, sorting, pagination, and field limiting\n    \n- Designed for learning real-world backend architecture\n    \n\n---\n\n## Project Use Case\n\nNatours is a learning-focused backend project demonstrating:\n\n- Authentication & Authorization\n    \n- REST API design\n    \n- Role-based access control\n    \n- Real-world data modeling\n    \n\n---\n\n## Maintainer\n\nNatours API – Backend Project","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"46789817","team":8864040,"collectionId":"7aa36c99-ceec-4c08-b4a9-c5243ff12398","publishedId":"2sBXVifpK4","public":true,"publicUrl":"https://documenter-api.postman.tech/view/46789817/2sBXVifpK4","privateUrl":"https://go.postman.co/documentation/46789817-7aa36c99-ceec-4c08-b4a9-c5243ff12398","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.0","publishDate":"2026-01-17T22:50:59.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/f8d4b1a68d392e807bce37b9a10986ff742d4450ff33d847478667a71858fdb6","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sBXVifpK4"}