Documentation is now available for the Fall 2020 Update release!

Search client note

This endpoint is used to retrieve client notes under a specific client.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/notes/search

Sample URLs

To search for all client notes of a specific client:

https://{api-url}/api/v2/tenants/client_93/notes/search

To search for a client’s specific client, use query variables. To retrieve client notes updated within a specific time period, provide the startUpdationDate and endUpdationDate query variables.

https://{api-url}/api/v2/tenants/client_93/notes/search?pageNo=2&pageSize=3&queryString=startUpdationDate:2016-11-01T11:49:21 0000+endUpdationDate:2016-11-20T11:49:21 0000

Parameters

All parameters are optional:

FieldDefault Value
pageNo={pageNo}1
pageSize={pageSize}100
isDescendingOrder={true/false}true
sortName={field}note.id
queryString={queryString}NA

NA indicates that the value is not applicable.

Query variables

Query VariablesDescription
searchWordSearch for a note with a specific word provided in the note.
idNote ID.
startCreationDateSearch for note created within a specific date range. startCreationDate denotes the from date.
Example: 2016-03-25T09:54:52+0000
endCreationDateendCreationDate denotes the to date.
Example: 2016-03-27T10:54:52+0000
startUpdationDateSearch for the note updated within a specific date range. startUpdationDate denotes the from date.
Example: 2016-03-25T09:54:52+0000
endUpdationDateendUpdationDate denotes the to date.
Example: 2016-03-27T10:54:52+0000

Status code

200 OK

Sample response

{
	"results": [{
			"id": 26,
			"subject": "Demo Client Note",
			"description": "Client note for Logix",
			"createdTime": "2016-03-25T09:54:52+0000",
			"updatedTime": "2016-03-25T09:54:52+0000",
			"expiryTime": "",
			"createdBy": {
				"id": "USR0000000001",
				"loginName": "superadmin",
				"lastName": "Admin",
				"firstName": "Super",
				"email": "james.hudson@gmail.com",
				"changePassword": false
			}
		},
		{
			"id": 25,
			"subject": "AXC Client Note",
			"description": "Client Note for AXC",
			"createdTime": "2016-03-25T09:54:08+0000",
			"updatedTime": "2016-03-25T09:54:08+0000",
			"expiryTime": "",
			"createdBy": {
				"id": "USR0000000001",
				"loginName": "John.Smith",
				"lastName": "Smith",
				"firstName": "John",
				"email": "john.smith@gmail.com",
				"changePassword": false
			}
		},
		{
			"id": 24,
			"subject": "Client Notes",
			"description": "Notes for Client in location SJ",
			"createdTime": "2016-03-25T09:43:21+0000",
			"updatedTime": "2016-03-25T09:43:21+0000",
			"expiryTime": "",
			"createdBy": {
				"id": "USR0000000001",
				"loginName": "John.Smith",
				"lastName": "Smith",
				"firstName": "John",
				"email": "john.smith@gmail.com",
				"changePassword": false
			}
		}
	],
	"totalResults": 3,
	"orderBy": "note.id",
	"pageNo": 1,
	"pageSize": 3,
	"totalPages": 3,
	"nextPage": true,
	"nextPageNo": 2,
	"previousPageNo": 0,
	"descendingOrder": true
}