List 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 to true, only notes archived by the current user are returned. When false or 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1
Defaults to 1

Page number for pagination. Used to navigate through multiple pages of results.

integer
1 to 10
Defaults to 10

Number of items per page. Controls how many notes are returned in a single response.

boolean
Defaults to false

Filter for archived notes. When set to true, returns only notes that have been archived by the current user. When false or omitted, returns only non-archived notes.

integer

Filter notes by job ID. Returns only notes associated with the specified job.

string

Filter notes by tags. Returns notes that contain any of the specified tags. Supports multiple values as a comma-separated list (e.g., Important,Urgent,Follow-up).

string

Search term to filter notes. Searches within note messages and associated customer names for matches.

integer

Filter notes by employee recipient. Returns notes where the specified employee ID is listed as the primary sales representative, alternative sales representative, or in the recipients list. This allows filtering to see all notes sent to a particular employee.

integer

Filter notes by employee involvement. Returns notes where the specified employee ID is the sender, a recipient, primary sales representative, or alternative sales representative. This provides a comprehensive view of all notes an employee is involved with.

boolean

Filter notes by read status. When true, returns only notes that have been marked as read. When false, returns only unread notes.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json