Retrieve note

get

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

Retrieves detailed information for a specific note by its ID.

Access Control:

Employees: Can retrieve any note within their company that they have permission to access based on their role and permissions.
Crew Members: Can only retrieve notes where they are either the sender or a recipient. Access to notes outside of their involvement is denied.

Archived Notes:

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

Note: Retrieving a note does not automatically mark it as read. Use the mark as read action endpoint to update the read status.

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 metadata.

401Unauthorized. Authentication credentials were not provided or are invalid. The request must include valid authentication tokens to access this endpoint.

403Forbidden. The authenticated user does not have permission to access this note. This can occur if a crew member attempts to access a note they are not involved with, or if the note belongs to a different company.

404Not Found. The specified note does not exist, the user does not have access to it, or the note is archived and the deleted=true 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.