get
https://integrate.rooflink.com/roof_link_endpoints/api/light/notes/
Gets a paginated list of notes that the authenticated user has access to.
Access Control:
- Employees: Can view all notes within their company that they have permission to access. The specific notes visible depend on the employee's permissions within the company structure.
- Crew Members: Can only view notes where they are either the sender or a recipient.
Filtering:
The endpoint supports several query parameters to filter the results:
deleted: Filter for archived (deleted) notes. When set totrue, only notes archived by the current user are returned. Whenfalseor omitted, archived notes are excluded from results.job: Filter notes by job ID to retrieve only notes associated with a specific job.tags: Filter notes by tags to find notes with specific categorization. Supports comma-separated values to filter by multiple tags (e.g.,tags=Important,Urgent).search: Search within note messages and customer names to find relevant notes.sent_to: Filter by employee recipient. Shows all notes sent to a specific employee (as primary sales rep, alternative sales rep, or recipient).employee: Filter by employee involvement. Shows all notes where an employee is the sender, recipient, primary sales rep, or alternative sales rep.read: Filter by read status. Shows only read or unread notes based on the boolean value.
Default Behavior:
By default, archived notes are excluded from the list unless explicitly requested using the deleted=true parameter. Notes are returned in reverse chronological order by creation date.
