List user note threads

get

https://integrate.rooflink.com/roof_link_endpoints/api/light/user-notes/

Retrieves a paginated list of note threads where the authenticated user is a recipient.

Key Behaviors:

Returns only note threads (thread starter messages), not individual replies within threads.
Only notes where the current user is listed as a recipient are returned. Notes where the user is the sender but not a recipient are excluded.
Results are limited to a maximum of 100 thread starters, even if more exist in the database.
Results are ordered by thread update date in descending order (most recently updated threads first).
By default, archived notes are excluded from results. Use the status=Archived query parameter to view archived notes instead.

Read Status Tracking:

Each note includes an is_read field indicating whether the current user has marked the note as read. Use the exclude_read=true query parameter to filter out notes that have already been read.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

≥ 1

Defaults to 1

Page number for pagination. Each page contains up to 10 results.

page_size

integer

1 to 10

Defaults to 10

Number of results per page. Maximum and default value is 10.

string

Case-insensitive search filter for note message content. Matches notes whose message field contains the specified text.

tag

string

Filter notes by a specific tag. Only notes that have this exact tag in their tags array will be returned. Tag matching is case-sensitive.

status

string

enum

Filter notes by archived status.

When set to "Archived": Returns only notes that have been archived by the current user.
When set to "Active" or any other value, or omitted: Returns only active (non-archived) notes.

Allowed:

exclude_read

string

enum

Exclude notes that have been marked as read by the current user. When set to "true", only unread notes are returned.

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Note threads retrieved successfully. Returns a paginated list of note threads with sender, recipient, and job information.

400Bad Request. Invalid query parameters were provided. This can occur if the page number is invalid, page_size exceeds the maximum, or filter parameters contain invalid values.

401Unauthorized. Authentication credentials were not provided or are invalid. The request must include a valid API key in the X-API-KEY header to access this endpoint.

403Forbidden. The authenticated user does not have employee permissions required to access user notes. This endpoint is restricted to employees only.

404Not Found. The specified note ID does not exist or the user does not have access to it.

429Too Many Requests. The client has exceeded the rate limit for this endpoint. Wait for the specified time period before making additional requests.

503Service Unavailable. The API rate limits for all public endpoints have been exceeded, or the service is temporarily down for maintenance. Try again later.