Skip to navigation

List Staff Notes

Returns the notes written on staff profiles for one calendar month, by admins, managers or the staff member themselves.

  • A note belongs to the month of its date (the date the note is for), not the day it was written.
  • Grouped by staff member, newest date first within each person. Only staff with at least one note in the month are listed.
  • Deleted notes, notes on CRM customers, and note attachments are not returned. An edited note shows its current text.

Authentication

AuthorizationApi-Key

Format: “Api-Key {api-key}”

Query parameters

monthstringRequiredformat: "^\d{4}-\d{2}$"

Calendar month, YYYY-MM, for example 2026-10.

salarybox_idslist of stringsOptional

Repeatable. Limits the result to these staff members, for example salarybox_ids=SBK7Q2M9TX&salarybox_ids=SBK3H8D1LP.

pageintegerOptional
Page number, starting at 1.
page_sizeintegerOptional
Results per page. Default and maximum 500.

Response

messagestring
statusboolean
datalist of objects
countinteger

Total number of matching staff members (with at least one note in the month) across all pages.

prevstring or null

URL of the previous page, or null on the first page.

nextstring or null

URL of the next page, or null on the last page.

Errors

400
Bad Request Error