GET api/contactnotes?crmNumber={crmNumber}&dateCreatedFrom={dateCreatedFrom}&dateCreatedTo={dateCreatedTo}&offset={offset}&limit={limit}&returnTotal={returnTotal}

Get all ContactNotes optionally filtered by any of the arguments specified in the query string.

Request Information

Name	Description	Type	Additional information
crmNumber	Optional filter on the parent Contact records primary key in the Hobsons database.	integer	None.
dateCreatedFrom	Optional filter on records that were created on or after the provided value.	date	None.
dateCreatedTo	Optional filter on records that were created on or before the provided value.	date	None.
offset	The position in the collection of ContactNotes from which to start returning data from.	integer	Default value is 0
limit	The maximum amount of ContactNotes that can be returned in any one call. Maximum allowed is 500.	integer	Default value is 50
returnTotal	Whether to include the total amount of ContactNotes in the database that match the filter specified.	boolean	Default value is False

None.

Name	Description	Type	Additional information
Id	The primary key of the record in the Hobsons database. Ignored for POST requests sent to the API.	integer	None.
CrmNumber	The identifier of the Contact associated with the given record.	integer	Required Range: inclusive between 1 and 2147483647
Content	The content of the note.	string	Required String length: inclusive between 0 and 4000
DateCreated	The date the record was created in the Hobsons database. Ignored for PUT and POST requests sent to the API.	date	None.

Sample:

{
  "Id": 1,
  "CrmNumber": 2,
  "Content": "sample string 3",
  "DateCreated": "2024-05-20T08:56:34.0213091+10:00"
}