Intercom: List Notes

List all notes.

Tool ID: intercom_list_notes

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'intercom_list_notes',
  {
    "contact_id": "contact_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute intercom_list_notes --input '{
  "contact_id": "contact_123"
}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "type": "example",
    "data": [
      {
        "type": "example",
        "id": "id_123",
        "created_at": 123
      }
    ],
    "total_count": 123
  }
}

Use deepline tools get intercom_list_notes --json for the latest machine-readable contract.

Input reference

You can fetch a list of notes that are associated to a contact.

Name	Type	Required	Default	Details
`payload.contact_id`	`string`	Yes	—	The unique identifier of a contact.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	A paginated list of notes associated with a contact.
`result.data.type`	`string`	No	—	String representing the object’s type. Always has the value `list`.
`result.data.data`	`array`	No	—	An array of notes.
`result.data.data[].type`	`string`	No	—	String representing the object’s type. Always has the value `note`.
`result.data.data[].id`	`string`	No	—	The id of the note.
`result.data.data[].created_at`	`integer`	No	—	The time the note was created. Format: `timestamp`.
`result.data.data[].contact`	`object \| null`	No	—	Represents the contact that the note was created about.
`result.data.data[].contact.type`	`string`	No	—	String representing the object’s type. Always has the value `contact`.
`result.data.data[].contact.id`	`string`	No	—	The id of the contact.
`result.data.data[].author`	`object \| null`	No	—	Admins are teammate accounts that have access to a workspace.
`result.data.data[].author.type`	`string`	No	—	String representing the object’s type. Always has the value `admin`.
`result.data.data[].author.id`	`string`	No	—	The id representing the admin.
`result.data.data[].author.name`	`string`	No	—	The name of the admin.
`result.data.data[].author.email`	`string`	No	—	The email of the admin.
`result.data.data[].author.job_title`	`string`	No	—	The job title of the admin.
`result.data.data[].author.away_mode_enabled`	`boolean`	No	—	Identifies if this admin is currently set in away mode.
`result.data.data[].author.away_mode_reassign`	`boolean`	No	—	Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.
`result.data.data[].author.away_status_reason_id`	`integer \| null`	No	—	The unique identifier of the away status reason
`result.data.data[].author.has_inbox_seat`	`boolean`	No	—	Identifies if this admin has a paid inbox seat to restrict/allow features that require them.
`result.data.data[].author.team_ids`	`array`	No	—	This object represents the avatar associated with the admin.
`result.data.data[].author.avatar`	`string \| null`	No	—	Image for the associated team or teammate Format: `uri`.
`result.data.data[].author.team_priority_level`	`object \| null`	No	—	Admin priority levels for teams
`result.data.data[].author.team_priority_level.primary_team_ids`	`array \| null`	No	—	The primary team ids for the team
`result.data.data[].author.team_priority_level.secondary_team_ids`	`array \| null`	No	—	The secondary team ids for the team
`result.data.data[].body`	`string`	No	—	The body text of the note.
`result.data.total_count`	`integer`	No	—	A count of the total number of notes.
`result.data.pages`	`object \| null`	No	—	Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A “cursor” or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or “pages” as needed.
`result.data.pages.type`	`"pages"`	No	—	the type of object `pages`. Allowed: `pages`.
`result.data.pages.page`	`integer`	No	—	The current page
`result.data.pages.next`	`object \| null`	No	—	—
`result.data.pages.next.per_page`	`integer`	No	—	The number of results to fetch per page.
`result.data.pages.next.starting_after`	`string \| null`	No	—	The cursor to use in the next request to get the next page of results.
`result.data.pages.per_page`	`integer`	No	—	Number of results per page
`result.data.pages.total_pages`	`integer`	No	—	Total number of pages
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

Get started

Build and automate

Common workflows

Data and integrations

Reference

Intercom: List Notes

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation