List Notes of an Entity

GET/api/notes/{rel_type}/{rel_id}

Headers

FieldTypeDescription
authtoken String Authentication token, generated from admin area

Parameters

FieldTypeDescription
rel_type String One of: customer, lead, contract, ticket, invoice, estimate, credit_note, staff, expense, proposal, project, task.
rel_id Number The related record id.
curl -X GET "https://yoursite.com/api/notes/customer/123" \
  -H "authtoken: YOUR_API_TOKEN"

Success-Response:

HTTP/1.1 200 OK
[
    {
        "id": "142",
        "description": "Called the client to confirm the renewal date. They will send the signed contract by Friday.",
        "date_contacted": null,
        "dateadded": "2026-03-14 15:42:07",
        "addedfrom": "3",
        "rel_id": "18",
        "rel_type": "customer"
    },
    {
        "id": "128",
        "description": "Client requested a follow-up call regarding the outstanding invoice.",
        "date_contacted": null,
        "dateadded": "2026-03-02 09:18:55",
        "addedfrom": "1",
        "rel_id": "18",
        "rel_type": "customer"
    }
]

Not-Found:

HTTP/1.1 404 Not Found
{
    "status": false,
    "message": "No data were found"
}
MethodGET
Path/api/notes/{rel_type}/{rel_id}
GroupNotes
Sincev3.0.0
Defined inmodules/api/controllers/Notes.php