REST API V4 / Notes
The notes API allows you to fetch, add, edit, and delete notes.
Note Properties
| Attribute | Type | Description |
ID |
integer | The system ID of the note |
data |
object | The core properties of the note containing information like associate object type and object ID |
Example note object
Create a Note
Create a new note with this route.
POST /wp-json/gh/v4/notes/
Sample Request
Sample Response
Retrieve a Note
Fetch a contact with this route.
GET /wp-json/gh/v4/notes/<ID>
Sample Response
Update a Note
Update a note with this route.
PATCH /wp-json/gh/v4/notes/<ID>
Sample request
Sample response
Delete a Note
Delete a note with this route.
DELETE /wp-json/gh/v4/notes/<ID>
Sample response
{
"status": "success"
}
List Notes
Retrieve several notes with this route
GET /wp-json/gh/v4/notes
Sample request
GET /wp-json/gh/v4/notes?object_type=contact&object_id=1
This will retrieve all notes for contact with ID 1.