Search Notes

POST 
/notes/search

Search Notes

Request

Version stringrequired

API Version

Available options2023-02-21

application/json

application/json

Body

Bodyrequired

locationIdstringrequired

Location Id

querystring

Search query string to filter notes

sourcesstring[]

Filter notes by source type

createdByUserIdstring

Filter notes by the user who created them

limitnumber

Maximum number of notes to return

skipnumber

Number of notes to skip for pagination

sortBystring

Field to sort the results by

sortOrderstring
Sort order direction
Available optionsascdesc
countboolean

Whether to include total count in the response

relationsstring[]

Filter notes by relation record IDs

includeRelationRecordsboolean

Whether to include related records in the response

Example (auto)

{
  "locationId": "a1b2c3d4e5f6g7h8i9j0",
  "query": "lorem ipsum",
  "sources": [
    "WEB_USER",
    "WORKFLOW"
  ],
  "createdByUserId": "VWTbKSJtS4ueEPV3inr1",
  "limit": 10,
  "skip": 10,
  "sortBy": "dateAdded",
  "sortOrder": "desc",
  "count": true,
  "relations": [
    "VWTbKSJtS4ueEPV3inr1",
    "VWTbKSJtS4ueEPV3inr1"
  ],
  "includeRelationRecords": true
}

application/json

Successful response

application/json

Schema

Schema

noteobject

The note object

Example (auto)

{
  "note": {
    "id": "HGPcayliwcdoUFzvbTok",
    "body": "lorem ipsum",
    "userId": "TUcmRxWrjqzJS8EjkxNK",
    "dateAdded": "2021-07-08T12:02:11.285Z",
    "title": "Follow-up summary",
    "color": "#FFAA00",
    "pinned": false
  }
}