# ◉ Note Endpoints

## Get a list of notes at the top-level of a project

 - [GET /projects/{project_id}/notes](https://testpad-api.redocly.app/openapi/note-endpoints/paths/~1projects~1%7Bproject_id%7D~1notes/get.md): Fetches any notes (note items) that sit at the top level of the project.

For notes in specific folders, see GET /projects/:p/folders/:f/notes.

For more description of notes and their representation, see POST /projects/:p/notes.

## Create a note in a project

 - [POST /projects/{project_id}/notes](https://testpad-api.redocly.app/openapi/note-endpoints/paths/~1projects~1%7Bproject_id%7D~1notes/post.md): Creates a new note in the top level of the project project_id.

Notes are text comments displayed beside scripts and folders in the project view,
allowing for additional notes, comments or instructions to be displayed at the
project/folder and folder report levels.

The new note is supplied as a JSON object in the request body with the
contents of the note in the name field. This might seem like an odd
choice of field name, but is used for consistency with the other types of items
found in projects and folders, namely Folders, Scripts and Notes.
All project/folder items have a name field, which is the text displayed in the
project/folder view. As such, the contents of a Note are in fact its displayed "name".

## Get the list of notes in a folder

 - [GET /projects/{project_id}/folders/{folder_id}/notes](https://testpad-api.redocly.app/openapi/note-endpoints/paths/~1projects~1%7Bproject_id%7D~1folders~1%7Bfolder_id%7D~1notes/get.md): Fetches the list of notes within a folder (but not its subfolders).

For notes in the root folder of a project, see GET /projects/:p/notes.

For more description of notes and their representation, see POST /projects/:p/notes.

## Create a note in a folder

 - [POST /projects/{project_id}/folders/{folder_id}/notes](https://testpad-api.redocly.app/openapi/note-endpoints/paths/~1projects~1%7Bproject_id%7D~1folders~1%7Bfolder_id%7D~1notes/post.md): Creates a new note in the folder folder_id within the project project_id.

For more description of notes and their representation, see POST /projects/:p/notes.

## Modify a note

 - [PATCH /projects/{project_id}/notes/{note_id}](https://testpad-api.redocly.app/openapi/note-endpoints/paths/~1projects~1%7Bproject_id%7D~1notes~1%7Bnote_id%7D/patch.md): Modifies the project/folder Note specified by note_id.

The specified note is modified by simply supplying replacement text
contents in the name field of the payload JSON object.

For more description of notes and their representation, see POST /projects/:p/notes.