Skip to main content
NotesVersion: v3

Search Notes

POST/notes/search

Search Notes

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:notes.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Body

application/json
locationIdstringrequired

Location Id

Example:a1b2c3d4e5f6g7h8i9j0
querystring

Search query string to filter notes

Example:lorem ipsum
sourcesstring[]

Filter notes by source type

Example:["WEB_USER","WORKFLOW"]
createdByUserIdstring

Filter notes by the user who created them

Example:VWTbKSJtS4ueEPV3inr1
limitnumber

Maximum number of notes to return

Example:10
skipnumber

Number of notes to skip for pagination

Example:10
sortBystring

Field to sort the results by

Example:dateAdded
sortOrderstring

Sort order direction

Available optionsascdesc
Example:desc
countboolean

Whether to include total count in the response

Example:true
relationsstring[]

Filter notes by relation record IDs

Example:["VWTbKSJtS4ueEPV3inr1","VWTbKSJtS4ueEPV3inr1"]
includeRelationRecordsboolean

Whether to include related records in the response

Example:true

Response

application/json

Successful response

noteobject

The note object