{"info":{"_postman_id":"58399224-30b1-418a-8cb7-df2223198fb3","name":"planner","description":"

Planner API Documentation

\n
 1.0.0 \n\n
OAS 3.0\n\n

\n

Overview

\n

This API powers a planner application that allows users to create,
update, complete, and delete tasks with authentication.

\n

Servers

\n

https://planner-backend-i13a.onrender.com/

\n

Authentication

\n

This API uses JWT authentication.

\n

After logging in, include the token in the request header:

\n

Authorization: Bearer

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Planner API Documentation","slug":"planner-api-documentation"}],"owner":"48023599","collectionId":"58399224-30b1-418a-8cb7-df2223198fb3","publishedId":"2sBXVhEX36","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-01-16T15:18:15.000Z"},"item":[{"name":"plans","item":[{"name":"Get Plans","id":"bf7af8f4-6123-4472-aedc-0ed2df9a569e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{URL}}api/v1/plans?page=1&limit=5","description":"

Get All Plans

\n

Retrieve a paginated list of all available plans in the system.

\n
\n

Endpoint

\n
GET /api/v1/plans\n\n
\n

Description

\n

Returns all plans stored in the database. Supports pagination and sorting.

\n
\n

HTTP Method

\n

GET

\n
\n

Authentication

\n

Protected ✅

\n

Requires a valid access token.

\n

Include the authorization header:

\n
Authorization: Bearer <access_token>\n\n
\n

Request Headers

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderTypeRequiredDescription
Content-TypeStringYesapplication/json
AuthorizationStringYesBearer access token
\n
\n

Query Parameters (Optional)

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
pageNumberPage number for pagination
limitNumberNumber of plans per page
sortStringSort order: asc or desc
\n
\n

Example Request

\n
/api/v1/plans?page=1&limit=5  'returns 5 plans per page'\n/api/v1/plans?sort=plan 'sort plan by ascending order'\n/api/v1/plans?sort=-plan 'sort plan by descending order'\n\n
200 OK\n\n

Response Body

\n
{\n  \"status\": \"success\",\n  \"results\": 2,\n  \"data\": {\n    \"docs\": [\n      {\n          \"_id\": \"6965ee96a69a94bf1c08729d\",\n          \"plan\": \"ppppppppppppppppp\",\n          \"user\": \"6962225f15d8e9bcb9d0fc9d\",\n      },\n      {\n          \"_id\": \"6965ee96a69a94bf1c08729d\",\n          \"plan\": \"ppppppppppppppppp\",\n          \"user\": \"6962225f15d8e9bcb9d0fc9d\",\n      }\n    ]\n  }\n}\n\n
\n

Error Responses

\n

401 – Unauthorized

\n
{\n  \"status\": \"fail\",\n  \"message\": \"You are not logged in\"\n}\n\n

500 – Server Error

\n
{\n  \"status\": \"error\",\n  \"message\": \"Something went wrong\"\n}\n\n
\n","urlObject":{"path":["v1","plans"],"host":["{{URL}}api"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"5"}],"variable":[]}},"response":[],"_postman_id":"bf7af8f4-6123-4472-aedc-0ed2df9a569e"},{"name":"Create a new plan","id":"b90ebdc1-80ea-47e2-b9ad-bc94d96e9abc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"plan\": \"study\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}api/v1/plans","description":"

Create a Plan

\n

Add a new plan to the list of all available plans in the system.

\n
\n

Endpoint

\n
POST /api/v1/plans\n\n
\n

Description

\n

Creates a new plan and stores it in the database.

\n
\n

HTTP Method

\n

POST

\n
\n

Authentication

\n

Protected ✅

\n

Requires a valid access token.

\n

Include the authorization header:

\n
Authorization: Bearer <access_token>\n\n
\n

Request Headers

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderTypeRequiredDescription
Content-TypeStringYesapplication/json
AuthorizationStringYesBearer access token
\n
\n

Request Body

\n
{\n  \"plan\": \"Basic\",\n}\n\n
\n

Successful Response

\n

Status Code

\n
201 Created\n\n

Response Body

\n
{\n  \"status\": \"success\",\n  \"data\": {\n    \"plan\": {\n      \"_id\": \"65af88b84342a592ac5e62a\",\n      \"plan\": \"Basic\",\n      \"createdAt\": \"2026-01-01T10:30:00.000Z\",\n       \"user\": \"696b959b3062f17504b5908a\",\n    }\n  }\n}\n\n
\n

Error Responses

\n

401 – Unauthorized

\n
{\n  \"status\": \"fail\",\n  \"message\": \"You are not logged in\"\n}\n\n
\n

400 – Bad Request (Validation Error)

\n
{\n  \"status\": \"fail\",\n  \"message\": \"Plan is required\"\n}\n\n
\n

500 – Server Error

\n
{\n  \"status\": \"error\",\n  \"message\": \"Something went wrong\"\n}\n\n
\n","urlObject":{"path":["v1","plans"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"b90ebdc1-80ea-47e2-b9ad-bc94d96e9abc"},{"name":"Get plan","id":"35370453-0494-4237-8aa8-bca170ff590e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{URL}}api/v1/plans/695c4446b62913b6cec56ec3","description":"

Get a Plan

\n

Retrieve a single plan by its unique ID.

\n
\n

Endpoint

\n
GET /api/v1/plans/:id\n\n
\n

Description

\n

Returns a single plan stored in the database that matches the provided ID.

\n
\n

HTTP Method

\n

GET

\n
\n

Authentication

\n

Protected ✅

\n

Requires a valid access token.

\n

Include the authorization header:

\n
Authorization: Bearer <access_token>\n\n
\n

Request Headers

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderTypeRequiredDescription
Content-TypeStringYesapplication/json
AuthorizationStringYesBearer access token
\n
\n

Path Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeRequiredDescription
idStringYesUnique ID of the plan
\n
\n

Successful Response

\n

Status Code

\n
200 OK\n\n

Response Body

\n
{\n  \"status\": \"success\",\n  \"data\": {\n    \"plan\": {\n      \"_id\": \"65af88c94342a592ac5e62b\",\n      \"plan\": \"Pro\",\n      \"createdAt\": \"2026-01-01T10:32:00.000Z\"\n    }\n  }\n}\n\n
\n
\n

ℹ️ results is intentionally omitted since this endpoint returns a single resource.

\n
\n

Error Responses

\n

401 – Unauthorized

\n
{\n  \"status\": \"fail\",\n  \"message\": \"You are not logged in\"\n}\n\n

404 – Not Found

\n
{\n  \"status\": \"fail\",\n  \"message\": \"No plan found with that ID\"\n}\n\n

500 – Server Error

\n
{\n  \"status\": \"error\",\n  \"message\": \"Something went wrong\"\n}\n\n
","urlObject":{"path":["v1","plans","695c4446b62913b6cec56ec3"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"35370453-0494-4237-8aa8-bca170ff590e"},{"name":"Update plan","id":"c40da61c-c901-477a-a49f-d51fca49cdd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"completed\":true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}api/v1/plans/694ecdb817c152d66efe141f","description":"

Update a Plan

\n

Update an existing plan in the system.

\n
\n

Endpoint

\n
PATCH /api/v1/plans/:id\n\n
\n

Description

\n

Updates one or more fields of a plan stored in the database.

\n
\n

HTTP Method

\n

PATCH

\n
\n

Authentication

\n

Protected ✅

\n

Requires a valid access token.

\n

Include the authorization header:

\n
Authorization: Bearer <access_token>\n\n
\n

Request Headers

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderTypeRequiredDescription
Content-TypeStringYesapplication/json
AuthorizationStringYesBearer access token
\n
\n

Path Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeRequiredDescription
idStringYesUnique ID of the plan
\n
\n

Request Body (Partial Update)

\n
{\n  \"plan\": \"Basic\"\n}\n\n
\n

<p >Only the fields provided will be updated.</p>

\n
\n
\n

Successful Response

\n

Status Code

\n
200 OK\n\n

Response Body

\n
{\n  \"status\": \"success\",\n  \"data\": {\n    \"plan\": {\n      \"_id\": \"65af88b84342a592ac5e62a\",\n      \"plan\": \"Basic\",\n      \"updatedAt\": \"2026-01-05T14:20:00.000Z\"\n    }\n  }\n}\n\n
\n

Error Responses

\n

401 – Unauthorized

\n
{\n  \"status\": \"fail\",\n  \"message\": \"You are not logged in\"\n}\n\n

400 – Bad Request

\n
{\n  \"status\": \"fail\",\n  \"message\": \"Invalid update data\"\n}\n\n

404 – Not Found

\n
{\n  \"status\": \"fail\",\n  \"message\": \"No plan found with that ID\"\n}\n\n

500 – Server Error

\n
{\n  \"status\": \"error\",\n  \"message\": \"Something went wrong\"\n}\n\n
","urlObject":{"path":["v1","plans","694ecdb817c152d66efe141f"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"c40da61c-c901-477a-a49f-d51fca49cdd7"},{"name":"Delete","id":"fb25993c-81bc-46a1-a2fc-cdbf83ce402f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"{{URL}}api/v1/plans/694fc0e8cfdd00c905cd3389","description":"

Delete a Plan

\n

Delete a plan in the system.

\n
\n

Endpoint

\n
DELETE /api/v1/plans/:id\n\n
\n

Description

\n

This endpoint updates a plan stored in the database.

\n
\n

HTTP Method

\n

DELETE

\n
\n

Authentication

\n\n

Include the authorization header:

\n
Authorization: Bearer <access_token>\n\n
\n

Request Headers

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderTypeRequiredDescription
Content-TypeStringYesapplication/json
AuthorizationStringOptionalBearer token (if protected)
\n
\n

Successful Response

\n

Status Code

\n
200 OK\n\n

Response Body

\n
{\n  \"status\": \"success\",\n  \"data\":null\n}\n\n
\n

Error Responses

\n

500 – Server Error

\n
{\n  \"status\": \"error\",\n  \"message\": \"Something went wrong\"\n}\n\n

401 – Unauthorized (if protected)

\n
{\n  \"status\": \"fail\",\n  \"message\": \"You are not logged in\"\n}\n\n
","urlObject":{"path":["v1","plans","694fc0e8cfdd00c905cd3389"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"fb25993c-81bc-46a1-a2fc-cdbf83ce402f"}],"id":"8df5831f-9efa-4d56-a5b5-ea46bc79216b","description":"

Plans

\n

This folder includes all api endpoint to access and manipulate all plans data.

\n","_postman_id":"8df5831f-9efa-4d56-a5b5-ea46bc79216b"},{"name":"users","item":[{"name":"Get all users","id":"0e1adb1a-394c-4446-a3f8-9f9da6bbce98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"fullName\":\"Arikpo Blessing\",\r\n \"userName\":\"arikpo\",\r\n \"email\":\"arikpo@gmail.com\",\r\n \"password\":\"123456789\",\r\n \"confirmPassword\":\"123456789\"\r\n}"},"url":"{{URL}}api/v1/users","description":"

Get All Users

\n

Retrieve a paginated list of all users in the system.

\n
\n

Endpoint

\n

GET /api/v1/users

\n
\n

Description

\n

Returns all users stored in the database.

\n

Supports pagination and sorting.

\n
\n

Authentication

\n

🔒 Protected

\n

Requires a valid access token.

\n

Include the authorization header:

\n
Authorization: Bearer <access_token>\n\n
\n

Request Headers

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderTypeRequiredDescription
Content-TypeStringYesapplication/json
AuthorizationStringYesBearer access token
\n
\n

Query Parameters (Optional)

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
pageNumberPage number for pagination
limitNumberNumber of users per page
sortStringSort order (field or -field)
\n
\n

Example Requests

\n
/api/v1/users?page=1&limit=5\n\n

Returns 5 users per page.

\n
/api/v1/users?sort=name\n\n

Sorts users in ascending order by name.

\n
/api/v1/users?sort=-createdAt\n\n

Sorts users in descending order by creation date.

\n
\n

Success Response

\n

200 OK

\n
{\n  \"status\": \"success\",\n  \"results\": 2,\n  \"data\": {\n    \"docs\": [\n      {\n        \"_id\": \"6965ee96a69a94bf1c08729d\",\n        \"name\": \"Jane Doe\",\n        \"email\": \"jane@example.com\",\n        \"role\": \"user\",\n        \"createdAt\": \"2026-01-15T10:12:00.000Z\"\n      },\n      {\n        \"_id\": \"6965ee96a69a94bf1c08729d\",\n        \"name\": \"John Doe\",\n        \"email\": \"john@example.com\",\n        \"role\": \"admin\",\n        \"createdAt\": \"2026-01-10T08:45:00.000Z\"\n      }\n    ]\n  }\n}\n\n
\n

Error Responses

\n

401 – Unauthorized

\n
{\n  \"status\": \"fail\",\n  \"message\": \"You are not logged in\"\n}\n\n

500 – Server Error

\n
{\n  \"status\": \"error\",\n  \"message\": \"Something went wrong\"\n}\n\n
","urlObject":{"path":["v1","users"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"0e1adb1a-394c-4446-a3f8-9f9da6bbce98"},{"name":"update me","id":"782c3629-dbe3-4e4a-afba-00222a5a6f26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"formdata","formdata":[{"key":"fullName","value":"ejojo","type":"text","uuid":"ed9dbde0-68d3-4e89-a66b-dcda3a64966b"}]},"url":"{{URL}}api/v1/users/updateMe","description":"

Update a User

\n

Update an existing user in the system.

\n
\n

Endpoint

\n
PATCH /api/v1/users/updateMe\n\n
\n

Description

\n

Updates one or more fields of a user stored in the database.

\n
\n

HTTP Method

\n

PATCH

\n
\n

Authentication

\n

Protected ✅

\n

Requires a valid access token.

\n

Include the authorization header:

\n
Authorization: Bearer <access_token>\n\n
\n

Request Headers

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderTypeRequiredDescription
Content-TypeStringYesapplication/json
AuthorizationStringYesBearer access token
\n
\n
\n

Request Body (Partial Update)

\n
{\n  \"email\": \"ejojo@gmail.com\"\n}\n\n
\n

<p >Only the fields provided will be updated.</p>

\n
\n
\n

Successful Response

\n

Status Code

\n
200 OK\n\n

Response Body

\n
{\n  \"status\": \"success\",\n  \"data\": {\n    \"user\": {\n      \n\"_id\"\n:\"696b959b3062f17504b5908a\"\n      \"fullName\"\n:\"test\"\n      \"email\":\"test@gmail.com\"\n      \"photo\"\n:\"default.jpg\"\n    }\n  }\n}\n\n
\n

Error Responses

\n

401 – Unauthorized

\n
{\n  \"status\": \"fail\",\n  \"message\": \"You are not logged in\"\n}\n\n

400 – Bad Request

\n
{\n  \"status\": \"fail\",\n  \"message\": \"Invalid update data\"\n}\n\n

404 – Not Found

\n
{\n  \"status\": \"fail\",\n  \"message\": \"No plan found with that ID\"\n}\n\n

500 – Server Error

\n
{\n  \"status\": \"error\",\n  \"message\": \"Something went wrong\"\n}\n\n
","urlObject":{"path":["v1","users","updateMe"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"782c3629-dbe3-4e4a-afba-00222a5a6f26"},{"name":"delete current user","id":"187cceab-d1c9-4776-a897-539f1e996329","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{URL}}api/v1/users/deleteMe","description":"

Delete a User

\n

Delete a user in the system.

\n
\n

Endpoint

\n
DELETE /api/v1/users/:id\n\n
\n

Description

\n

This endpoint updates a plan stored in the database.

\n
\n

HTTP Method

\n

DELETE

\n
\n

Authentication

\n\n

Include the authorization header:

\n
Authorization: Bearer <access_token>\n\n
\n

Request Headers

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderTypeRequiredDescription
Content-TypeStringYesapplication/json
AuthorizationStringOptionalBearer token (if protected)
\n
\n

Successful Response

\n

Status Code

\n
200 OK\n\n

Response Body

\n
{\n  \"status\": \"success\",\n  \"data\":null\n}\n\n
\n

Error Responses

\n

500 – Server Error

\n
{\n  \"status\": \"error\",\n  \"message\": \"Something went wrong\"\n}\n\n

401 – Unauthorized (if protected)

\n
{\n  \"status\": \"fail\",\n  \"message\": \"You are not logged in\"\n}\n\n
","urlObject":{"path":["v1","users","deleteMe"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"187cceab-d1c9-4776-a897-539f1e996329"},{"name":"Get Current User","id":"2cae856c-5cda-48a6-b000-3846b0aea66c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{URL}}api/v1/users/me","description":"

Get a User

\n

Retrieve a single user by an user id storedin the rquest object.

\n
\n

Endpoint

\n
GET /api/v1/users/me\n\n
\n

Description

\n

This endpoint returns a user stored in the database.

\n
\n

HTTP Method

\n

GET

\n
\n

Authentication

\n\n

Include the authorization header:

\n
Authorization: Bearer <access_token>\n\n
\n

Request Headers

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderTypeRequiredDescription
Content-TypeStringYesapplication/json
AuthorizationStringOptionalBearer token (if protected)
\n
\n

Successful Response

\n

Status Code

\n
200 OK\n\n

Response Body

\n
{\n  \"status\": \"success\",\n  \"results\": 3,\n  \"data\": {\n    \"user\": \n      {\n     \"fullName\":\"Essien Jojo\"\n     \"email\":\"ejojo@gmail.com\"\n     \"photo\":\"user-695aad0f7d95f1a0870e2ec3-1767862410756.jpeg\"\n     \"active\":true\n }\n  }\n}\n\n
\n

Error Responses

\n

500 – Server Error

\n
{\n  \"status\": \"error\",\n  \"message\": \"Something went wrong\"\n}\n\n

401 – Unauthorized (if protected)

\n
{\n  \"status\": \"fail\",\n  \"message\": \"You are not logged in\"\n}\n\n
","urlObject":{"path":["v1","users","me"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"2cae856c-5cda-48a6-b000-3846b0aea66c"}],"id":"8f42ddfe-a63d-46f7-947a-2f7e26a9ce94","description":"

Users

\n

This folder includes allapi end point to manage and manipulate users data.

\n","_postman_id":"8f42ddfe-a63d-46f7-947a-2f7e26a9ce94"},{"name":"authentication","item":[{"name":"sign up","event":[{"listen":"test","script":{"id":"eacf0990-e4b2-434f-8753-d8792ff41505","exec":["pm.environment.set(\"jwt\", pm.response.json().token);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"f3d44621-e703-4b7b-86b1-18c94c2a4ac8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"fullName\":\"test1\",\r\n \"email\":\"test1@gmail.com\",\r\n \"password\":\"123456789\",\r\n \"confirmPassword\":\"123456789\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}api/v1/users/signUp","description":"

Create a User (Sign Up)

\n

Create a new user and store their details in the system.

\n
\n

Endpoint

\n

POST /api/v1/users/signup

\n
\n
\n

POST is used to create new resources.
signup endpoints are typically public, not protected.

\n
\n

Description

\n

Creates a new user account and saves the user’s information in the database.

\n
\n

Authentication

\n

🔓 Public

\n

No authentication required.

\n
\n
\n

If you intend this to be admin-only user creation, tell me and I’ll document it correctly.

\n
\n

Request Headers

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderTypeRequiredDescription
Content-TypeStringYesapplication/json
\n
\n

Request Body (Example)

\n
{\n  \"fullName\": \"Essien Jojo\",\n  \"email\": \"ejojo@gmail.com\",\n  \"password\": \"********\",\n  \"passwordConfirm\": \"********\"\n}\n\n
\n
\n

Password fields are required during sign-up but never returned in responses.

\n
\n

Success Response

\n

201 Created

\n
{\n  \"status\": \"success\",\n  \"data\": {\n    \"user\": {\n      \"fullName\": \"Essien Jojo\",\n      \"email\": \"ejojo@gmail.com\",\n      \"photo\": \"user-695aad0f7d95f1a0870e2ec3-1767862410756.jpeg\",\n      \"active\": true\n    }\n  }\n}\n\n
\n

Error Responses

\n

400 – Bad Request

\n
{\n  \"status\": \"fail\",\n  \"message\": \"Invalid input data\"\n}\n\n

500 – Server Error

\n
{\n  \"status\": \"error\",\n  \"message\": \"Something went wrong\"\n}\n\n
\n","urlObject":{"path":["v1","users","signUp"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"f3d44621-e703-4b7b-86b1-18c94c2a4ac8"},{"name":"login","event":[{"listen":"test","script":{"id":"2986ea19-0054-448b-8344-bf987b72c6c1","exec":["pm.environment.set(\"jwt\", pm.response.json().token);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"13a76b1b-b1d9-4097-aaf7-e2e175676e02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\":\"ejojo@gmail.com\",\r\n \"password\":\"12345678\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}api/v1/users/login","description":"

Authenticate a User (Login)

\n

Authenticate a user and grant access to the system.

\n
\n

Endpoint

\n

POST /api/v1/users/login

\n
\n

Description

\n

Authenticates a user using their credentials and returns an access token along with user details.

\n
\n

HTTP Method

\n

POST

\n
\n

<p >Login actions create a new authentication session/token.</p>

\n
\n
\n

Authentication

\n

🔓 Public

\n

No authentication required.

\n
\n

<p >You cannot require a token to obtain a token.</p>

\n
\n
\n

Request Headers

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderTypeRequiredDescription
Content-TypeStringYesapplication/json
\n
\n

Request Body (Example)

\n
{\n  \"email\": \"ejojo@gmail.com\",\n  \"password\": \"********\"\n}\n\n
\n

Success Response

\n

200 OK

\n
{\n  \"status\": \"success\",\n  \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n  \"data\": {\n    \"user\": {\n      \"fullName\": \"Essien Jojo\",\n      \"email\": \"ejojo@gmail.com\",\n      \"photo\": \"user-695aad0f7d95f1a0870e2ec3-1767862410756.jpeg\",\n      \"active\": true\n    }\n  }\n}\n\n
\n

Error Responses

\n

400 – Bad Request (Invalid Credentials)

\n
{\n  \"status\": \"fail\",\n  \"message\": \"Incorrect email or password\"\n}\n\n

500 – Server Error

\n
{\n  \"status\": \"error\",\n  \"message\": \"Something went wrong\"\n}\n\n
","urlObject":{"path":["v1","users","login"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"13a76b1b-b1d9-4097-aaf7-e2e175676e02"},{"name":"forgot password","id":"e869023d-8999-41e3-828a-afd69ff7c566","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\":\"test3@gmail.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}api/v1/users/forgotPassword","description":"

Forgot Password

\n

Initiate the password reset process for a user account.

\n
\n

Endpoint

\n

POST /api/v1/users/forgotPassword

\n
\n

Description

\n

Generates a password reset token and sends a password reset link to the user’s registered email address.

\n
\n

HTTP Method

\n

POST

\n
\n

<p >Used to initiate a password recovery flow.</p>

\n
\n
\n

Authentication

\n

🔓 Public

\n

No authentication required.

\n
\n

Request Headers

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderTypeRequiredDescription
Content-TypeStringYesapplication/json
\n
\n

Request Body (Example)

\n
{\n  \"email\": \"ejojo@gmail.com\"\n}\n\n
\n

Success Response

\n

200 OK

\n
{\n  \"status\": \"success\",\n  \"message\": \"Password reset token sent to email\"\n}\n\n
\n

<p >For security reasons, the response should be the same whether the email exists or not.</p>

\n
\n
\n

Error Responses

\n

400 – Bad Request

\n
{\n  \"status\": \"fail\",\n  \"message\": \"Please provide an email address\"\n}\n\n

500 – Server Error

\n
{\n  \"status\": \"error\",\n  \"message\": \"Something went wrong\"\n}\n\n
","urlObject":{"path":["v1","users","forgotPassword"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"e869023d-8999-41e3-828a-afd69ff7c566"},{"name":"reset password","event":[{"listen":"test","script":{"id":"bf189d5b-b3f6-40e1-a9f1-13dad3ce0ab8","exec":["pm.environment.set(\"jwt\", pm.response.json().token);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"c68ded72-efcd-4cef-9fcb-b56e13be1f86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"password\":\"newPass123\",\r\n \"confirmPassword\":\"newPass123\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}api/v1/users/resetPassword/c7cec0edbd6131c5ddaecee61d2a951b9cba1449fd768162be6dbb80491dbbe1","description":"

Reset Password

\n

Reset a user’s password using a valid password reset token.

\n
\n

Endpoint

\n

PATCH
/api/v1/users/resetPassword/:token

\n

Example

\n
/api/v1/users/resetPassword/37d95304cff1cbbf87409d655aac84082c6185d95be6b11db84f62d08edfda75\n\n
\n

Description

\n

Validates the password reset token and updates the user’s password.

\n

Once successful, the reset token is invalidated.

\n
\n

HTTP Method

\n

PATCH

\n
\n

<p >Used to partially update a user resource (password only).</p>

\n
\n
\n

Authentication

\n

🔓 Public

\n

No authentication required.

\n
\n

<p >Access is granted through the reset token itself.</p>

\n
\n
\n

Request Headers

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderTypeRequiredDescription
Content-TypeStringYesapplication/json
\n
\n

Request Body (Example)

\n
{\n  \"currentPassword\":\"current\",\n  \"password\": \"NewSecurePassword123!\",\n  \"confirmPassword\": \"NewSecurePassword123!\"\n}\n\n
\n

Success Response

\n

200 OK

\n
{\n  \"status\": \"success\",\n  \"message\": \"Password reset successful\"\n}\n\n
\n

<p >You may optionally return a new JWT token after reset.</p>

\n
\n
\n

Error Responses

\n

400 – Invalid or Expired Token

\n
{\n  \"status\": \"fail\",\n  \"message\": \"Token is invalid or has expired\"\n}\n\n

400 – Validation Error

\n
{\n  \"status\": \"fail\",\n  \"message\": \"Passwords do not match\"\n}\n\n

500 – Server Error

\n
{\n  \"status\": \"error\",\n  \"message\": \"Something went wrong\"\n}\n\n
","urlObject":{"path":["v1","users","resetPassword","c7cec0edbd6131c5ddaecee61d2a951b9cba1449fd768162be6dbb80491dbbe1"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"c68ded72-efcd-4cef-9fcb-b56e13be1f86"},{"name":"update my password","event":[{"listen":"test","script":{"id":"f20f9c00-d2d0-4809-8f93-2334dddfbdad","exec":["pm.environment.set(\"jwt\", pm.response.json().token);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"699a2464-b6e8-48fe-8c86-45eb5c9a3531","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"passwordCurrent\":\"123456789\",\r\n \"password\":\"update12345\",\r\n \"confirmPassword\":\"update12345\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}api/v1/users/updateMyPassword","description":"

Update My Password

\n

Update the password of the currently authenticated user.

\n
\n

Endpoint

\n

PATCH
/api/v1/users/updateMyPassword

\n
\n

Description

\n

Allows a logged-in user to change their password by providing their current password and a new password.

\n

All existing authentication tokens are invalidated after a successful update.

\n
\n

HTTP Method

\n

PATCH

\n
\n

Authentication

\n

🔒 Protected

\n

Requires a valid access token.

\n

Authorization Header

\n
Authorization: Bearer <access_token>\n\n
\n

Request Headers

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderTypeRequiredDescription
Content-TypeStringYesapplication/json
AuthorizationStringYesBearer access token
\n
\n

Request Body (Example)

\n
{\n  \"currentPassword\": \"OldPassword123!\",\n  \"password\": \"NewSecurePassword123!\",\n  \"passwordConfirm\": \"NewSecurePassword123!\"\n}\n\n
\n

Success Response

\n

200 OK

\n
{\n  \"status\": \"success\",\n  \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n  \"message\": \"Password updated successfully\"\n}\n\n
","urlObject":{"path":["v1","users","updateMyPassword"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"699a2464-b6e8-48fe-8c86-45eb5c9a3531"}],"id":"39936f40-4e6c-4b4b-a832-d6a30e274c89","_postman_id":"39936f40-4e6c-4b4b-a832-d6a30e274c89","description":""},{"name":"tasks","item":[{"name":"create task","id":"f64900fe-3579-4c4a-92ff-441744c98f6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"task\":\"Study Plants\",\r\n \"dueDate\":\"05-1-2026\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}api/v1/tasks","description":"

Create a Task

\n

Create a new task in the system.

\n
\n

Endpoint

\n

POST
/api/v1/tasks

\n
\n

Description

\n

Creates a new task and stores it in the database.

\n

The task is automatically associated with the authenticated user.

\n
\n

HTTP Method

\n

POST

\n
\n

<p >Used to create a new resource.</p>

\n
\n
\n

Authentication

\n

🔒 Protected

\n

Requires a valid access token.

\n

Authorization Header

\n
Authorization: Bearer <access_token>\n\n
\n

Request Headers

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderTypeRequiredDescription
Content-TypeStringYesapplication/json
AuthorizationStringYesBearer access token
\n
\n

Request Body (Example)

\n
{\n  \"task\": \"Finish API documentation\",\n  \"dueDate\": \"2026-01-20\",\n  \"priority\": \"high\"\n}\n\n
\n

<p >Optional fields can be omitted depending on your schema.</p>

\n
\n
\n

Success Response

\n

201 Created

\n
{\n  \"status\": \"success\",\n  \"data\": {\n    \"task\": {\n      \"_id\": \"6970aa96a69a94bf1c08745e\",\n      \"title\": \"Finish API documentation\",\n      \"description\": \"Complete users and tasks API docs\",\n      \"dueDate\": \"2026-01-20T00:00:00.000Z\",\n      \"priority\": \"high\",\n      \"completed\": false,\n      \"user\": \"6962225f15d8e9bcb9d0fc9d\",\n      \"createdAt\": \"2026-01-18T22:10:00.000Z\"\n    }\n  }\n}\n\n
\n

Error Responses

\n

400 – Bad Request

\n
{\n  \"status\": \"fail\",\n  \"message\": \"Invalid input data\"\n}\n\n

401 – Unauthorized

\n
{\n  \"status\": \"fail\",\n  \"message\": \"You are not logged in\"\n}\n\n

500 – Server Error

\n
{\n  \"status\": \"error\",\n  \"message\": \"Something went wrong\"\n}\n\n
","urlObject":{"path":["v1","tasks"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"f64900fe-3579-4c4a-92ff-441744c98f6b"},{"name":"Get all task","id":"4d74eba1-4885-42c5-b06e-db3a44b0d3cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{URL}}api/v1/tasks?completed=true","description":"

Get All Tasks

\n

Retrieve a paginated list of all tasks in the system.

\n
\n

Endpoint

\n

GET
/api/v1/tasks

\n
\n

Description

\n

Returns all tasks stored in the database.

\n

Supports pagination, sorting, and filtering.

\n

Access can be restricted to admin-only or scoped to the authenticated user, depending on your implementation.

\n
\n

HTTP Method

\n

GET

\n
\n

Authentication

\n

🔒 Protected

\n

Requires a valid access token.

\n

Authorization Header

\n
Authorization: Bearer <access_token>\n\n
\n

Request Headers

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderTypeRequiredDescription
AuthorizationStringYesBearer access token
\n
\n

Query Parameters (Optional)

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
pageNumberPage number for pagination
limitNumberNumber of tasks per page
sortStringSort order (field or -field)
completedBooleanFilter by completion status
priorityStringFilter by priority (low, medium, high)
\n
\n

Example Requests

\n
/api/v1/tasks?page=1&limit=10\n\n
/api/v1/tasks?sort=-createdAt\n\n
/api/v1/tasks?completed=false&priority=high\n\n
\n

Success Response

\n

200 OK

\n
{\n  \"status\": \"success\",\n  \"results\": 2,\n  \"data\": {\n    \"docs\": [\n      {\n        \"_id\": \"6970aa96a69a94bf1c08745e\",\n        \"task\": \"Finish API documentation\",\n        \"priority\": \"high\",\n        \"completed\": false,\n        \"user\": \"6962225f15d8e9bcb9d0fc9d\",\n        \"createdAt\": \"2026-01-18T22:10:00.000Z\"\n      },\n      {\n        \"_id\": \"6970aa96a69a94bf1c08745f\",\n        \"task\": \"Deploy backend\",\n        \"priority\": \"medium\",\n        \"completed\": true,\n        \"user\": \"6962225f15d8e9bcb9d0fc9d\",\n        \"createdAt\": \"2026-01-17T18:30:00.000Z\"\n      }\n    ]\n  }\n}\n\n
\n

Error Responses

\n

401 – Unauthorized

\n
{\n  \"status\": \"fail\",\n  \"message\": \"You are not logged in\"\n}\n\n

500 – Server Error

\n
{\n  \"status\": \"error\",\n  \"message\": \"Something went wrong\"\n}\n\n
","urlObject":{"path":["v1","tasks"],"host":["{{URL}}api"],"query":[{"key":"completed","value":"true"}],"variable":[]}},"response":[],"_postman_id":"4d74eba1-4885-42c5-b06e-db3a44b0d3cc"},{"name":"delete task","id":"d7fa1656-615f-4474-bac9-a4ab53f69f36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"{{URL}}api/v1/tasks/6958b452d8449de00088a188","description":"

Delete a Task

\n

Delete an existing task from the system.

\n
\n

Endpoint

\n

DELETE
/api/v1/tasks/:id

\n
\n

Description

\n

Deletes a task identified by its ID.

\n

Only the task owner (or an admin) is allowed to delete the task.

\n
\n

HTTP Method

\n

DELETE

\n
\n

Authentication

\n

🔒 Protected

\n

Requires a valid access token.

\n

Authorization Header

\n
Authorization: Bearer <access_token>\n\n
\n

Request Headers

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderTypeRequiredDescription
AuthorizationStringYesBearer access token
\n
\n

URL Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
idStringID of the task
\n
\n

Example Request

\n
DELETE /api/v1/tasks/6970aa96a69a94bf1c08745e\n\n
\n

Success Response

\n

204 No Content

\n
{\n  \"status\": \"success\",\n  \"data\": null\n}\n\n
\n

<p >No response body is required for a successful delete.</p>

\n
\n
\n

Error Responses

\n

401 – Unauthorized

\n
{\n  \"status\": \"fail\",\n  \"message\": \"You are not logged in\"\n}\n\n

403 – Forbidden

\n
{\n  \"status\": \"fail\",\n  \"message\": \"You do not have permission to delete this task\"\n}\n\n

404 – Not Found

\n
{\n  \"status\": \"fail\",\n  \"message\": \"No task found with that ID\"\n}\n\n

500 – Server Error

\n
{\n  \"status\": \"error\",\n  \"message\": \"Something went wrong\"\n}\n\n
","urlObject":{"path":["v1","tasks","6958b452d8449de00088a188"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"d7fa1656-615f-4474-bac9-a4ab53f69f36"}],"id":"14b4b889-26e7-46f8-9e51-430ac638c50c","_postman_id":"14b4b889-26e7-46f8-9e51-430ac638c50c","description":""},{"name":"Plans/Tasks","item":[{"name":"Get all task plan url","id":"3462b79a-fc33-46ec-b0ca-4d16a6a88458","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{URL}}api/v1/plans/6958b410d8449de00088a185/tasks","description":"

StartFragment

\n

Get Tasks for a Specific Plan

\n

Retrieve all tasks associated with a particular plan.

\n
\n

Endpoint

\n

GET
/api/v1/plans/:planId/tasks

\n

Example

\n
/api/v1/plans/6963c079a4b3e84b1d29e60c/tasks\n\n
\n

Description

\n

Returns all tasks that belong to the specified plan ID.

\n

Supports pagination, sorting, and filtering.

\n
\n

HTTP Method

\n

GET

\n
\n

Authentication

\n

🔒 Protected

\n

Requires a valid access token.

\n

Authorization Header

\n
Authorization: Bearer <access_token>\n\n
\n

Request Headers

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderTypeRequiredDescription
AuthorizationStringYesBearer access token
\n
\n

URL Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
planIdStringID of the plan
\n
\n

Query Parameters (Optional)

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
pageNumberPage number for pagination
limitNumberNumber of tasks per page
sortStringSort order (field or -field)
completedBooleanFilter by completion status
priorityStringFilter by priority (low, medium, high)
\n
\n

Example Requests

\n
/api/v1/plans/6963c079a4b3e84b1d29e60c/tasks?page=1&limit=5\n\n
/api/v1/plans/6963c079a4b3e84b1d29e60c/tasks?completed=false\n\n
\n

Success Response

\n

200 OK

\n
{\n  \"status\": \"success\",\n  \"results\": 2,\n  \"data\": {\n    \"docs\": [\n      {\n        \"_id\": \"6970aa96a69a94bf1c08745e\",\n        \"task\": \"Design UI\",\n        \"description\": \"Create dashboard UI\",\n        \"priority\": \"high\",\n        \"completed\": false,\n        \"plan\": \"6963c079a4b3e84b1d29e60c\",\n        \"user\": \"6962225f15d8e9bcb9d0fc9d\",\n        \"createdAt\": \"2026-01-18T22:10:00.000Z\"\n      },\n      {\n        \"_id\": \"6970aa96a69a94bf1c08745f\",\n        \"task\": \"Build API\",\n        \"priority\": \"medium\",\n        \"completed\": true,\n        \"plan\": \"6963c079a4b3e84b1d29e60c\",\n        \"user\": \"6962225f15d8e9bcb9d0fc9d\",\n        \"createdAt\": \"2026-01-17T18:30:00.000Z\"\n      }\n    ]\n  }\n}\n\n
\n

Error Responses

\n

401 – Unauthorized

\n
{\n  \"status\": \"fail\",\n  \"message\": \"You are not logged in\"\n}\n\n

404 – Plan Not Found

\n
{\n  \"status\": \"fail\",\n  \"message\": \"No plan found with that ID\"\n}\n\n

500 – Server Error

\n
{\n  \"status\": \"error\",\n  \"message\": \"Something went wrong\"\n}\n\n
","urlObject":{"path":["v1","plans","6958b410d8449de00088a185","tasks"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"3462b79a-fc33-46ec-b0ca-4d16a6a88458"},{"name":"create task plan url","id":"ed82c1cf-05fc-46fb-aab7-0791229f0d68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"task\":\"Study Techh\",\r\n \"dueDate\":\"05-1-2026\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}api/v1/plans/6958b410d8449de00088a185/tasks","description":"

StartFragment

\n

Create a Task for a Specific Plan

\n

Create a new task that belongs to a particular plan.

\n
\n

Endpoint

\n

POST
/api/v1/plans/:planId/tasks

\n

Example

\n
/api/v1/plans/6963c079a4b3e84b1d29e60c/tasks\n\n
\n

Description

\n

Creates a new task and automatically associates it with the specified plan ID.

\n

The task is also linked to the authenticated user.

\n
\n

HTTP Method

\n

POST

\n
\n

Authentication

\n

🔒 Protected

\n

Requires a valid access token.

\n

Authorization Header

\n
Authorization: Bearer <access_token>\n\n
\n

Request Headers

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderTypeRequiredDescription
Content-TypeStringYesapplication/json
AuthorizationStringYesBearer access token
\n
\n

URL Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
planIdStringID of the plan
\n
\n

Request Body (Example)

\n
{\n  \"task\": \"Implement authentication\",\n  \"description\": \"Add login and signup flow\",\n  \"dueDate\": \"2026-01-25\",\n  \"priority\": \"high\"\n}\n\n
\n
\n

The plan field is not required in the body — it is derived from planId.

\n
\n

Success Response

\n

201 Created

\n
{\n  \"status\": \"success\",\n  \"data\": {\n    \"task\": {\n      \"_id\": \"6971bb96a69a94bf1c08761a\",\n      \"task\": \"Implement authentication\",\n      \"description\": \"Add login and signup flow\",\n      \"dueDate\": \"2026-01-25T00:00:00.000Z\",\n      \"priority\": \"high\",\n      \"completed\": false,\n      \"plan\": \"6963c079a4b3e84b1d29e60c\",\n      \"user\": \"6962225f15d8e9bcb9d0fc9d\",\n      \"createdAt\": \"2026-01-19T09:30:00.000Z\"\n    }\n  }\n}\n\n
\n

Error Responses

\n

400 – Bad Request

\n
{\n  \"status\": \"fail\",\n  \"message\": \"Invalid input data\"\n}\n\n

401 – Unauthorized

\n
{\n  \"status\": \"fail\",\n  \"message\": \"You are not logged in\"\n}\n\n

404 – Plan Not Found

\n
{\n  \"status\": \"fail\",\n  \"message\": \"No plan found with that ID\"\n}\n\n

500 – Server Error

\n
{\n  \"status\": \"error\",\n  \"message\": \"Something went wrong\"\n}\n\n
","urlObject":{"path":["v1","plans","6958b410d8449de00088a185","tasks"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"ed82c1cf-05fc-46fb-aab7-0791229f0d68"}],"id":"7da8674d-85f7-4973-a35f-1f361d8ef418","_postman_id":"7da8674d-85f7-4973-a35f-1f361d8ef418","description":""},{"name":"User/plans","item":[{"name":"user/plans","id":"02c89824-636f-4bfd-a52b-9d5f49ccdea8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

Get All Plans for a Specific User

\n

Retrieve all plans that belong to a particular user.

\n
\n

Endpoint

\n

GET
/api/v1/users/:userId/plans

\n

Example

\n
/api/v1/users/69644604c184de7fd9d26e1a/plans\n\n
\n

Description

\n

Returns all plans created by or assigned to the specified user.

\n

Supports pagination and sorting.

\n
\n

HTTP Method

\n

GET

\n
\n

Authentication

\n

🔒 Protected

\n

Requires a valid access token.

\n

Authorization Header

\n
Authorization: Bearer <access_token>\n\n
\n

Request Headers

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderTypeRequiredDescription
AuthorizationStringYesBearer access token
\n
\n

URL Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
userIdStringID of the user
\n
\n

Query Parameters (Optional)

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
pageNumberPage number for pagination
limitNumberNumber of plans per page
sortStringSort order (field or -field)
\n
\n

Example Requests

\n
/api/v1/users/69644604c184de7fd9d26e1a/plans?page=1&limit=5\n\n
/api/v1/users/69644604c184de7fd9d26e1a/plans?sort=-createdAt\n\n
\n

Success Response

\n

200 OK

\n
{\n  \"status\": \"success\",\n  \"results\": 2,\n  \"data\": {\n    \"docs\": [\n      {\n        \"_id\": \"6963c079a4b3e84b1d29e60c\",\n        \"plan\": \"January Productivity Plan\",\n        \"user\": \"69644604c184de7fd9d26e1a\",\n        \"createdAt\": \"2026-01-10T08:30:00.000Z\"\n      },\n      {\n        \"_id\": \"6963c079a4b3e84b1d29e60d\",\n        \"plan\": \"Fitness Plan\",\n        \"user\": \"69644604c184de7fd9d26e1a\",\n        \"createdAt\": \"2026-01-05T12:15:00.000Z\"\n      }\n    ]\n  }\n}\n\n
\n

Error Responses

\n

401 – Unauthorized

\n
{\n  \"status\": \"fail\",\n  \"message\": \"You are not logged in\"\n}\n\n

403 – Forbidden

\n
{\n  \"status\": \"fail\",\n  \"message\": \"You do not have permission to view these plans\"\n}\n\n

404 – User Not Found

\n
{\n  \"status\": \"fail\",\n  \"message\": \"No user found with that ID\"\n}\n\n

500 – Server Error

\n
{\n  \"status\": \"error\",\n  \"message\": \"Something went wrong\"\n}\n\n
","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"02c89824-636f-4bfd-a52b-9d5f49ccdea8"},{"name":"user/plans create","id":"d59e1b1e-9c37-410a-9215-610139e9168f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}api/v1/users/69644604c184de7fd9d26e1a/plans","description":"

StartFragment

\n

Create a Plan for a Specific User

\n

Create a new plan and associate it with a particular user.

\n
\n

Endpoint

\n

POST
/api/v1/users/:userId/plans

\n

Example

\n
/api/v1/users/69644604c184de7fd9d26e1a/plans\n\n
\n

Description

\n

Creates a new plan and automatically associates it with the specified user ID.

\n
\n

HTTP Method

\n

POST

\n
\n

Authentication

\n

🔒 Protected

\n

Requires a valid access token.

\n

Authorization Header

\n
Authorization: Bearer <access_token>\n\n
\n

Request Headers

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderTypeRequiredDescription
Content-TypeStringYesapplication/json
AuthorizationStringYesBearer access token
\n
\n

URL Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescription
userIdStringID of the user
\n
\n

Request Body (Example)

\n
{\n  \"title\": \"Q1 Growth Plan\",\n}\n\n
\n
\n

The user field is not required in the request body — it is derived from userId.

\n
\n

Success Response

\n

201 Created

\n
{\n  \"status\": \"success\",\n  \"data\": {\n    \"plan\": {\n      \"_id\": \"6963c079a4b3e84b1d29e60c\",\n      \"plan\": \"Q1 Growth Plan\",\n      \"user\": \"69644604c184de7fd9d26e1a\",\n      \"createdAt\": \"2026-01-18T14:40:00.000Z\"\n    }\n  }\n}\n\n
\n

Error Responses

\n

400 – Bad Request

\n
{\n  \"status\": \"fail\",\n  \"message\": \"Invalid input data\"\n}\n\n

401 – Unauthorized

\n
{\n  \"status\": \"fail\",\n  \"message\": \"You are not logged in\"\n}\n\n

403 – Forbidden

\n
{\n  \"status\": \"fail\",\n  \"message\": \"You do not have permission to create a plan for this user\"\n}\n\n

404 – User Not Found

\n
{\n  \"status\": \"fail\",\n  \"message\": \"No user found with that ID\"\n}\n\n

500 – Server Error

\n
{\n  \"status\": \"error\",\n  \"message\": \"Something went wrong\"\n}\n\n
","urlObject":{"path":["v1","users","69644604c184de7fd9d26e1a","plans"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"d59e1b1e-9c37-410a-9215-610139e9168f"}],"id":"861c44d1-45a8-44fd-800b-603a32ecc4b4","_postman_id":"861c44d1-45a8-44fd-800b-603a32ecc4b4","description":""}]}