This endpoints allows you to register a a new user.
\nfirstName (string, required): The name of the user.
email (string, required): The email address of the user.
password (string, required): The password for the user. It must be at least 8 characters long.
location (string, required): The location of the user.
lastName (string, required): The last name of the user.
avatar (file, optional): An optional avatar for the user.
Reponse Fields
\n","urlObject":{"path":["api","v1","auth","register"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9afb741b-634b-4bec-8378-cc3e8c8474f2","name":"Successful Register","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"firstName","value":"Than Win","description":"(required) user's first name","type":"text"},{"key":"email","value":"{{my_email}}","description":"(required) User's email","type":"text"},{"key":"password","value":"12345678","description":"(required) Password must be at least 8 characters long","type":"text"},{"key":"location","value":"Dhaka, Bangladesh","description":"(required) User's current location","type":"text"},{"key":"lastName","value":"Hline","description":"(required) User's last name","type":"text"},{"key":"avatar","description":"(optional) User's image file","type":"file","src":"/D:/photos/low/pexels-marta-branco-1173576.jpg"}]},"url":"{{base_url}}/api/v1/auth/register"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"84"},{"key":"ETag","value":"W/\"54-nq+Gr4ymKGO5KM/weckiEBXPaq0\""},{"key":"Date","value":"Mon, 02 Dec 2024 19:53:56 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 201,\n \"data\": {},\n \"message\": \"User is created successfully\",\n \"success\": true\n}"}],"_postman_id":"34ea2848-b36e-4467-9d22-3e3d46de3f17"},{"name":"login","id":"89af940d-daf2-4fcb-a900-c33e05414478","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"user_one@gmail.com\",\r\n \"password\": \"12345678\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/auth/login","description":"This endpoint allows users to log in and obtain access to the application.
\nemail (string, required): The email address of the user.
\npassword (string, required): The password for the user's account. It must be at least 8 characters long.
\nUpon a successful request, the server responds with:
\nStatus Code: 200 OK
\nResponse Body: A JSON object with the following fields:
\nmsg (string)
\ndata (object): Contains user-related information.
\n_id (string): The unique identifier for the user.
\nname (string): The full name of the user.
\nemail (string): The user's email address.
\nlastName (string): The user's last name.
\nlocation (string): The user's current location.
\nrole (string): The user's role (e.g., \"admin\", \"user\", \"recruiter\").
\navatar (array): An array of URLs for the user's profile picture.
\naccessStatus (boolean): Indicates whether the user has access (e.g., true for active, false for suspended).
\ntwoStepAuthentication (boolean): Whether two-factor authentication is enabled.
\neducationRecords (array): An array of education records related to the user.
\ncreatedAt (string): The timestamp when the user was created.
\nupdatedAt (string): The timestamp when the user was last updated.
\nuserType (string): The type of user (e.g., \"user\", \"recruiter\").
\ncoverPhoto (array): An array of URLs for the user's cover photo.
\nphoneNumber (string): The user's phone number.
\nThis endpoint triggers the logout process for the authenticated user.
\nThis endpoint does not require a request body.
\nThe response for this request will be in JSON format with the following schema:
\n{\n \"msg\": \"user is logged out successfully\"\n}\n\nThis collection contains requests related to user authentication.
\n","_postman_id":"33d4ba6a-565c-41b4-b6a6-2a54dd991ad0"},{"name":"account setting","item":[{"name":"Change password","id":"a4f3b103-3c15-4b0d-9bb4-95eff02fefb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"oldPassword\": \"12345678\",\r\n \"newPassword\": \"12345678\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/account-setting/change-password","description":"This end point is used to change password
\nThis is protected route. user must be logged in to change password.
\nemail (string, required): The email address of the user.
\npassword (string, required): The password for the user's account. It must be at least 8 characters long.
\nSuccess Response
\nstatus code: 200 OK
\nBody:
\n{\n \"message\": \"Your password has been changed successfully\"\n}\n\nThis end point is used to check if user has entered correct password or not
\npassword(string, required): password must be at least 8 characters long
Success Response
\nstatus: 200 OK
\nbody:
\n{\n \"message\": \"your password is correct\"\n}\n\nFailure response
\nstatus: 401 Unauthorized
\n{\n \"success\": false,\n \"message\": \"invalid credentials\"\n}\n\nThis endpoint allows user to toggle the two-step authentication status for the user.User must have phone number to toggle this settting.
\nRequest Body
\nNot required
\nResponse
\nstatus: 200 OK
\nbody
\n{\n \"message\": \"two step authentican is updated.\"\n}\n\nThis endpoint allows user to delete account. Deleting account will delete all job postings and job applications.
\nSuccess Response:
\nstatus code: 200
\nBody:
\n{\n \"message\": \"Your account has been deleted\"\n}\n\nThis collection contains request related to user account setting.
\n","_postman_id":"fab8c94b-6705-4705-800b-531043af0827"},{"name":"Verification","item":[{"name":"send verification code","id":"98168db9-40f6-40f8-81f1-be2e3bf902e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"phoneNumber\": \"{{user_phone_number}}\",\r\n \"channel\": \"sms\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/verification/send-verification-code","description":"This endpoint is used to send a verification code to the provided phone number for authentication.
\nphoneNumber (string, required): The phone number to which the verification code will be sent.
channel (string, required): The channel through which the verification code will be sent (e.g. SMS).
This endpoint is used to verify the authentication code sent to the user's phone number.
\nphoneNumber (string, required): The phone number for which the code is being verified.
\ncode (string, required): The verification code received by the user.
\nThis endpoint allows you to create a new job listing.
\n{\n \"job\": {\n \"companyId\": \"\",\n \"position\": \"\",\n \"jobType\": \"\",\n \"jobLocation\": {\n \"city\": \"\",\n \"country\": \"\",\n \"_id\": \"\"\n },\n \"salary\": {\n \"min\": 0,\n \"max\": 0,\n \"_id\": \"\"\n },\n \"experianceLevel\": \"\",\n \"openRoles\": 0,\n \"createdBy\": \"\",\n \"numberOfApplicants\": 0,\n \"applicationDeadline\": \"\",\n \"_id\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"__v\": 0\n }\n}\n\n{\n \"type\": \"object\",\n \"properties\": {\n \"job\": {\n \"type\": \"object\",\n \"properties\": {\n \"companyId\": {\"type\": \"string\"},\n \"position\": {\"type\": \"string\"},\n \"jobType\": {\"type\": \"string\"},\n \"jobLocation\": {\n \"type\": \"object\",\n \"properties\": {\n \"city\": {\"type\": \"string\"},\n \"country\": {\"type\": \"string\"},\n \"_id\": {\"type\": \"string\"}\n }\n },\n \"salary\": {\n \"type\": \"object\",\n \"properties\": {\n \"min\": {\"type\": \"number\"},\n \"max\": {\"type\": \"number\"},\n \"_id\": {\"type\": \"string\"}\n }\n },\n \"experianceLevel\": {\"type\": \"string\"},\n \"openRoles\": {\"type\": \"number\"},\n \"createdBy\": {\"type\": \"string\"},\n \"numberOfApplicants\": {\"type\": \"number\"},\n \"applicationDeadline\": {\"type\": \"string\"},\n \"_id\": {\"type\": \"string\"},\n \"createdAt\": {\"type\": \"string\"},\n \"updatedAt\": {\"type\": \"string\"},\n \"__v\": {\"type\": \"number\"}\n }\n }\n }\n}\n\nThis end point is used to update a specif job by job id.This route is protected.
\nThis endpoint allows user to retrive a single job by job id.This is public route.
\nNot required
\n| ID | \r","Company | \r","Position | \r","Job Status | \r","
|---|---|---|---|
| {{_id}} | \r","{{company}} | \r","{{position}} | \r","{{jobStatus}} | \r","
This endpoint retrieves a list of jobs based on the specified filters, sorting preferences, and pagination options.This is public route.This route is public and does not require authentication
\nResponse Fields
\n","urlObject":{"path":["api","v1","jobs","all-jobs"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"country or jobLocation name
\n","type":"text/plain"},"key":"location","value":"usa"},{"disabled":true,"description":{"content":"company or position name
\n","type":"text/plain"},"key":"search","value":"astha it"},{"disabled":true,"description":{"content":"Sort by newest, oldest, or by position in ascending or descending order
\n","type":"text/plain"},"key":"sort","value":"a-z"},{"disabled":true,"key":"minSalary","value":"5000"},{"disabled":true,"key":"maxSalary","value":"60000000"},{"disabled":true,"key":"jobType[]","value":"part-time"},{"disabled":true,"key":"jobType[]","value":"full-time"},{"disabled":true,"key":"experianceLevel[]","value":"mid"},{"disabled":true,"key":"limit","value":"2"},{"disabled":true,"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"4ca72903-b6f5-40c9-8ffa-8c6a556dcd9b","name":"get all jobs","originalRequest":{"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[]},"url":{"raw":"{{base_url}}/api/v1/jobs/all-jobs","host":["{{base_url}}"],"path":["api","v1","jobs","all-jobs"],"query":[{"key":"location","value":"usa","description":"country or jobLocation name","disabled":true},{"key":"search","value":"astha it","description":"company or position name","disabled":true},{"key":"sort","value":"a-z","description":"Sort by newest, oldest, or by position in ascending or descending order","disabled":true},{"key":"minSalary","value":"5000","disabled":true},{"key":"maxSalary","value":"60000000","disabled":true},{"key":"jobType[]","value":"part-time","disabled":true},{"key":"jobType[]","value":"full-time","disabled":true},{"key":"experianceLevel[]","value":"mid","disabled":true},{"key":"limit","value":"2","disabled":true},{"key":"page","value":"1","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1909"},{"key":"ETag","value":"W/\"775-FpFLlO1Aw4u97dBqzb/kOaMm/ZA\""},{"key":"Date","value":"Mon, 31 Mar 2025 17:19:53 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"data\": {\n \"jobs\": [\n {\n \"_id\": \"67ea954fdd4176fc8866bac5\",\n \"position\": \"Software Engineer\",\n \"jobType\": \"internship\",\n \"jobLocation\": {\n \"city\": \"New York\",\n \"country\": \"USA\",\n \"_id\": \"67ea954fdd4176fc8866bac6\"\n },\n \"salary\": {\n \"min\": 70000,\n \"max\": 120000,\n \"_id\": \"67ea954fdd4176fc8866bac7\"\n },\n \"experianceLevel\": \"mid\",\n \"openRoles\": 2,\n \"createdBy\": {\n \"_id\": \"67e97a8c5ae253a36dae6b2c\",\n \"firstName\": \"Than Win\",\n \"email\": \"win@mail.com\",\n \"lastName\": \"Hline\"\n },\n \"numberOfApplicants\": 5,\n \"applicationDeadline\": \"2025-06-30T00:00:00.000Z\",\n \"createdAt\": \"2025-03-31T13:14:55.061Z\",\n \"updatedAt\": \"2025-03-31T13:14:55.061Z\",\n \"__v\": 0,\n \"company\": {\n \"_id\": \"67e87694b3424acf88b26339\",\n \"name\": \"Meta\",\n \"description\": \"A leading software development company specializing in AI and cloud computing.\",\n \"location\": {\n \"city\": \"San Francisco\",\n \"country\": \"USA\",\n \"_id\": \"67e87694b3424acf88b2633a\"\n },\n \"createdAt\": \"2025-03-29T22:39:16.114Z\",\n \"updatedAt\": \"2025-03-29T22:39:16.114Z\",\n \"__v\": 0\n }\n },\n {\n \"_id\": \"67e97f3b70836485a0923208\",\n \"position\": \"Front-end Engineer\",\n \"jobType\": \"full-time\",\n \"jobLocation\": {\n \"city\": \"New York\",\n \"country\": \"USA\",\n \"_id\": \"67e984ed21a95e3773bf6a87\"\n },\n \"salary\": {\n \"min\": 80000,\n \"max\": 120000,\n \"_id\": \"67e984ed21a95e3773bf6a86\"\n },\n \"experianceLevel\": \"mid\",\n \"openRoles\": 3,\n \"createdBy\": {\n \"_id\": \"67e97a8c5ae253a36dae6b2c\",\n \"firstName\": \"Than Win\",\n \"email\": \"win@mail.com\",\n \"lastName\": \"Hline\"\n },\n \"numberOfApplicants\": 11,\n \"applicationDeadline\": \"2025-04-30T23:59:59.999Z\",\n \"createdAt\": \"2025-03-30T17:28:27.712Z\",\n \"updatedAt\": \"2025-03-30T20:36:45.061Z\",\n \"__v\": 0,\n \"company\": {\n \"_id\": \"67e87694b3424acf88b26339\",\n \"name\": \"Meta\",\n \"description\": \"A leading software development company specializing in AI and cloud computing.\",\n \"location\": {\n \"city\": \"San Francisco\",\n \"country\": \"USA\",\n \"_id\": \"67e87694b3424acf88b2633a\"\n },\n \"createdAt\": \"2025-03-29T22:39:16.114Z\",\n \"updatedAt\": \"2025-03-29T22:39:16.114Z\",\n \"__v\": 0\n }\n }\n ],\n \"pagination\": {\n \"totalPages\": 1,\n \"currentPage\": 1,\n \"totalItems\": 2\n }\n },\n \"message\": \"Jobs have been fetched successfully\",\n \"success\": true\n}"}],"_postman_id":"83d3c487-fa58-4366-b8fd-ac5c7f766a7a"},{"name":"get current user's created jobs","id":"7b449ac8-3511-4795-a95e-921fde642f77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/api/v1/jobs","description":"This end point is used to retrieve jobs created by you. This is a protected route.
\nResponse Fields
\n","urlObject":{"path":["api","v1","jobs"],"host":["{{base_url}}"],"query":[{"disabled":true,"key":"jobType","value":"full-time"},{"disabled":true,"key":"jobStatus","value":"pending"},{"disabled":true,"key":"sort","value":"z-a"},{"disabled":true,"key":"limit","value":"1"},{"disabled":true,"key":"page","value":"2"}],"variable":[]}},"response":[{"id":"d89d0b97-4f68-4b4c-b85a-b617d8dfceb9","name":"get current user's created jobs","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/api/v1/jobs","host":["{{base_url}}"],"path":["api","v1","jobs"],"query":[{"key":"jobType","value":"full-time","disabled":true},{"key":"jobStatus","value":"pending","disabled":true},{"key":"sort","value":"z-a","disabled":true},{"key":"limit","value":"1","disabled":true},{"key":"page","value":"2","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1894"},{"key":"ETag","value":"W/\"766-CoA68Z599dFBOaDrAfk5pohDs8Q\""},{"key":"Date","value":"Mon, 31 Mar 2025 17:25:03 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"data\": {\n \"jobs\": [\n {\n \"_id\": \"67ea954fdd4176fc8866bac5\",\n \"position\": \"Software Engineer\",\n \"jobType\": \"internship\",\n \"jobLocation\": {\n \"city\": \"New York\",\n \"country\": \"USA\",\n \"_id\": \"67ea954fdd4176fc8866bac6\"\n },\n \"salary\": {\n \"min\": 70000,\n \"max\": 120000,\n \"_id\": \"67ea954fdd4176fc8866bac7\"\n },\n \"experianceLevel\": \"mid\",\n \"openRoles\": 2,\n \"createdBy\": {\n \"_id\": \"67e97a8c5ae253a36dae6b2c\",\n \"firstName\": \"Than Win\",\n \"email\": \"win@mail.com\",\n \"lastName\": \"Hline\"\n },\n \"numberOfApplicants\": 5,\n \"applicationDeadline\": \"2025-06-30T00:00:00.000Z\",\n \"createdAt\": \"2025-03-31T13:14:55.061Z\",\n \"updatedAt\": \"2025-03-31T13:14:55.061Z\",\n \"__v\": 0,\n \"company\": {\n \"_id\": \"67e87694b3424acf88b26339\",\n \"name\": \"Meta\",\n \"description\": \"A leading software development company specializing in AI and cloud computing.\",\n \"location\": {\n \"city\": \"San Francisco\",\n \"country\": \"USA\",\n \"_id\": \"67e87694b3424acf88b2633a\"\n },\n \"createdAt\": \"2025-03-29T22:39:16.114Z\",\n \"updatedAt\": \"2025-03-29T22:39:16.114Z\",\n \"__v\": 0\n }\n },\n {\n \"_id\": \"67e97f3b70836485a0923208\",\n \"position\": \"Front-end Engineer\",\n \"jobType\": \"full-time\",\n \"jobLocation\": {\n \"city\": \"New York\",\n \"country\": \"USA\",\n \"_id\": \"67e984ed21a95e3773bf6a87\"\n },\n \"salary\": {\n \"min\": 80000,\n \"max\": 120000,\n \"_id\": \"67e984ed21a95e3773bf6a86\"\n },\n \"experianceLevel\": \"mid\",\n \"openRoles\": 3,\n \"createdBy\": {\n \"_id\": \"67e97a8c5ae253a36dae6b2c\",\n \"firstName\": \"Than Win\",\n \"email\": \"win@mail.com\",\n \"lastName\": \"Hline\"\n },\n \"numberOfApplicants\": 11,\n \"applicationDeadline\": \"2025-04-30T23:59:59.999Z\",\n \"createdAt\": \"2025-03-30T17:28:27.712Z\",\n \"updatedAt\": \"2025-03-30T20:36:45.061Z\",\n \"__v\": 0,\n \"company\": {\n \"_id\": \"67e87694b3424acf88b26339\",\n \"name\": \"Meta\",\n \"description\": \"A leading software development company specializing in AI and cloud computing.\",\n \"location\": {\n \"city\": \"San Francisco\",\n \"country\": \"USA\",\n \"_id\": \"67e87694b3424acf88b2633a\"\n },\n \"createdAt\": \"2025-03-29T22:39:16.114Z\",\n \"updatedAt\": \"2025-03-29T22:39:16.114Z\",\n \"__v\": 0\n }\n }\n ],\n \"pagination\": {\n \"totalPages\": 1,\n \"currentPage\": 1,\n \"totalItems\": 2\n }\n },\n \"message\": \"successfully fetched\",\n \"success\": true\n}"}],"_postman_id":"7b449ac8-3511-4795-a95e-921fde642f77"},{"name":"Delete a job","id":"f3228654-45ab-4b18-a68f-bb65712be653","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/jobs/{{job_id}}","description":"This endpoint is used to delete a specific job with the given ID.
\nstatus: 200 OK
\nbody:
\n{\n \"msg\": \"job deleted\"\n}\n\nStartFragment
\nThis endpoint is used to retrieve the details of the current user.
\nThis request does not require a request body.
\nIt will give User object.
\n","urlObject":{"path":["api","v1","users","current-user"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0bb1dcc5-a990-4dfc-af76-2d357d3ddf74","name":"get current user","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/api/v1/users/current-user"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"787"},{"key":"ETag","value":"W/\"313-v6Q9bzeL2xnSAL2UyzAmrnrOuM4\""},{"key":"Date","value":"Mon, 31 Mar 2025 18:20:20 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"data\": {\n \"_id\": \"67ead21b825cc08f7e704280\",\n \"firstName\": \"Than Win\",\n \"email\": \"win@mail.com\",\n \"lastName\": \"Hline\",\n \"location\": {\n \"city\": \"Dhaka\",\n \"country\": \"Bangladesh\",\n \"_id\": \"67ead21b825cc08f7e704281\"\n },\n \"accessStatus\": true,\n \"twoStepAuthentication\": false,\n \"isDeleted\": null,\n \"isEmailVerified\": false,\n \"emailVerifyTokenExpiry\": null,\n \"forgotPasswordTokenExpiry\": null,\n \"role\": [\n \"67e82bb5790c51c2b7cd2cf5\"\n ],\n \"worksAt\": \"67e87694b3424acf88b26339\",\n \"educationRecords\": [],\n \"createdAt\": \"2025-03-31T17:34:19.927Z\",\n \"updatedAt\": \"2025-03-31T18:20:09.176Z\",\n \"__v\": 0,\n \"avatar\": {\n \"url\": \"http://res.cloudinary.com/dlxptkhle/image/upload/v1743445208/acd4ftp3xwloiji5c33b.jpg\",\n \"publicId\": \"acd4ftp3xwloiji5c33b\",\n \"_id\": \"67eadcd96672737fb2dfdd49\"\n }\n },\n \"message\": \"user is information is fetched successfully\",\n \"success\": true\n}"}],"_postman_id":"259016ff-e14d-4681-8b98-1388c72b48e2"},{"name":"List all users","id":"c6e97f53-0856-4856-9ccd-ce77d32143d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/api/v1/users/get-users-list?limit=2","description":"This endpoint retrieves a paginated list of users, sorted alphabetically by name. This is for admin route
\nReponse body
\n","urlObject":{"path":["api","v1","users","get-users-list"],"host":["{{base_url}}"],"query":[{"key":"limit","value":"2"}],"variable":[]}},"response":[{"id":"ee611e46-363f-461e-903f-49b705dac903","name":"List all users","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/api/v1/users/get-users-list","host":["{{base_url}}"],"path":["api","v1","users","get-users-list"],"query":[{"key":"limit","value":"2","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1813"},{"key":"ETag","value":"W/\"715-BY/Vuu5/BW4mikRMmW7Ua3j3ezY\""},{"key":"Date","value":"Mon, 31 Mar 2025 18:04:51 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"data\": {\n \"users\": [\n {\n \"_id\": \"67e9a7834bf1744679a2d238\",\n \"firstName\": \"John Doe\",\n \"email\": \"john@mail.com\",\n \"lastName\": \"Dis\",\n \"location\": {\n \"city\": \"Dhaka\",\n \"country\": \"Bangladesh\",\n \"_id\": \"67e9a7834bf1744679a2d239\"\n },\n \"accessStatus\": true,\n \"twoStepAuthentication\": false,\n \"isDeleted\": null,\n \"isEmailVerified\": false,\n \"emailVerifyTokenExpiry\": null,\n \"forgotPasswordTokenExpiry\": null,\n \"role\": [\n {\n \"_id\": \"67e82bb5790c51c2b7cd2cf6\",\n \"role\": \"user\",\n \"permissions\": [\n \"application:create\",\n \"profile:view\"\n ],\n \"__v\": 0\n }\n ],\n \"educationRecords\": [],\n \"createdAt\": \"2025-03-30T20:20:19.538Z\",\n \"updatedAt\": \"2025-03-30T20:20:19.538Z\",\n \"__v\": 0\n },\n {\n \"_id\": \"67ead21b825cc08f7e704280\",\n \"firstName\": \"Than Win\",\n \"email\": \"win@mail.com\",\n \"lastName\": \"Hline\",\n \"location\": {\n \"city\": \"Dhaka\",\n \"country\": \"Bangladesh\",\n \"_id\": \"67ead21b825cc08f7e704281\"\n },\n \"accessStatus\": true,\n \"twoStepAuthentication\": false,\n \"isDeleted\": null,\n \"isEmailVerified\": false,\n \"emailVerifyTokenExpiry\": null,\n \"forgotPasswordTokenExpiry\": null,\n \"role\": [\n {\n \"_id\": \"67e82bb5790c51c2b7cd2cf5\",\n \"role\": \"admin\",\n \"permissions\": [\n \"user:delete\",\n \"profile:view\",\n \"job:delete\",\n \"job:create\",\n \"view:dashboard\",\n \"role:create\"\n ],\n \"__v\": 0\n }\n ],\n \"worksAt\": \"67e87694b3424acf88b26339\",\n \"educationRecords\": [],\n \"createdAt\": \"2025-03-31T17:34:19.927Z\",\n \"updatedAt\": \"2025-03-31T17:34:19.927Z\",\n \"__v\": 0,\n \"company\": {\n \"_id\": \"67e87694b3424acf88b26339\",\n \"name\": \"Meta\",\n \"description\": \"A leading software development company specializing in AI and cloud computing.\",\n \"location\": {\n \"city\": \"San Francisco\",\n \"country\": \"USA\",\n \"_id\": \"67e87694b3424acf88b2633a\"\n },\n \"role\": [\n \"660e4e9b3f8a2b001ccf9a1d\"\n ],\n \"employees\": [\n \"660e4ea23f8a2b001ccf9a1f\"\n ],\n \"adminID\": \"660e4ea23f8a2b001ccf9a22\",\n \"createdAt\": \"2025-03-29T22:39:16.114Z\",\n \"updatedAt\": \"2025-03-29T22:39:16.114Z\",\n \"__v\": 0\n }\n }\n ],\n \"pagination\": {\n \"totalPages\": 1,\n \"currentPage\": 1,\n \"totalItems\": 2\n }\n },\n \"message\": \"user list is fetched successfully\",\n \"success\": true\n}"}],"_postman_id":"c6e97f53-0856-4856-9ccd-ce77d32143d6"},{"name":"Add education entry by user Id","id":"dad6144c-7631-48bb-8bb5-ebf522af5c1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"school\": \"Ningbo University of Technology\",\r\n \"department\": \"Computer Science\",\r\n \"degree\": \"B.Sc\",\r\n \"startMonth\": \"June\",\r\n \"startYear\": \"2020\",\r\n \"currentlyStudying\": false,\r\n \"endMonth\": \"June\",\r\n \"endYear\": \"2024\"\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/users/67f35fe3a6243a202a30d87f/add-education","description":"This endpoint allows the user to add education details for their profile.
\ndata(object) : user object
This endpoint is used to update education record. This is protected route.
\nbody:
\n{\n \"message\": \"Education record has been updated successfully\"\n}\n\nThis endpoint allows user to delete education entry. This route is protected.
\nstatus: 200 OK
\nbody
\n{\n \"message\": \"education record has been deleted successfully\"\n}\n\nThis endpoint allows an admin to toggle the access status (enable/disable) of a specific user.
\nThis endpoint does not require a request body.
\nstatus: 200 OK
\nbody
\n{\n \"message\": \"User access status has been updated.\"\n}\n\nThis endpoint allows an admin to retrieve the statistics for the total number of users and jobs in the system.This is protected route.
\nstatus: 200 OK
\nbody:
\n{\n \"users\": 10,\n \"jobs\": 35\n}\n\nThis endpoint allows a user to add phone number. This is protected.
\nThis endpoint allows user to update profile photo.This protected route.
\n| Field | \r","Type | \r","
|---|---|
| msg | \r","string | \r","
required
\n","type":"text"},{"key":"location[city]","value":"new yoirk","description":"required
\n","type":"text"},{"key":"lastName","value":"Alex","description":"required
\n","type":"text"},{"key":"phoneNumber","value":"{{user_phone_number}}","description":"optional
\n","type":"text"},{"key":"avatar","description":"optional
\n","type":"file","src":"/D:/photos/low/pexels-asad-photo-maldives-1024960.jpg","disabled":true},{"key":"email","value":"ane.smith1@example.com","type":"text"},{"key":"location[country]","value":"usa","type":"text","uuid":"63e864ac-5d15-4392-8c2f-3d9459ff714a"}]},"url":"{{base_url}}/api/v1/users/{{user_id}}/update-basic-information","description":"This API endpoint is used to update user details using the HTTP PATCH method.
\nstatus: 200 OK
\n{\n \"msg\": \"updated User\"\n}\n\nThis endpoint retrieves the details of a specific user.
\nNo request body parameters are required for this request.
\nPath Parameters
\nuserId (string, required): The unique identifier of the user.{\n \"statusCode\": 0,\n \"data\": {\n \"_id\": \"\",\n \"firstName\": \"\",\n \"email\": \"\",\n \"lastName\": \"\",\n \"location\": {\n \"city\": \"\",\n \"country\": \"\",\n \"_id\": \"\"\n },\n \"accessStatus\": true,\n \"twoStepAuthentication\": true,\n \"phoneNumber\": \"\",\n \"isDeleted\": null,\n \"isEmailVerified\": true,\n \"emailVerifyTokenExpiry\": \"\",\n \"forgotPasswordTokenExpiry\": null,\n \"role\": [\n {\n \"_id\": \"\",\n \"role\": \"\",\n \"permissions\": [\"\"],\n \"__v\": 0\n }\n ],\n \"educationRecords\": [],\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"__v\": 0,\n \"emailVerifyToken\": \"\"\n },\n \"message\": \"\",\n \"success\": true\n}\n\nThis endpoint allows a user to apply for a job. This is protected route, meaning user must be logged in to access this route.
\nRequest Body
\nstatus: 200 OK
\nbody:
\n{\n \"statusCode\": 201,\n \"data\": {\n \"jobApplication\": {\n \"candidateId\": \"{{candiateId}}\",\n \"recruiterId\": \"{{recruiterId}}\",\n \"jobId\": \"{{jobID}}\",\n \"status\": \"pending\",\n \"interviewDate\": \"2024-12-10T14:00:00.000Z\",\n \"notes\": \"Candidate shows promising skills; recommend for interview stage.\",\n \"_id\": \"64f57fa8a1b82d431e1ef103\",\n \"createdAt\": \"2024-11-21T21:24:33.075Z\",\n \"updatedAt\": \"2024-11-21T21:24:33.075Z\",\n \"__v\": 0\n }\n },\n \"message\": \"Success\",\n \"success\": true\n}\n\nThis endpoint allows recruiter to update user's application status. This route is protected.
\nQuery Params
\napplicationId: string
\nstatus (string, required). Accepted options for status are: pending, interview, declined
status code: 200 OK
\nbody:
\n{\n \"statusCode\": 200,\n \"data\": {},\n \"message\": \"Application status is updated successfully\",\n \"success\": true\n}\n\nThis endpoint retrieves a paginated list of job applications apply by the user. It supports filtering by status, candidateId, or recruiterId and allows sorting by the latest or oldest entries.
statusCode (integer): HTTP status code of the response.
data (object): Contains the job applications and pagination information.
message (string): Success message.
success (boolean): Indicates whether the operation was successful.
_id (string): ID of the job application.
status (string): Current status of the job application.
statusHistory[] (array): List of historical status changes.
status (string): Status at a particular time.
updatedBy (string): ID of the user who updated the status.
updatedAt (ISODate): Timestamp of the status update.
_id (string): ID of the status history record.
createdAt (ISODate): When the application was created.
updatedAt (ISODate): When the application was last updated.
job (object): Detailed information about the job.
recruiter (object): User Object
totalPages (integer): Total number of pages available.
totalItems (integer): Total number of items across all pages.
currentPage (integer): Current page number.
This endpoint allows job owner to list all the job application.
\nThis endpoint allows a user to retrive a job application by id.
\nThis endpoint is used to delete a specific job application.
\nThe response for this request is a JSON object with the following properties:
\nstatusCode (number): The status code of the response.
data (object): An empty object.
message (string): A message related to the response.
success (boolean): Indicates if the request was successful.
This endpoint allows job post owner to update multiple applications status in bulk.
\nResponse body:
\n{\n \"statusCode\": 200,\n \"data\": {},\n \"message\": \"1 applications updated successfully\",\n \"success\": true\n}\n\nstatusCode: HTTP status code indicating the request was successful.
data: An empty object in this case (reserved for future use).
message: A message indicating the number of applications successfully updated.
This endpoint retrieves job statistics for the authenticated user, providing a count of jobs grouped by their status (e.g., interview, pending, declined).This route is protected, requiring the user to be authenticated. Include the authentication token in the Authorization header.
StartFragment
\n| ID | \r","User ID | \r","Type | \r","Company | \r","Position | \r","Status | \r","Date | \r","Created At | \r","Updated At | \r","
|---|---|---|---|---|---|---|---|---|
| {{_id}} | \r","{{userId}} | \r","{{type}} | \r","{{data.company}} | \r","{{data.position}} | \r","{{data.status}} | \r","{{data.date}} | \r","{{createdAt}} | \r","{{updatedAt}} | \r","
This endpoint retrieves a list of notifications.
\nMethod: GET
\nURL: {{base_url}}/api/v1/notifications
Query Parameters:
\npage (number, required): The page number for paginated results.
limit (number, required): The maximum number of items to be returned per page.
The response is a JSON object with the following schema:
\n{\n \"statusCode\": number,\n \"data\": {\n \"notifications\": [\n {\n \"_id\": string,\n \"userId\": string,\n \"type\": string,\n \"data\": {\n \"company\": string,\n \"position\": string,\n \"status\": string,\n \"date\": string\n },\n \"status\": string,\n \"createdAt\": string,\n \"updatedAt\": string,\n \"__v\": number\n }\n ],\n \"pagination\": {\n \"totalItems\": number,\n \"totalPages\": number,\n \"currentPage\": number\n }\n },\n \"message\": string,\n \"success\": boolean\n}\n\nThe API endpoint /api/v1/notifications/unread-count is a GET request that retrieves the unread notification count.
The response is a JSON object with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"statusCode\": {\n \"type\": \"number\"\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"unreadCount\": {\n \"type\": \"number\"\n }\n }\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"success\": {\n \"type\": \"boolean\"\n }\n }\n}\n\nThis endpont allows admin to remove role
\n","urlObject":{"path":["api","v1","roles"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e14e3025-f2c0-452c-8634-ad5ace93c022"},{"name":"add roles","id":"b29bc3a6-1fca-4655-9550-360137e37c94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"userId\": \"67e82c81790c51c2b7cd2d07\",\r\n \"roleId\": \"67e82bb5790c51c2b7cd2cf6\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/roles/add-role","description":"This endpoint allows admin to add role to a user
\n","urlObject":{"path":["api","v1","roles","add-role"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ce2bf3a5-1c2e-4a68-9468-693ae255316f","name":"Remove role Copy","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"userId\": \"67e82c81790c51c2b7cd2d07\",\r\n \"roleId\": \"67e82bb5790c51c2b7cd2cf6\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/roles/add-role"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"82"},{"key":"ETag","value":"W/\"52-gvyqgpezzFvNe4uGeHKhTRvrrls\""},{"key":"Date","value":"Sat, 29 Mar 2025 17:31:46 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"data\": {},\n \"message\": \"Role is added successfully\",\n \"success\": true\n}"}],"_postman_id":"b29bc3a6-1fca-4655-9550-360137e37c94"},{"name":"get roles","id":"9e623c09-8134-492b-91ad-18f01c82da23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/api/v1/roles","urlObject":{"path":["api","v1","roles"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9e623c09-8134-492b-91ad-18f01c82da23"}],"id":"3dd50c37-f717-4c2c-a995-c73f9cf0fb82","_postman_id":"3dd50c37-f717-4c2c-a995-c73f9cf0fb82","description":""},{"name":"company","item":[{"name":"create company","id":"b314676f-b181-48d0-ac3c-713fb134b852","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"{{name}}\",\r\n \"description\": \"{{description}}\",\r\n \"location\": {\r\n \"country\": \"{{country}}\",\r\n \"city\": \"{{city}}\"\r\n },\r\n \"adminID\": \"{{adminID}}\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/companies","urlObject":{"path":["api","v1","companies"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b314676f-b181-48d0-ac3c-713fb134b852"},{"name":"update compnay by id","id":"e3b37626-ae1a-4831-b0d3-7be1a6c13a2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Tech Innovators\",\r\n \"description\": \"A leading software development company specializing in AI and cloud computing.\",\r\n \"location\": {\r\n \"city\": \"San Francisco\",\r\n \"country\": \"USA\"\r\n },\r\n \"role\": [\r\n \"660e4e9b3f8a2b001ccf9a1d\"\r\n ],\r\n \"employees\": [\r\n \"660e4ea23f8a2b001ccf9a1f\"\r\n ],\r\n \"adminID\": \"660e4ea23f8a2b001ccf9a22\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/companies/67e86f30c048cbad32fd42f8","urlObject":{"path":["api","v1","companies","67e86f30c048cbad32fd42f8"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e3b37626-ae1a-4831-b0d3-7be1a6c13a2d"},{"name":"get company by id","id":"9d91ae76-8f33-47e4-93e4-4e5d9fcc9cac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Tech Innovators\",\r\n \"description\": \"A leading software development company specializing in AI and cloud computing.\",\r\n \"location\": {\r\n \"city\": \"San Francisco\",\r\n \"country\": \"USA\"\r\n },\r\n \"role\": [\r\n \"660e4e9b3f8a2b001ccf9a1d\"\r\n ],\r\n \"employees\": [\r\n \"660e4ea23f8a2b001ccf9a1f\"\r\n ],\r\n \"adminID\": \"660e4ea23f8a2b001ccf9a22\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/companies/67e87694b3424acf88b26339","urlObject":{"path":["api","v1","companies","67e87694b3424acf88b26339"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9d91ae76-8f33-47e4-93e4-4e5d9fcc9cac"},{"name":"delete company with id","id":"7ca030df-e728-4b47-a95a-fff010542ac6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Tech Innovators\",\r\n \"description\": \"A leading software development company specializing in AI and cloud computing.\",\r\n \"location\": {\r\n \"city\": \"San Francisco\",\r\n \"country\": \"USA\"\r\n },\r\n \"role\": [\r\n \"660e4e9b3f8a2b001ccf9a1d\"\r\n ],\r\n \"employees\": [\r\n \"660e4ea23f8a2b001ccf9a1f\"\r\n ],\r\n \"adminID\": \"660e4ea23f8a2b001ccf9a22\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/companies/67e86f30c048cbad32fd42f8","urlObject":{"path":["api","v1","companies","67e86f30c048cbad32fd42f8"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7ca030df-e728-4b47-a95a-fff010542ac6"},{"name":"get list of company","id":"ea39deb3-3f1d-414d-976b-59b9955950ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/api/v1/companies","urlObject":{"path":["api","v1","companies"],"host":["{{base_url}}"],"query":[{"disabled":true,"key":"limit","value":"1"},{"disabled":true,"key":"page","value":"2"}],"variable":[]}},"response":[],"_postman_id":"ea39deb3-3f1d-414d-976b-59b9955950ec"}],"id":"beac4af3-f606-4428-948a-01a6091426b8","_postman_id":"beac4af3-f606-4428-948a-01a6091426b8","description":""}],"event":[{"listen":"prerequest","script":{"id":"8b09e60c-0640-4a72-97bb-6dc716e4c931","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"35bdbc68-410e-48da-9396-181255e7aacf","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"value":"","type":"string","disabled":true}]}