Appearance

Get Notes ​

Endpoint ​

http
GET /unified/crm/notes/{id}
Integrations supported
  • ActiveCampaign
  • Affinity
  • Attio
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesforce
  • Zendesk Sell
  • Zoho CRM

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
contact
array

The note's contact

Required in
  • Highlevel

Response Body ​

id
string
REQUIRED · 

The note's unique identifier

Supported in
  • ActiveCampaign
  • Affinity
  • Attio
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
title
string

The note's title

Supported in
  • Attio
  • Microsoft Dynamics 365 Sales
  • Insightly
  • Keap
  • Planhat
  • Salesforce
  • Zoho CRM
owner
object

The note's owner

Supported in
  • ActiveCampaign
  • Affinity
  • Attio
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
id
string

The note's owner's unique identifier

content
string

The note's content

Supported in
  • ActiveCampaign
  • Affinity
  • Attio
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
contact
object[]

The note's contact

References: Contacts → id
Supported in
  • ActiveCampaign
  • Affinity
  • Attio
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • Highlevel
  • HubSpot
  • Keap
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
id
string

The contact's unique identifier

account
object

The note's account

References: Accounts → id
Supported in
  • Affinity
  • Attio
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesforce
  • Zoho CRM
id
string

The account's unique identifier

opportunity
object[]

The note's opportunities

References: Opportunities → id
Supported in
  • Affinity
  • Attio
  • Capsule
  • Copper
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Pipedrive
  • Pipeliner
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
id
string

The opportunity's unique identifier

lead
object[]

The note's leads

References: Leads → id
Supported in
  • Microsoft Dynamics 365 Sales
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
id
string

The lead's unique identifier

visibility
string

The note's visibility

All possible enum values:
  • public
  • private
Supported in
  • Salesforce
created_at
string · date-time

The date and time of the note's creation

Supported in
  • ActiveCampaign
  • Affinity
  • Attio
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
updated_at
string · date-time

The date and time of the note's last update

Supported in
  • ActiveCampaign
  • Affinity
  • Capsule
  • Close
  • Copper
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Insightly
  • Keap
  • Pipedrive
  • Pipeliner
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
urls
object[]

The note's urls

Supported in
  • Attio
  • Salesforce
  • Zendesk Sell
url
string

The note's URL

type
string

The note's URL type

remote_data
object

Raw data returned from the remote API call.