Appearance

List Notes ​

Endpoint ​

http
GET /unified/crm/notes
Integrations supported
  • ActiveCampaign
  • Affinity
  • Capsule
  • Close
  • Copper
  • FreshSales
  • HubSpot
  • Pipedrive
  • Planhat
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
Partial response integrations

For partial response integrations, you will need to fetch the individual resource using the "get" endpoint to get the full response object.

  • Affinity

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 will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

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
account
object

The note's account

Integration specific notes
  • CloseThe account to be filtered on the notes
  • HubSpotThe account associated with the note
  • FreshSalesAccount associated with the note. One of contact, account and opportunity is always required.
Supported in
  • Affinity
  • Close
  • FreshSales
  • HubSpot
  • Pipedrive
  • Planhat
  • Salesforce
id
string

The account's unique identifier

contact
object

The note's contact

Integration specific notes
  • CloseThe contact to be filtered on the notes. Applicable only when account is also present.
  • HubSpotThe contact associated with the note
  • FreshSalesContact associated with the note. One of contact, account and opportunity is always required.
Supported in
  • Affinity
  • Close
  • FreshSales
  • HubSpot
  • Pipedrive
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
owner
object

The note's owner

Integration specific notes
  • CloseThe owner to be filtered on the notes. Applicable only when account is also present.
  • HubSpotThe owner of the note
Supported in
  • Affinity
  • Close
  • HubSpot
  • Pipedrive
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
id
string

The note's owner's unique identifier

created_at
string · date-time

The date and time of the note's creation

Supported in
  • Close
  • HubSpot
  • Pipedrive
  • Salesforce
  • Zoho CRM
content
string

The content of the note

Supported in
  • HubSpot
  • Zoho CRM
opportunity
array

The note's opportunities

Integration specific notes
  • HubSpotThe opportunity associated with the note
  • FreshSalesOpportunity associated with the note. One of contact, account and opportunity is always required.
Supported in
  • Affinity
  • FreshSales
  • HubSpot
  • Pipedrive
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
updated_at
string · date-time

The date and time of the note's last update

Supported in
  • HubSpot
  • Salesforce
  • Zoho CRM
title
string

The note's title

Supported in
  • Salesforce
  • Zoho CRM
activity_date
Supported in
  • Copper
lead
array

The note's leads

Supported in
  • Zendesk Sell
sort_by

The field to sort the resource by. Should be in format { fieldName: direction }. The direction can be asc or desc.

All possible enum values:
  • created_at
  • title
  • updated_at
Enum support by integration
  • Zendesk Sell
    • created_at
    • updated_at
  • Planhat
    • title
    • created_at
Supported in
  • Planhat
  • Zendesk Sell

Response Body ​

result
object[]

List of Notes

id
string
REQUIRED · 

The note's unique identifier

Supported in
  • ActiveCampaign
  • Affinity
  • Capsule
  • Close
  • Copper
  • FreshSales
  • HubSpot
  • Pipedrive
  • Planhat
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
title
string

The note's title

Supported in
  • Planhat
  • Salesforce
  • Zoho CRM
owner
object

The note's owner

Supported in
  • ActiveCampaign
  • Affinity
  • Capsule
  • Close
  • Copper
  • FreshSales
  • HubSpot
  • Pipedrive
  • 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
  • Capsule
  • Close
  • Copper
  • FreshSales
  • HubSpot
  • Pipedrive
  • Planhat
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
contact
object[]

The note's contact

Supported in
  • ActiveCampaign
  • Affinity
  • Capsule
  • Close
  • Copper
  • FreshSales
  • HubSpot
  • Pipedrive
  • Planhat
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
id
string

The contact's unique identifier

account
object

The note's account

Supported in
  • Affinity
  • Capsule
  • Close
  • Copper
  • FreshSales
  • HubSpot
  • Pipedrive
  • Planhat
  • Salesforce
id
string

The account's unique identifier

opportunity
object[]

The note's opportunities

Supported in
  • Affinity
  • Copper
  • FreshSales
  • HubSpot
  • Pipedrive
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
id
string

The opportunity's unique identifier

lead
object[]

The note's leads

Supported in
  • Zendesk Sell
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
  • Capsule
  • Close
  • Copper
  • FreshSales
  • HubSpot
  • Pipedrive
  • 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
  • FreshSales
  • HubSpot
  • Pipedrive
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.