This Postman collection contains all the API routes for managing user authentication, event creation, invitee management, and automated email reminders based on event time and invitee timezones.
\nRegister new users (name, email, password)
\nLogin with email & password to get a JWT token
\nAll protected routes require this token via the Authorization: Bearer header.
Create Event: Add a new event with title, date, duration, location, and optional description.
\nGet All Events (for the logged-in user)
\nGet Single Event by ID
\nUpdate Event: Modify event details
\nDelete Event: Remove event and associated invitees
\nAll event times are stored and handled in UTC. The server uses dayjs for precise timezone and scheduling logic.
Add Invitee to an event by providing their email, city, and timezone.
\nGet All Invitees for a specific event
\nResend Email Invite to a specific invitee
\nDelete Invitee from an event
\nTimezones are used to schedule reminders relative to each invitee's local time.
\nA background job runs every minute using node-cron
It checks if any events are about to start in the next X minutes (configurable via .env as REMINDER_TIME_MINUTES)
For all invitees of those events, reminder emails are sent automatically
\nBackend: Node.js + Express
\nDatabase: MongoDB + Mongoose
\nAuth: JWT with middleware protection
\nEmail Service: Nodemailer
\nTimezone Intelligence: dayjs, city-timezones
Cron Jobs: node-cron
POST
{{URL}}/auth/signup
This endpoint is used to register a new user by providing their details. Upon successful registration, the server responds with an authentication token.
\nThe request body must be in JSON format and include the following parameters:
\nname (string): The full name of the user.
\nemail (string): The email address of the user, which must be unique.
\npassword (string): The password chosen by the user, which should meet security requirements.
\n{\n \"name\": \"Tushar\",\n \"email\": \"admin123@gmail.com\",\n \"password\": \"Admin@123\"\n}\n\nOn a successful signup, the server returns a JSON object containing:
\n{\n \"token\": \"\"\n}\n\n200 OK: Indicates that the signup was successful and the token is returned.
\nOther related endpoints may return various data structures, typically including fields such as _id, title, description, date, durationMinutes, location, createdBy, createdAt, updatedAt, and __v, depending on the specific API call.
This endpoint is essential for user registration and is the first step for users to access protected resources within the application.
\n","urlObject":{"path":["auth","signup"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4e6fedde-314f-4cb7-9ff8-efce52331c2b"},{"name":"Login","id":"fe2bb4c2-b7b4-4110-a1a6-ec07fe51ef5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\":\"admin123@gmail.com\",\r\n \"password\":\"Admin@123\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/auth/login","description":"This endpoint is used to authenticate a user by logging them into the application. It requires the user's email and password to be provided in the request body.
\nMethod: POST
URL: {{URL}}/auth/login
Request Body:
\n{\n \"email\": \"string\", // The email address of the user\n \"password\": \"string\" // The password associated with the user's account\n}\n\nUpon successful login, the API will return a JSON response containing a token that can be used for subsequent authenticated requests.
\nResponse Body:
\n{\n \"token\": \"string\" // A token used for authentication in future requests\n}\n\n200 OK: Indicates that the login was successful and the token is returned.
\n401 Unauthorized: Indicates that the login credentials are invalid.
\nEnsure that the email and password are correct to avoid authentication errors.
\nThe token received in the response should be stored securely and included in the headers of subsequent requests to access protected resources.
\nThis endpoint allows you to create a new event by sending a POST request to the /events/ endpoint. The request requires a JSON payload that includes details about the event.
The following parameters should be included in the request body:
\ntitle (string): The title of the event.
\ndescription (string): A brief description of the event.
\ndate (string): The date and time of the event in ISO 8601 format (e.g., \"2025-08-01T01:15\").
\ndurationMinutes (integer): The duration of the event in minutes.
\nlocation (string): The location where the event will take place.
\n{\n \"title\": \"Test Event 3\",\n \"description\": \"Testing the remainder function ...\",\n \"date\": \"2025-08-01T01:15\",\n \"durationMinutes\": 90,\n \"location\": \"Mumbai, India\"\n}\n\nUpon successful creation of the event, the API will return a 201 Created status code along with a JSON response containing the following fields:
title (string): The title of the created event.
\ndescription (string): The description of the created event.
\ndate (string): The date and time of the created event.
\ndurationMinutes (integer): The duration of the created event in minutes.
\nlocation (string): The location of the created event.
\ncreatedBy (string): The identifier of the user who created the event.
\n_id (string): The unique identifier for the created event.
\ncreatedAt (string): The timestamp when the event was created.
\nupdatedAt (string): The timestamp when the event was last updated.
\n__v (integer): The version key.
\n{\n \"title\": \"\",\n \"description\": \"\",\n \"date\": \"\",\n \"durationMinutes\": 0,\n \"location\": \"\",\n \"createdBy\": \"\",\n \"_id\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"__v\": 0\n}\n\nEnsure that all required fields are provided in the request body.
\nThe response will include the details of the created event, which can be used for further operations or confirmations.
\nThis endpoint is crucial for managing events within the application, and proper validation of the input data is recommended to avoid errors.
\nThis endpoint allows users to retrieve a list of events associated with their account. It provides detailed information about each event, including its title, description, date, duration, location, and metadata regarding its creation and updates.
\nMethod: GET
\nURL: {{URL}}/events/me
Upon a successful request, the server responds with a 200 OK status and returns a JSON array containing the following fields for each event:
_id: (String) Unique identifier for the event.
\ntitle: (String) The title of the event.
\ndescription: (String) A brief description of the event.
\ndate: (String) The date when the event is scheduled to occur.
\ndurationMinutes: (Integer) The duration of the event in minutes.
\nlocation: (String) The location where the event will take place.
\ncreatedBy: (String) Identifier for the user who created the event.
\ncreatedAt: (String) Timestamp indicating when the event was created.
\nupdatedAt: (String) Timestamp indicating the last update of the event.
\n__v: (Integer) Version key for the document.
\n[\n {\n \"_id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"date\": \"\",\n \"durationMinutes\": 0,\n \"location\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"__v\": 0\n }\n]\n\nThis endpoint is part of a broader API that includes various related endpoints for managing events and user information, which may return similar data structures. The successful responses from these endpoints typically include status codes such as 200 OK and 201 Created, indicating the successful retrieval or creation of resources.
This endpoint is essential for users who want to view their scheduled events and manage their planning effectively.
\n","urlObject":{"path":["events","me"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cd59021f-580d-44ac-bc3e-9d7084bbc0b8"},{"name":"Event","id":"1f27931c-368e-4ba7-a652-a5c349c47680","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{vault:json-web-token}}","type":"text"}],"url":"{{URL}}/events/688bb9a9ae64217ec4d50a65","description":"This endpoint retrieves the details of a specific event identified by its unique ID. The request is made using the HTTP GET method.
\nPath Parameter:
\nid (string): The unique identifier of the event you wish to retrieve.GET {{URL}}/events/688bb9a9ae64217ec4d50a65\n\nOn a successful request, the API returns a JSON object containing the details of the event. The response will include the following fields:
\n_id (string): The unique identifier for the event.
title (string): The title of the event.
description (string): A brief description of the event.
date (string): The date and time of the event in ISO 8601 format.
durationMinutes (integer): The duration of the event in minutes.
location (string): The location where the event will take place.
createdBy (string): The identifier of the user who created the event.
createdAt (string): The timestamp of when the event was created.
updatedAt (string): The timestamp of when the event was last updated.
__v (integer): The version key for the event document.
{\n \"_id\": \"event_id\",\n \"title\": \"Event Title\",\n \"description\": \"Event description here.\",\n \"date\": \"2025-07-30T21:00\",\n \"durationMinutes\": 90,\n \"location\": \"Mumbai\",\n \"createdBy\": \"user_id\",\n \"createdAt\": \"timestamp\",\n \"updatedAt\": \"timestamp\",\n \"__v\": 0\n}\n\n200 OK: The request was successful, and the event details are returned.
\n404 Not Found: The event with the specified ID does not exist.
\nThis endpoint is essential for retrieving event information, which can be utilized for display in user interfaces or for further processing in applications.
\n","urlObject":{"path":["events","688bb9a9ae64217ec4d50a65"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1f27931c-368e-4ba7-a652-a5c349c47680"},{"name":"Update Event","id":"9dc9c771-cc78-425f-bfad-6735cd9b7211","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{vault:json-web-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \r\n \"date\": \"2025-07-31T01:25\",\r\n \"location\": \"Mumbai, India\"\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/events/688b71d9b12ec0926736a1e6","description":"This endpoint allows you to update the details of a specific event identified by its unique ID. The request modifies the event's date and location.
\nThe request body should be in JSON format and include the following parameters:
\ndate (string): The new date and time for the event in ISO 8601 format (e.g., \"2025-07-31T01:25\").
\nlocation (string): The new location for the event (e.g., \"Mumbai, India\").
\n{\n \"date\": \"2025-07-31T01:25\",\n \"location\": \"Mumbai, India\"\n}\n\nUpon a successful update, the server will respond with a status code of 200 and a JSON object containing the updated event details. The structure of the response will include:
\n_id (string): The unique identifier of the event.
\ntitle (string): The title of the event.
\ndescription (string): A description of the event.
\ndate (string): The updated date and time of the event.
\ndurationMinutes (integer): The duration of the event in minutes.
\nlocation (string): The updated location of the event.
\ncreatedBy (string): The identifier of the user who created the event.
\ncreatedAt (string): Timestamp of when the event was created.
\nupdatedAt (string): Timestamp of when the event was last updated.
\n__v (integer): Version key for the event document.
\n{\n \"_id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"date\": \"\",\n \"durationMinutes\": 0,\n \"location\": \"\",\n \"createdBy\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"__v\": 0\n}\n\nEnsure that the event ID in the URL is valid and corresponds to an existing event.
\nThe response structure may vary slightly based on the event's data and attributes.
\nThis endpoint is part of a broader API that manages events, and similar endpoints may return related data structures.
\nThis endpoint is used to delete a specific event from the system. The event to be deleted is identified by its unique identifier (ID) provided in the URL path.
\nPath Parameter
\nid (string): The unique identifier of the event that you wish to delete.Upon successful deletion of the event, the API will return a response with a status code of 200 and a message indicating the success of the operation.
Other methods (such as GET) called on the same URL may return detailed information about the event, structured as follows:
\nThis structure provides comprehensive details about the event, including its title, description, date, duration, location, and timestamps for creation and updates.
\nAdditionally, calls to other related endpoints may return lists of events or related data, which follow similar structures, ensuring consistency across the API responses.
\n200 OK: Indicates that the event was successfully deleted.
Other status codes may indicate different outcomes based on the request made to the API.
\nMake sure to handle the responses appropriately in your application to provide feedback to users regarding the success or failure of their delete requests.
\n","urlObject":{"path":["events","688b7239b12ec0926736a1e9"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"924b6407-911e-47b0-a7d4-dd8136d87f1d"}],"id":"6442aed7-0460-4216-9f04-22d16596d40f","_postman_id":"6442aed7-0460-4216-9f04-22d16596d40f","description":""},{"name":"Invitees","item":[{"name":"Invite","id":"8c8777ed-23d7-4b49-aac3-97882697c0a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{vault:json-web-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"email\": \"arctdarknight1551@gmail.com\",\r\n \"city\": \"New York, United States\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/invites/688bb9a9ae64217ec4d50a65","description":"This endpoint allows you to create an invite by submitting an email address and the associated city. Upon successful creation, a response will be returned with details of the invite.
\nMethod: POST
\nURL: {{URL}}/invites/{inviteId}
The request body must be in JSON format and should include the following parameters:
\nemail (string): The email address of the invitee. This is a required field.
\ncity (string): The city where the invitee is located. This is a required field.
\nExample Request Body:
\n{\n \"email\": \"example@example.com\",\n \"city\": \"New York, United States\"\n}\n\nOn a successful request, the server will respond with a 201 Created status code and a JSON object containing the following fields:
event (string): The event associated with the invite (may be empty).
\nemail (string): The email address provided in the request.
\ncity (string): The city provided in the request.
\ntimezone (string): The timezone related to the invitee (may be empty).
\n_id (string): A unique identifier for the invite.
\ncreatedAt (string): Timestamp of when the invite was created.
\nupdatedAt (string): Timestamp of the last update made to the invite.
\n__v (integer): Version key for the invite document.
\nExample Response:
\n{\n \"event\": \"\",\n \"email\": \"example@example.com\",\n \"city\": \"New York, United States\",\n \"timezone\": \"\",\n \"_id\": \"unique_id\",\n \"createdAt\": \"timestamp\",\n \"updatedAt\": \"timestamp\",\n \"__v\": 0\n}\n\nOther related endpoints may return similar data structures, allowing for consistent handling of invite-related information across the API.
\nSuccessful retrieval of invites may return a 200 OK status with an array of invites.
Other endpoints may return various data structures related to events, messages, and other entities within the API.
\nEnsure that the email and city fields are provided in the correct format to avoid validation errors. The API will return appropriate status codes to indicate success or failure of the request.
\n","urlObject":{"path":["invites","688bb9a9ae64217ec4d50a65"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8c8777ed-23d7-4b49-aac3-97882697c0a6"},{"name":"All Invitees","id":"25f1e5a2-9fdc-4e76-8a40-2ea9bf5698ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{vault:json-web-token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}/invites/688bb9a9ae64217ec4d50a65","urlObject":{"path":["invites","688bb9a9ae64217ec4d50a65"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"25f1e5a2-9fdc-4e76-8a40-2ea9bf5698ac"},{"name":"Resend","id":"1774148b-a690-4c06-bfdf-025568dce3e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{vault:json-web-token}}","type":"text"}],"url":"{{URL}}/invites/688b71d9b12ec0926736a1e6/resend/688b9dc04c7f6dd6ae56edcb","description":"This endpoint allows users to resend an invitation to a specified recipient. The request is made via an HTTP POST method to the endpoint {{URL}}/invites/{inviteId}/resend/{recipientId}, where {inviteId} is the ID of the invite being resent and {recipientId} is the ID of the recipient.
inviteId (path parameter): The unique identifier of the invite that you want to resend.
\nrecipientId (path parameter): The unique identifier of the recipient to whom the invite is being resent.
\nUpon a successful request, the API will return a response with a status code of 200 or 201, depending on the operation performed. The response body may include:
200 OK: Indicates that the invite was successfully resent. The response may include the following fields:
\n_id: The unique identifier of the invite.
event: The event associated with the invite.
email: The email of the recipient.
city: The city of the recipient.
timezone: The timezone of the recipient.
createdAt: Timestamp of when the invite was created.
updatedAt: Timestamp of when the invite was last updated.
__v: Version key for the invite document.
201 Created: Indicates that a new resource has been created as a result of the request. The response may include:
\ntoken: A token associated with the invite.
title: The title of the event.
description: A brief description of the event.
date: The date of the event.
durationMinutes: Duration of the event in minutes.
location: The location of the event.
createdBy: The user who created the invite.
_id: The unique identifier of the newly created resource.
createdAt: Timestamp of when the resource was created.
updatedAt: Timestamp of when the resource was last updated.
__v: Version key for the resource document.
Ensure that the inviteId and recipientId are valid and exist in the system before making the request.
The response structure may vary slightly based on the specific operation and the data associated with the invite and recipient.
\nAlways check for the appropriate status codes to determine the outcome of your request.
\nThis endpoint is essential for managing invitations effectively and ensuring that recipients receive the necessary information regarding events.
\n","urlObject":{"path":["invites","688b71d9b12ec0926736a1e6","resend","688b9dc04c7f6dd6ae56edcb"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1774148b-a690-4c06-bfdf-025568dce3e4"},{"name":"Delete Invitee","id":"6ba24ef3-acdb-4e6a-ba85-8f250dfe2bb9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{vault:json-web-token}}","type":"text"}],"url":"{{URL}}/invites/688b71d9b12ec0926736a1e6/remove/688b9dee4c7f6dd6ae56edd0","description":"This endpoint is used to remove a specific invitation associated with a given user from the system. By executing this request, the specified invite will be deleted, which may affect the user's access to the associated event.
\ninviteId (path parameter): The unique identifier of the invitation to be removed.
userId (path parameter): The unique identifier of the user whose invitation is being removed.
Upon a successful deletion, the API will return a response with a status code of 200 and a message indicating the result of the operation. The response will be in the following format:
\n{\n \"message\": \"\"\n}\n\nThis endpoint is part of a broader API that manages events and invitations. Other endpoints may return various data structures, including details about events, users, and invitations, typically containing fields such as _id, title, description, date, durationMinutes, location, createdBy, and timestamps for creation and updates.
Overall, this DELETE request is crucial for maintaining the integrity of event invitations and ensuring that users have the correct access to events.
\n","urlObject":{"path":["invites","688b71d9b12ec0926736a1e6","remove","688b9dee4c7f6dd6ae56edd0"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6ba24ef3-acdb-4e6a-ba85-8f250dfe2bb9"}],"id":"7480ec17-3b51-4107-b263-d05f9a5691b1","_postman_id":"7480ec17-3b51-4107-b263-d05f9a5691b1","description":""}]}