List all research notes

get deprecated

https://{client}-api.bipsync.com/v4/research/note

List research notes. This endpoint is deprecated: use /v5/research/note instead.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

user

string

Filter results by 'user' property

externalId

string

Filter results by an external ID that has been previously associated with a note

excludeDeleted

boolean

Filter results by 'deleted' status

string

Filter results by 'related' property

field

array

Filter results by 'fields' property, use {fieldName:{$ne:null}} to search for documents with fields. Filtering using dates can be achieved using since/until within the filed value, with a date formated as M/D/Y.

field

label

string

Filter results by 'label id'

sharedWith

string

Limit results to those shared with user-group or user

template

string

Limit results to those created from a template (id)

since

string

Filter notes created since a forward slash delimited date

until

string

Filter notes created up to a forward slash delimited date

unmatched

string

Filter notes to only those with unmatched tags

select

string

Filter the properties on documents in the response by supplying a comma-separated allow list

lookup

object

Get more information on lookup field values by passing a lookup object. Example: { 'lookup' : { 'lookupFieldId' : [ 'documentProperty1', 'documentProperty2' ] } }

hasComments

boolean

Filter notes on those with (or without) comments

hasAttachments

boolean

Filter notes to only those with (or without) attachments

Response

200Note results