Retrieve a research note

get

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

Fetch a single note by ID.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

ID of the research note to retrieve.

Body Params

includeComments

boolean

Includes a boolean hasComments and if applicable an array of comment ids in the results

includeDynamicFields

boolean

Includes the dynamic fields not normally included in the results

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

imageUrlFormat

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:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

404

Note not found.

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json

200Success. Defaults to a JSON response, or returns HTML when the Accept header is set to text/html.

400Returned when an invalid request is made. For example, when unexpected or invalid parameters are detected.

406The server could not produce a response matching the list of acceptable values in the Accept header.