Headers
-
Content-Type
string -
Accept
string
Path parameters
-
notableType
integer Required -
notableUuid
string Required -
notable_type
string Required The type of model to look for. Make sure it is a valid model type that can have notes. Valid types are: ['account', 'board_task', 'case', 'conversation', 'illustration'] .
-
notable_uuid
string Required The UUID of the notable model.
Query parameters
-
include
string Comma separated list of relationships to include in the response. Valid relationships are [tags, mentionedAccounts,notable].
-
filter[uuid]
string Filter by a comma separated list of UUIDs.
-
filter[type]
string Note type to filter by. Valid types are [call, note, meeting, email]
-
filter[date_from]
string Note created_at date to filter from a specific date, can be used with date_to for a range.
-
filter[date_to]
string Note created_at date to filter to from a specific date, can be used with date_from for a range.
-
filter[contents]
string Filter notes by a string to see if it's contents contains that string.
-
filter[path]
string Filter notes by a string to see if the path contains that string.
-
filter[path_exact]
string Filter notes by a string to see if the path is that string.
-
per_page
integer Number of results to return with pagination (Default 15. Max 500).
-
sort
string Field to sort by. Valid fields are [created_at, updated_at, type]. Negative sign to denote DESC. Defaults to 'created_at'.
GET
/api/v1/note/{notableType}/{notableUuid}
curl \
--request GET 'https://api.plannrcrm.com/api/v1/note/notableType/notableUuid' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
Response examples (200)
{
"data": [
{
"tags": [
{
"name": "Mortgage",
"slug": "mortgage",
"uuid": "c34c5b54-5d8a-478e-a41f-642d0c1b4e84",
"colour": "#ef4582",
"created_at": "2025-04-02T13:27:56+01:00",
"updated_at": "2025-04-02T13:27:56+01:00"
}
],
"type": "meeting",
"uuid": "b44b9848-f988-4222-8769-f43006888073",
"edited": true,
"account": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "164c6960-b5f2-455e-a67a-cd4ab807bbf7",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-04-02T13:27:56+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-02T13:27:56+01:00",
"with_login": true,
"inactive_at": "2025-04-02",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-04-02T13:27:56+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-04-02T13:27:56+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-04-02T13:27:56+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-04-02T13:27:56+01:00"
},
"notable": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "fd974c1c-e7a9-459a-bf69-f7033c54e61e",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-04-02T13:27:56+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-02T13:27:56+01:00",
"with_login": true,
"inactive_at": "2025-04-02",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-04-02T13:27:56+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-04-02T13:27:56+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-04-02T13:27:56+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-04-02T13:27:56+01:00"
},
"contents": "Great work",
"created_at": "2025-04-02T13:27:56+01:00",
"updated_at": "2025-04-02T13:27:56+01:00",
"notable_type": "client",
"mentioned_accounts": [
{
"item": "Gareth Thompson",
"contents": "<span data-type=\"mention\" data-account-uuid=\"0e571fcb-e02d-47fa-bd6c-aeed99c859bf\">@Gareth Thompson</span>"
}
],
"external_references": [
{
"uuid": "40462ee4-38f9-4cdf-9b57-26c9a5e63772",
"reference": "AB123456",
"created_at": "2025-04-02T13:27:56+01:00",
"updated_at": "2025-04-02T13:27:56+01:00",
"third_party": "nucleus"
}
]
}
]
}