Client notes

GET /notes-client

Retrieves client notes.

ClientId must be specified unless you’re using the page parameter.

Example: GET /notes-client?page=0&limit=200&fromDate=YYYY-MM-DD Parameters:

Parameter	Default	Description
`limit`	200	Items per page
`page`	0	Pagination offset (skips N records)
`fromDate`	-	Notes with timestamp >= value. Format: `YYYY-MM-DD`
`toDate`	-	Notes with timestamp <= value. Format: `YYYY-MM-DD`
`assignedTo`	-	Filter by assigned email address
`closed`	-	`1` returns only closed items, `0` returns only open items
`taskClosed`	-	`1` returns only items with closed tasks, `0` returns only items with open tasks
`ClientId`	-	Required unless `page` is set. Filter by client ID. This parameter is case-sensitive and, unlike other endpoints, uses `ClientId`: `clientId` returns `{"status":"error","message":"Client Id Required"}`

The client ID is not returned as a named field. It is in _ReferringId_1 for notes created directly on the client and _ReferringId_2 for roster-linked notes. Response fields:

Field	Type	Notes
`NoteId`	integer
`CategoryId`	integer
`NoteType`	string	e.g. `"APPNOTEGENERAL"`
`Note`	string
`Reason`	string
`Comment`	string
`Action`	string
`Outcome`	string
`Response`	string/null
`Location`	string
`Occurrence`	string
`Performance`	string
`Timestamp`	string	Datetime
`NoteDate`	string	Date
`NotifiedDate`	string	Date
`AlertDate`	string	Date
`CloseDate`	string	Date
`TaskClosedDate`	string	Date
`AssignedTo`	string	Email
`AssignedToSecond`	string	Email
`Closed`	integer	0/1
`TaskClosed`	integer	0/1
`RequiresFollowUp`	integer	0/1
`VisibleClientApp`	integer	0/1
`VisibleWorkerApp`	integer	0/1
`CreatedBy`	string
`_ReferringId_1`	integer
`_ReferringId_2`	integer
`_ReferringId_3`	integer

Overview

Clients

Workers

Categories

Organisation

Scheduling

People

Incidents

Records

GET /notes-client

​GET /notes-client

GET /notes-client