Logo

Dyzo API

v2.0.0

Getting Started

Getting StartedAuthentication

Company Setup

Company CreationEmployee Invitation

Login & Sessions

Login MethodsPassword Management

Management

ProjectsTasksTask Comments

Team & People

EmployeesCompany

Time & Attendance

HolidaysTask LogsTime Warnings

Communication

NotificationsProject Notes

Analytics & Reports

ReportsScreenshots

Advanced Features

Global SearchLive Activity

Project Notes

Complete Dyzo API Documentation - Project Management, Team Collaboration & Time Tracking Platform

API Overview

Capabilities and features

Complete project notes management system with @mentions, attachments, and activity tracking. Create, update, and organize notes for projects with rich text support and file attachments.

Key Features

Create and manage project notes
@mention team members with notifications
Attach files and documents to notes
Update and delete notes
Track note activity in project journey
Filter notes by meeting status
Email notifications for mentions
Support for multiple attachments per note
POST
/project-notes/
200 OK

Create Project Note (with @mentions & Attachments)

Create a new project note with optional attachments and @mentions. Automatically creates project journey log entry and sends notifications to mentioned users. Supports multiple file attachments with metadata.

JSONRequest Body
1{
2  "project": 2438,
3  "employee": 1311,
4  "noteText": "Project kickoff meeting completed. @john please review the requirements. cc @[email protected]",
5  "is_meeting_note": false,
6  "mentionedEmails": [
7    "[email protected]",
8    "[email protected]"
9  ],
10  "attachments": [
11    {
12      "url": "https://dyzo.ai/files/meeting-notes.pdf",
13      "type": "application/pdf",
14      "name": "meeting-notes.pdf",
15      "folder": "project-docs",
16      "uploaded_at": "2024-11-26T10:30:00Z"
17    },
18    {
19      "url": "https://dyzo.ai/files/requirements.docx",
20      "type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
21      "name": "requirements.docx",
22      "folder": "project-docs"
23    }
24  ]
25}
GET
/project-notes/project/{project_id}/?is_meeting_note=
200 OK

Get All Project Notes

Retrieve all notes for a specific project. Optionally filter by meeting notes and include completed meetings summary. Query Parameters: ā€¢ is_meeting_note (optional): Filter by meeting notes - 'true' (meeting notes only), 'false' (regular notes only), or omit for all notes. When set to 'true', also includes completed meetings list.

GET
/api/projectnotes/{employee_id}/{project_id}/
200 OK

Get Project Notes (Legacy)

Legacy endpoint to get project notes filtered by employee and project. Returns notes using old serializer format.

PUT
/project-notes/{note_id}/?userId=
200 OK

Update Project Note

Update an existing project note. Supports updating note text, attachments, and mentions. Creates project journey log entry. Query Parameters: ā€¢ userId (optional): Employee ID performing the update - used for project journey logging

JSONRequest Body
1{
2  "noteText": "Updated project notes with new information. @mike please check.",
3  "is_meeting_note": false,
4  "mentionedEmails": [
5    "[email protected]"
6  ],
7  "attachments": [
8    {
9      "url": "https://dyzo.ai/files/updated-doc.pdf",
10      "type": "application/pdf",
11      "name": "updated-doc.pdf",
12      "folder": "project-docs"
13    }
14  ]
15}
POST
/api/add/projectnotes/{employee_id}/{project_id}/
200 OK

Create or Update Project Note (Legacy)

Legacy endpoint that creates a new note or updates existing note for employee-project combination. If note exists, updates it; otherwise creates new.

JSONRequest Body
1{
2  "noteText": "Project meeting notes",
3  "attachments": []
4}
DELETE
/project-notes/{note_id}/?userId=
200 OK

Delete Project Note

Delete a project note. Creates project journey log entry if userId provided. Query Parameters: ā€¢ userId (optional): Employee ID performing the deletion - used for project journey logging

PATCH
/project-notes-attachments/{note_id}/
200 OK

Add/Remove Note Attachments

Add new attachments or remove existing attachments from a project note. Supports batch operations - add multiple files and remove multiple files in single request.

JSONRequest Body
1{
2  "remove_ids": [
3    "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
4    "b2c3d4e5-f6g7-8901-bcde-fg2345678901"
5  ],
6  "add_attachments": [
7    {
8      "url": "https://dyzo.ai/files/new-document.pdf",
9      "type": "application/pdf",
10      "name": "new-document.pdf",
11      "folder": "project-docs"
12    },
13    {
14      "url": "https://dyzo.ai/files/screenshot.png",
15      "type": "image/png",
16      "name": "screenshot.png",
17      "folder": "images",
18      "uploaded_at": "2024-11-26T16:00:00Z"
19    }
20  ]
21}
GET
/api/tasknotes/{employee_id}/{project_id}/
200 OK

Get Task Notes

Get notes for tasks in a project.

GET
/api/notes/{employee_id}/
200 OK

Get Employee Notes

Get all notes for an employee.