Get a List of Notes

This service returns a detailed list of all notes by entity type and entity id.

Query String Parameters

Name	Type	Description	Required
Action	String	GetNotes	Required
EntityType	Int	The entity type of the EntityId or EntityReference.	Required
EntityId	Int	This is the Id of the entity you would like to view the notes of.	Required
EntityReference	String	This is the reference of the entity you wouldd like to view the notes of.	Required
ResourceGroupId	Int	Search for notes attached to resources in a Resource Group, by Id.	Optional
ResourceGroupReference	String	Search for notes attached to resources in a Resource Group, by reference.	Optional
FlagHistory	String	Includes a list of the contact note flags recorded in the result if set to 1.	Optional
IncludeCustomFields	Bool	Include custom fields in the response.	Optional

Response Codes

Example

Request

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=GetNotes&EntityType=1&EntityId=30967687

Response

Response Data

{
  "Code": 0,
  "Result": [
    {
      "NoteId": 27889151,
      "NoteOwner": "Joe Bloggs",
      "NoteReference": "QUO-27889151",
      "NoteTypeId": 20979,
      "NoteType": "Quote",
      "NoteStatus": "Open",
      "NoteSubject": "New Note",
      "NoteText": "",
      "NoteCreationDate": "2024-10-16 10:21:49",
      "DueDate": "2024-10-23 14:21:49",
      "CompletionDate": null,
      "PriorityId": null
    }
  ]
}