GET Get Contact Notes​
GET
/subscribers/{id}/notes
Retrieve a paginated list of notes for a contact. Supports searching notes by title. Each note includes the user who created it.
Required capability: fcrm_read_contacts
Enforced by SubscriberPolicy::verifyRequest(), the policy default for this route group.
Authorizations​
ApplicationPasswords
WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password
Type
API Key (header: Authorization)
Parameters​
Path Parameters
id*
The contact ID.
Type
Requiredinteger
Query Parameters
search
Search notes by title.
Type
string
per_page
Number of notes per page.
Type
integer
Default
15page
Page number.
Type
integer
Default
1include_id
Id of a note that must appear in the response even when it falls outside the current page. When it is not already on the page it is returned separately as included_note, scoped to this contact.
Type
integer
Responses​
Paginated list of notes.
application/json
JSON
{
"notes": {
"total": 0,
"per_page": 0,
"current_page": 0,
"last_page": 0,
"next_page_url": "string",
"prev_page_url": "string",
"from": 0,
"to": 0,
"data": [
{
"id": 0,
"subscriber_id": 0,
"title": "string",
"description": "string",
"type": "string",
"created_at": "string",
"updated_at": "string",
"added_by": "string"
}
]
},
"fields": {
"fields": [
{
}
]
}
}