List all your folders
Request
GET /folder/list
Form Data
| Attribute |
Description |
Token |
Need to provide the token which generated during the login |
Note: Need to provide the token under authorization as Bearer token
Response
There are 2 types of responses.
| Status Code |
Description |
| 200 |
It will return the values as json data and list data one by one. |
| 400 |
Bad Request Format or The user is not authenticated. |
Examples
200 OK
{
"id": "1"
"name": "new notes"
"owner": "owner"
"created_at": "1 hour ago"
"id": "2"
"name": "new notes2"
"owner": "owner2"
"created_at": "1 hour ago"
}
400 Bad Request
{
"error": "Bad request"
}
Create a new folder
Request
POST /folder/new
Authorization: Bearer <your_access_token>
Form Data
| Attribute |
Description |
Token |
Need to provide the token which generated during the login |
Name |
Need to provide the name of the folder. |
Response
There are 3 types of responses.
| Status Code |
Description |
| 200 |
Folder created successfully. |
| 403 |
unauthorized user. |
| 400 |
Bad Request Format or Not all attributes are available. |
Examples
200 OK
{
"folder_id": 13
}
400 Bad Request
{
"error": "Bad request"
}
Get all notes
Request
POST /folder/get_all_notes
Authorization: Bearer <your_access_token>
Form Data
| Attribute |
Description |
Token |
Need to provide the token which generated during the login |
Response
There are 3 types of responses.
| Status Code |
Description |
| 200 |
success it will list all the notes. |
| 403 |
unauthorized user. |
| 400 |
Bad Request Format or Not all attributes are available. |
Examples
200 OK
{
"count": "2",
"notes": [
"id": "1"
"name": "new notes"
"owner": "owner"
"created_at": "1 day ago"
"modified_at": "1 hour ago"
"id": "2"
"name": "new notes 2"
"owner": "owner2"
"created_at": "1 day ago"
"modified_at": "1 hour ago"
]
}
400 Bad Request
{
"error": "Bad request"
}
Delete note
Request
POST /folder/delete
Authorization: Bearer <your_access_token>
Form Data
| Attribute |
Description |
Note_search_Term |
Need of particular folder Id (or) Title (or) Body |
Token |
Need to provide the token generated during login |
Response
There are 3 types of responses.
| Status Code |
Description |
| 200 |
Success data deleted. |
| 403 |
unauthorized user. |
| 400 |
Bad Request Format. |
Examples
200 OK
{
"message": "success"
}
400 Bad Request
{
"error": "Bad request"
}
List
Request
POST /folder/get
Authorization: Bearer <your_access_token>
Form Data
| Attribute |
Description |
id |
Need to provide the id of particular folder |
Token |
Need to provide the token generated during login |
Response
There are 3 types of responses.
| Status Code |
Description |
| 200 |
User can get all the existing data. |
| 403 |
unauthorized user. |
| 400 |
Bad Request Format. |
Examples
200 OK
{[
{
"id": "12",
"name": "Default Folder",
"owner": "owner",
"created_at": "2024-02-15 23:48:22",
"created": "18 minutes ago",
"count": "0"
},
{
"id": "13",
"name": "Personal Notes",
"owner": "owner",
"created_at": "2024-02-15 23:49:14",
"created": "18 minutes ago",
"count": "0"
},
{
"id": "14",
"name": "Office Notes",
"owner": "owner",
"created_at": "2024-02-16 00:05:45",
"created": "1 minute ago",
"count": "0"
}
]
}
400 Bad Request
{
"error": "Bad request"
}
Rename
Request
POST /folder/rename
Authorization: Bearer <your_access_token>
Form Data
| Attribute |
Description |
id |
Need to provide the id of particular folder |
Token |
Need to provide the token generated during login |
Response
There are 3 types of responses.
| Status Code |
Description |
| 200 |
User can modify the existing data. |
| 403 |
unauthorized user. |
| 400 |
Bad Request Format. |
Examples
200 OK
{
"id": "1"
"name": "new notes"
"owner": "owner"
"created_at": "1 day ago"
"modified_at": "1 hour ago"
}
400 Bad Request
{
"error": "Bad request"
}
Delete
Request
POST /folder/delete
Authorization: Bearer <your_access_token>
Form Data
| Attribute |
Description |
id |
Need to provide the id of particular folder |
Token |
Need to provide the token generated during login |
Response
There are 3 types of responses.
| Status Code |
Description |
| 200 |
Deleted successfully. |
| 403 |
unauthorized user. |
| 400 |
Bad Request Format. |
Examples
200 OK
{
"message": "success"
}
400 Bad Request
{
"error": "Bad request"
}