User Notes

Endpoints for accessing notes where the authenticated user is a recipient. User Notes provide a personalized view of communications directed to the current user within RoofLink.

Important: Read-Only Access

The User Notes endpoints are read-only. They provide a filtered view of notes where the authenticated user is listed as a recipient. For full note management capabilities, including creating, replying to, archiving, and marking notes as read, use the Notes category endpoints.

Supported User Note Operations

This category includes the following read-only operations:

Querying User Notes

List User Note Threads: Retrieve a paginated list of note threads where the authenticated user is a recipient. Returns only thread starter messages, not individual replies.
Retrieve User Note: Get detailed information for a specific note where the authenticated user is a recipient.

Key Differences from Notes Endpoints

The User Notes endpoints differ from the standard Notes endpoints in several important ways:

Recipient-Only Access

User Notes: Only returns notes where the authenticated user is listed as a recipient
Notes: Returns all notes the user has access to, including notes they sent

This means if you create a note but don't add yourself as a recipient, it will appear in the Notes endpoints but not in the User Notes endpoints.

Thread-Focused View

The List User Note Threads endpoint specifically returns:

Only thread starter messages (parent notes)
Not individual replies within threads
Results ordered by thread update date (most recently updated first)
Maximum of 100 thread starters, even if more exist

Filtering Capabilities

User Notes endpoints support a focused set of filters:

Search: Search within note message content
Tag: Filter by specific note tags
Status: Toggle between active and archived notes
Exclude Read: Filter out notes already marked as read

For more advanced filtering options (by job, employee, sent_to, etc.), use the Notes endpoints.

Read Status Tracking

Each user note includes an is_read field indicating whether the current user has marked it as read:

Retrieving a note does not automatically mark it as read
Use exclude_read=true to filter out already-read notes
To mark notes as read, use the Mark as Read endpoint from the Notes category

Archived Notes

By default, archived notes are excluded from results:

Use status=Archived to view archived notes instead of active ones
To archive or unarchive notes, use the Archive and Unarchive endpoints from the Notes category

Pagination

User note lists are paginated with:

Default page size: 10 items
Maximum page size: 10 items
Results are limited to 100 thread starters total
Results include pagination metadata: count, from_index, to_index, next, previous, and next_page. See the responses page for details.
Notes are returned in reverse chronological order by thread update date