GuidesREST API ReferenceRelease NotesLatest Releases
REST API Reference

List all research notes

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

List research notes

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Filter results by user property

string

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

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
string

Filter results by label ID

string

Limit results to those shared with user-group or user

string

Limit results to those created from a template (id)

string

Filter notes created since a forward slash delimited date

string

Filter notes created up to a forward slash delimited date

string

Filter notes to only those with unmatched tags

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" ] } }

boolean

Filter notes on those with (or without) comments

boolean

Filter notes to only those with (or without) attachments

string
enum
Defaults to reference

The format of image URLs in note content and HTML fields. Use absolute to include ephemeral URLs to images. Use reference to include references to image IDs that match up to entries in the images array.

Allowed:
Responses

Updated 3 months ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 3 months ago