The Natours API contains endpoints for Tours, Users, Reviews, and Bookings.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8689170","collectionId":"278e7a16-1061-4e26-8e15-ca4008963d7a","publishedId":"SVmzvwpY","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-10-01T16:32:38.000Z"},"item":[{"name":"Tours","item":[{"name":"Create New Tours","id":"a1af0c9a-3f32-45f7-82db-a6693bf9f04c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":" {\r\n \"name\": \"New Test tour\",\r\n \"duration\": 1,\r\n \"maxGroupSize\": 1,\r\n \"difficulty\": \"easy\",\r\n \"price\": 200,\r\n \"summary\": \"Test Tour\",\r\n \"imageCover\": \"tour-3-cover.jpg\"\r\n }"},"url":"{{URL}}api/v1/tours","description":"Use this endpoint to create a new tour.
\n(Requires login as admin or lead-guide)
Use this endpoint to get all tours.
\n","urlObject":{"path":["v1","tours"],"host":["{{URL}}api"],"query":[{"description":{"content":"Query for sorting the tour based on certain fields
\n","type":"text/plain"},"key":"sort","value":"-price,-ratingsAverage"},{"description":{"content":"Query for including or excluding the fields
\n","type":"text/plain"},"key":"fields","value":"-name,-duration"},{"description":{"content":"Query for tour duration. Supports gte, lte, gt, lt operators.
\n","type":"text/plain"},"key":"duration[gte]","value":"5"},{"description":{"content":"Query for tour price. Supports gte, lte, gt, lt operators.
\n","type":"text/plain"},"key":"price[lt]","value":"1500"},{"description":{"content":"Query for tour ratings. Supports gte, lte, gt, lt operators.
\n","type":"text/plain"},"key":"ratingsAverage[gte]","value":"4.7"},{"description":{"content":"Query for tour result limit
\n","type":"text/plain"},"key":"limit","value":"5"}],"variable":[]}},"response":[],"_postman_id":"e9e80928-d45b-4b00-8322-45bf8fa420a1"},{"name":"Get Tour","id":"2451ec6b-0729-46ce-a11b-42677a012f2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{URL}}api/v1/tours/5d89f6196b2a8b178005b002","description":"Use this endpoint to get a specific tour details using its tourID.
\n","urlObject":{"path":["v1","tours","5d89f6196b2a8b178005b002"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"2451ec6b-0729-46ce-a11b-42677a012f2b"},{"name":"Update Tours","id":"0f74c7f7-af20-44a0-9091-149e817ebb4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"maxGroupSize\": 12,\n\t\"difficulty\": \"easy\",\n\t\"imageCover\": \"tour-5-cover.jpg\",\n\t\"price\": 1497\n}"},"url":"{{URL}}api/v1/tours/5d906cba5428cc0f18a596e2","description":"Use this endpoint to update an existing tour
(Requires login as admin or lead-guide)
Use this endpoint to delete an existing tour
(Requires login as admin or lead-guide)
Use this endpoint to get tour statistics based on tour difficulty.
\n","urlObject":{"path":["v1","tours","tour-stats"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"0683af31-86c9-4a31-a6a2-771889a7a27d"},{"name":"Get Top 5 Cheap Tours","id":"98839566-d04a-4c7d-8530-ba2bb3ce2834","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{URL}}api/v1/tours/top-5-cheap","description":"Use this endpoint to get the details of 5 cheapest tour.
\n","urlObject":{"path":["v1","tours","top-5-cheap"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"98839566-d04a-4c7d-8530-ba2bb3ce2834"},{"name":"Get Monthly Plan","id":"cb256610-37f4-4663-a503-72629ee99d41","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{URL}}api/v1/tours/monthly-plan/2021","description":"Use this endpoint to get monthly plan by year
(Requires login by admin, lead-guide, or guide)
Use this endpoint to get tours within a certain radius by defining the distance (Eg. 200 miles) and the coordinates (latitude and longitude).
\n","urlObject":{"path":["v1","tours","tours-within","200","center","34.098453,-118.096327","unit","mi"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"a40c0e71-259f-4f04-a675-e596172a878d"},{"name":"Get Distances to Tours From Point","id":"84b3db83-3bdd-440a-a74d-6191ecb4a8a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{URL}}api/v1/tours/distances/34.098453,-118.096327/unit/mi","description":"Use this endpoint to get all tours distance from the specified coordinates.
\n","urlObject":{"path":["v1","tours","distances","34.098453,-118.096327","unit","mi"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"84b3db83-3bdd-440a-a74d-6191ecb4a8a7"}],"id":"358f63a6-4cdc-4df6-ac3d-dd55376085a7","description":"You can get all tours, create new ones, and edit and delete tour. There are also special endpoints for some special requirements.
\n","event":[{"listen":"prerequest","script":{"id":"d4733346-fbcd-4975-a049-6b178e890698","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ccd1fddf-9299-491a-83cd-e5d066f96a2c","type":"text/javascript","exec":[""]}}],"_postman_id":"358f63a6-4cdc-4df6-ac3d-dd55376085a7"},{"name":"Users","item":[{"name":"Get All User","id":"68a7f915-de2e-49f9-97a8-ef060042b3a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{URL}}api/v1/users","description":"Use this endpoint to get all users.
(Requires login as admin)
Use this endpoint to get details of a certain user.
(Requires login as admin)
Use this endpoint to update a user.
(Requires login as admin)
Use this endpoint to delete a user.
(Requires login as admin)
Use this endpoint to get details of current logged-in user.
(Requires login)
Use this endpoint to update details of current logged-in user.
(Requires login)
Use this endpoint to deactivating the current logged-in user account temporarily.
(Requires login)
You can get your user profile details, update and delete your account. There are also special endpoints for some special requirements which can only be accessed by the administrator.
\n","event":[{"listen":"prerequest","script":{"id":"0ebbf9d1-3240-404e-8f13-b95062ad4ff6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b8aef6e3-18e4-4d92-820e-7b17dede7312","type":"text/javascript","exec":[""]}}],"_postman_id":"0b30ef00-2590-4d60-88fc-fee3a0fab4a7"},{"name":"Authentication","item":[{"name":"Sign Up","event":[{"listen":"test","script":{"id":"48602640-e13a-41e0-9ab6-0a838c27af79","exec":["pm.environment.set(\"jwt\", pm.response.json().token);",""],"type":"text/javascript"}}],"id":"15752555-4f94-47a4-a732-d6cbcd9b666a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":" {\r\n \"name\": \"Louis Juliendo\",\r\n \"email\": \"louis@example.com\",\r\n \"password\": \"mypass\",\r\n \"passwordConfirm\": \"mypass\"\r\n }"},"url":"{{URL}}api/v1/users/signup","description":"Use this endpoint to create new user.
\n","urlObject":{"path":["v1","users","signup"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"15752555-4f94-47a4-a732-d6cbcd9b666a"},{"name":"Login","event":[{"listen":"test","script":{"id":"ea32dd0e-8a8b-4102-91f8-c8cde799b6d6","exec":["pm.environment.set(\"jwt\", pm.response.json().token);"],"type":"text/javascript"}}],"id":"a5e1e331-6b12-42a9-8d7b-ce795e8884cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"email\": \"alex@example.com\",\n\t\"password\": \"{{password}}\"\n}"},"url":"{{URL}}api/v1/users/login","description":"Use this endpoint to log in.
\n","urlObject":{"path":["v1","users","login"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"a5e1e331-6b12-42a9-8d7b-ce795e8884cf"},{"name":"Forgot Password","event":[{"listen":"test","script":{"id":"6651efed-7311-48c0-bb1c-471e3f6ae55c","exec":["pm.environment.set(\"jwt\", pm.response.json().token);",""],"type":"text/javascript"}}],"id":"34320ca9-a39a-4e93-81d5-0d3c64c1a858","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"email\": \"alex@example.com\"\n}"},"url":"{{URL}}api/v1/users/forgotPassword","description":"Use this endpoint to send reset password request to the specified email.
\n","urlObject":{"path":["v1","users","forgotPassword"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"34320ca9-a39a-4e93-81d5-0d3c64c1a858"},{"name":"Reset Password","event":[{"listen":"test","script":{"id":"17f36e63-3ed1-4603-9562-18c1cd195946","exec":["pm.environment.set(\"jwt\", pm.response.json().token);",""],"type":"text/javascript"}}],"id":"9613b80f-f6b7-449e-83b1-e2a0eb1b2683","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"password\": \"mypass2\",\n\t\"passwordConfirm\": \"mypass2\"\n}"},"url":"{{URL}}api/v1/users/resetPassword/f823343esda9e43441fd03d86a9aa4cac52e05822342db5c86d34dad5df979babgghf1","description":"Use this endpoint to reset the password by using the forgot-password link sent to your email.
\n","urlObject":{"path":["v1","users","resetPassword","f823343esda9e43441fd03d86a9aa4cac52e05822342db5c86d34dad5df979babgghf1"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"9613b80f-f6b7-449e-83b1-e2a0eb1b2683"},{"name":"Update Current User Password","event":[{"listen":"test","script":{"id":"68d80148-5798-4276-a5c0-a2158c498b00","exec":["pm.environment.set(\"jwt\", pm.response.json().token);"],"type":"text/javascript"}}],"id":"2d234743-ef8b-4dda-9d68-44dab1d287fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"passwordCurrent\": \"mypass\",\n\t\"password\": \"mypass2\",\n\t\"passwordConfirm\": \"mypass2\"\n}"},"url":"{{URL}}api/v1/users/updateMyPassword","description":"Use this endpoint to update your password.
(Requires login)
You can sign up, login, perform forgot password request, update password and reset your password.
\n","event":[{"listen":"prerequest","script":{"id":"e7edc094-84e5-4f25-affc-c1e29f66a52d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3e78b0c2-c5aa-4750-8320-49a6e96ff3be","type":"text/javascript","exec":[""]}}],"_postman_id":"b87cc7d6-af26-4d0a-a7dc-95755b11f78f"},{"name":"Reviews","item":[{"name":"Get All Reviews","id":"4875caae-a0a7-4f69-b44b-938e83324372","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{URL}}api/v1/reviews","description":"Use this endpoint to get all reviews.
(Requires login)
Use this endpoint to get a specific review.
(Requires login)
Use this endpoint to create a new review.
(Requires login as user)
Use this endpoint to update a review.
(Requires login as user or admin)
Use this endpoint to delete a review.
(Requires login as user or admin)
You can get all reviews or a specific review, create a new one, update and delete the review. These endpoints can only be used by administrator or lead-guide.
\n","event":[{"listen":"prerequest","script":{"id":"b2ee822f-22cf-4730-9d70-170662749db8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"09e35448-1665-4159-b8e1-dd95d4ce193f","type":"text/javascript","exec":[""]}}],"_postman_id":"0d4e3c0d-7a30-450c-8c7a-1643bc206d79"},{"name":"Tours/Review","item":[{"name":"Create New Review on Tour","id":"d2911d6b-087f-4b89-8893-d23dd5a2a30c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"rating\":2.5,\n\t\"review\": \"Not a nice tour\"\n}"},"url":"{{URL}}api/v1/tours/5d43f619632af8b1405b33002/reviews","description":"Use this endpoint to create a new review on a tour.
(Requires login as user or admin)
Use this endpoint to get all reviews on a tour.
(Requires login as user or admin)
You can create a new review for a specific tour and get all reviews associated with a tour. These endpoints can only be accessed by administrator or lead-guide.
\n","event":[{"listen":"prerequest","script":{"id":"99e066a8-5af0-4071-bf23-73b5f29276dd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e5e4976d-708d-43eb-bbec-c1f58a103dd8","type":"text/javascript","exec":[""]}}],"_postman_id":"69a53290-b48e-406f-a9dc-815bc15ab321"},{"name":"Bookings","item":[{"name":"Get All Bookings","id":"34467d01-2e72-42a8-b199-e0f4207ab54b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{URL}}api/v1/bookings","description":"Use this endpoint to get all tour bookings.
(Requires login as admin or lead-guide)
Use this endpoint to get a specific tour booking.
(Requires login as admin or lead-guide)
You can get all bookings or a specific one. These endpoints can only be accessed by administrator or lead-guide.
\n","event":[{"listen":"prerequest","script":{"id":"d33363a0-fc72-4587-8f9a-4b3f50453d61","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"36555a7e-da73-4b8f-855e-d47736661c04","type":"text/javascript","exec":[""]}}],"_postman_id":"60a8fa62-f1cb-48a3-82c9-8625c6216e92"}],"event":[{"listen":"prerequest","script":{"id":"c4045d03-c40c-478b-bd91-383fc7c93ad0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fb49b8c9-1781-41b7-aac8-e9fd9a911e84","type":"text/javascript","exec":[""]}}]}