Please Note: Logged in user must have the permission to manage the client for adding or updating the Notes for client.
Note Base URL: https://{tenant-domain}.agentcis.com/api/v2/notes/{notable_type}/{notable_id} Parameters: - notable_type (path parameter): The type of entity (e.g., `client` ,`application=>application_stage`) - notable_id (path parameter): The ID of the entity |
Endpoint: {{Note Base URL}}/
Method: GET
Description: Retrieves all notes for a specific entity type and ID
{ "data": [ { "id": 928, "title": "test", "description": "<h1><strong>Hi there<\/strong><\/h1><p><br><\/p><p>I Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, magna a facilisis eleifend, <u>nulla mauris faucibus<\/u> odio, a convallis nunc neque ut justo. Integer dignissim, purus nec ullamcorper luctus, neque orci bibendum leo, at placerat justo ex ut tortor. Suspendisse potenti. Curabitur fermentum nisl vel <s>eros facilisis<\/s><\/p><p><br><\/p><h1>Non congue nulla mattis.<\/h1><p><br><\/p><blockquote>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, magna a facilisis eleifend, nulla mauris faucibus odio, a convallis nunc neque ut justo. Integer dignissim, purus nec ullamcorper luctus, neque orci bibendum leo, at placerat justo ex ut tortor. Suspendisse potenti. Curabitur fermentum nisl vel eros facilisis, non congue nulla mattis.<\/blockquote>", "description_short": "Hi thereI Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, magna a facilisis eleifend, nulla mauris faucibus odio, a convallis nu...", "pinned_at": null, "created_at": { "formatted": "10-08-2025", "actual": "2025-10-08T14:28:01+05:45" }, "updated_at": { "formatted": "10-08-2025", "actual": "2025-10-08T14:28:01+05:45" }, "belongs_to": "client", "permissions": { "update": true, "delete": true }, "tags": [], "added_by": { "id": 199, "name": "Sazynanana Joshi", "photo": "https:\/\/agentcisapp.s3.ap-southeast-2.amazonaws.com\/e2111f0d-2beb-403e-8802-771d2db53931\/uploads\/users\/photo\/89aac0182799cd0cf37eabe4e17064a2.png" } }, { "id": 96, "title": "Create a new note", "description": "<p>Create a new note<\/p>", "description_short": "Create a new note", "pinned_at": null, "created_at": { "formatted": "12-22-2021", "actual": "2021-12-22T12:52:28+05:45" }, "updated_at": { "formatted": "12-22-2021", "actual": "2021-12-22T12:52:28+05:45" }, "belongs_to": "client", "permissions": { "update": true, "delete": true }, "tags": [], "added_by": { "id": 35, "name": "prabeg shakya", "photo": "" } }, { "id": 95, "title": "Test", "description": "<p>Test<\/p>", "description_short": "Test", "pinned_at": null, "created_at": { "formatted": "12-16-2021", "actual": "2021-12-16T09:35:33+05:45" }, "updated_at": { "formatted": "12-16-2021", "actual": "2021-12-16T09:35:33+05:45" }, "belongs_to": "client", "permissions": { "update": true, "delete": true }, "tags": [], "added_by": { "id": 1, "name": "Megha Pradhan", "photo": "https:\/\/agentcisapp.s3.ap-southeast-2.amazonaws.com\/e2111f0d-2beb-403e-8802-771d2db53931\/uploads\/users\/photo\/%242y%2410%245cUUH9D49KL8kT5USnhrMuHjdcz\/Bi7KU9vOW9prgN1FnZffRkC6..jpeg" } } ], "links": { "first": "http:\/\/demoagency.agentcisapp.com\/api\/v2\/notes\/client\/5?page=1", "last": "http:\/\/demoagency.agentcisapp.com\/api\/v2\/notes\/client\/5?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "links": [ { "url": null, "label": "« Previous", "active": false }, { "url": "http:\/\/demoagency.agentcisapp.com\/api\/v2\/notes\/client\/5?page=1", "label": "1", "active": true }, { "url": null, "label": "Next »", "active": false } ], "path": "http:\/\/demoagency.agentcisapp.com\/api\/v2\/notes\/client\/5", "per_page": 10, "to": 3, "total": 3 } } |
Endpoint: https://{tenant-domain}.agentcis.com/api/v2/notes/{noteId}
Method: GET
Description: See Notes in Details
Response:
{ "data": { "id": 45, "title": "Discontinue Application", "description": "This is description", "description_short": "Short description", "pinned_at": null, "created_at": { "formatted": "2025-08-20", "actual": "2025-08-20T14:41:33+05:45" }, "updated_at": { "formatted": "2025-08-20", "actual": "2025-08-20T14:41:33+05:45" }, "belongs_to": "application_stage", "permissions": { "update": true, "delete": true }, "tags": [], "notable": { "id": 688, "type": "application_stage", "name": "YOT - INN (Application)" }, "added_by": { "id": 1, "name": "Aaryan Koirala", } } } |
Endpoint: {{Note Base URL}}/
Method: POST
Description: Creates Notes in Client section
Permissions: manage.webleads|only.view.clients|manage.assigned.office.clients
{ "title": "test", "description": "<h1><strong>Hi there</strong></h1><p><br></p><p>I Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, magna a facilisis eleifend, <u>nulla mauris faucibus</u> odio, a convallis nunc neque ut justo. Integer dignissim, purus nec ullamcorper luctus, neque orci bibendum leo, at placerat justo ex ut tortor. Suspendisse potenti. Curabitur fermentum nisl vel <s>eros facilisis</s></p><p><br></p><h1>Non congue nulla mattis.</h1><p><br></p><blockquote>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, magna a facilisis eleifend, nulla mauris faucibus odio, a convallis nunc neque ut justo. Integer dignissim, purus nec ullamcorper luctus, neque orci bibendum leo, at placerat justo ex ut tortor. Suspendisse potenti. Curabitur fermentum nisl vel eros facilisis, non congue nulla mattis.</blockquote>" } |
{ "data": { "id": 928, "title": "test", "description": "<h1><strong>Hi there<\/strong><\/h1><p><br><\/p><p>I Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, magna a facilisis eleifend, <u>nulla mauris faucibus<\/u> odio, a convallis nunc neque ut justo. Integer dignissim, purus nec ullamcorper luctus, neque orci bibendum leo, at placerat justo ex ut tortor. Suspendisse potenti. Curabitur fermentum nisl vel <s>eros facilisis<\/s><\/p><p><br><\/p><h1>Non congue nulla mattis.<\/h1><p><br><\/p><blockquote>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, magna a facilisis eleifend, nulla mauris faucibus odio, a convallis nunc neque ut justo. Integer dignissim, purus nec ullamcorper luctus, neque orci bibendum leo, at placerat justo ex ut tortor. Suspendisse potenti. Curabitur fermentum nisl vel eros facilisis, non congue nulla mattis.<\/blockquote>", "description_short": "Hi thereI Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, magna a facilisis eleifend, nulla mauris faucibus odio, a convallis nu...", "pinned_at": null, "created_at": { "formatted": "10-08-2025", "actual": "2025-10-08T14:28:01+05:45" }, "updated_at": { "formatted": "10-08-2025", "actual": "2025-10-08T14:28:01+05:45" }, "belongs_to": "client", "permissions": { "update": true, "delete": true }, "tags": [], "added_by": { "id": 199, "name": "Sazynanana Joshi", "photo": "https:\/\/agentcisapp.s3.ap-southeast-2.amazonaws.com\/e2111f0d-2beb-403e-8802-771d2db53931\/uploads\/users\/photo\/89aac0182799cd0cf37eabe4e17064a2.png" } } } |
Status (if success) : 201
Endpoint: {{Base URL}}/note/{note_id}
Method: PATCH
Description: Updates an existing note
Parameter: note_id (path parameter): The ID of the note
{ "title": "Updated Meeting Notes", "description": "<p>Updated project requirements and timeline.</p>" } |
{ "data": { "id": 96, "title": "Create a new note", "description": "<p>Create a new note test<\/p>", "description_short": "Create a new note test", "pinned_at": null, "created_at": { "formatted": "12-22-2021", "actual": "2021-12-22T12:52:28+05:45" }, "updated_at": { "formatted": "10-08-2025", "actual": "2025-10-08T14:34:22+05:45" }, "belongs_to": "client", "permissions": { "update": true, "delete": true }, "tags": [], "added_by": { "id": 35, "name": "prabeg shakya", "photo": "" } } } |
Status (if success) : 200
Endpoint: {{Base URL}}/note/{note_id}
Method: DELETE
Description: Deletes an existing note
Parameter: note_id (path parameter): The ID of the note
Status (if success) : 204
