Retrieve user note

get

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

Retrieves detailed information for a specific user note by its ID.

Recipient Access: Users can only retrieve notes where they are listed as a recipient. Notes where the user is the sender but not a recipient cannot be accessed.

Archived Notes:

By default, archived (deleted) notes are excluded from retrieval and will return a 404 error. To retrieve an archived note, include the status=Archived query parameter in the request.

Note Behavior:

This endpoint can retrieve both thread starter notes and reply notes within threads. The same access control and archived status rules apply to all notes.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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 retrieved successfully. Returns the complete note details including sender information, all recipients, message content, tags, and associated job information.

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 does not exist, the user is not a recipient of the note, the note belongs to a different company, the user is the sender (but not a recipient), or the note is archived and the status=Archived parameter was not provided.

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.