> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Intercom: List Notes

> List the notes on an Intercom contact. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List the notes on an Intercom contact.

> [!NOTE]
>
> Tool ID: `intercom_list_notes`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
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

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute intercom_list_notes --input '{
  "contact_id": "contact_123"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "type": "example",
    "data": [
      {
        "type": "example",
        "id": "id_123",
        "created_at": 123
      }
    ],
    "total_count": 123
  }
}
```

Use `deepline describe 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. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "You can fetch a list of notes that are associated to a contact.",
    "properties": {
      "contact_id": {
        "type": "string",
        "description": "The unique identifier of a contact."
      }
    },
    "required": [
      "contact_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "A paginated list of notes associated with a contact.",
        "properties": {
          "type": {
            "type": "string",
            "description": "String representing the object's type. Always has the value `list`."
          },
          "data": {
            "type": "array",
            "description": "An array of notes.",
            "items": {
              "type": "object",
              "description": "Notes allow you to annotate and comment on your contacts.",
              "properties": {
                "type": {
                  "type": "string",
                  "description": "String representing the object's type. Always has the value `note`."
                },
                "id": {
                  "type": "string",
                  "description": "The id of the note."
                },
                "created_at": {
                  "type": "integer",
                  "description": "The time the note was created.",
                  "format": "timestamp"
                },
                "contact": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "description": "Represents the contact that the note was created about.",
                  "properties": {
                    "type": {
                      "type": "string",
                      "description": "String representing the object's type. Always has the value `contact`."
                    },
                    "id": {
                      "type": "string",
                      "description": "The id of the contact."
                    }
                  },
                  "additionalProperties": false
                },
                "author": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "description": "Admins are teammate accounts that have access to a workspace.",
                  "properties": {
                    "type": {
                      "type": "string",
                      "description": "String representing the object's type. Always has the value `admin`."
                    },
                    "id": {
                      "type": "string",
                      "description": "The id representing the admin."
                    },
                    "name": {
                      "type": "string",
                      "description": "The name of the admin."
                    },
                    "email": {
                      "type": "string",
                      "description": "The email of the admin."
                    },
                    "job_title": {
                      "type": "string",
                      "description": "The job title of the admin."
                    },
                    "away_mode_enabled": {
                      "type": "boolean",
                      "description": "Identifies if this admin is currently set in away mode."
                    },
                    "away_mode_reassign": {
                      "type": "boolean",
                      "description": "Identifies if this admin is set to automatically reassign new conversations to the apps default inbox."
                    },
                    "away_status_reason_id": {
                      "type": [
                        "integer",
                        "null"
                      ],
                      "description": "The unique identifier of the away status reason"
                    },
                    "has_inbox_seat": {
                      "type": "boolean",
                      "description": "Identifies if this admin has a paid inbox seat to restrict/allow features that require them."
                    },
                    "team_ids": {
                      "type": "array",
                      "description": "This object represents the avatar associated with the admin.",
                      "items": {
                        "type": "integer"
                      }
                    },
                    "avatar": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "Image for the associated team or teammate",
                      "format": "uri"
                    },
                    "team_priority_level": {
                      "type": [
                        "object",
                        "null"
                      ],
                      "description": "Admin priority levels for teams",
                      "properties": {
                        "primary_team_ids": {
                          "type": [
                            "array",
                            "null"
                          ],
                          "description": "The primary team ids for the team",
                          "items": {
                            "type": "integer"
                          }
                        },
                        "secondary_team_ids": {
                          "type": [
                            "array",
                            "null"
                          ],
                          "description": "The secondary team ids for the team",
                          "items": {
                            "type": "integer"
                          }
                        }
                      },
                      "additionalProperties": false
                    }
                  },
                  "additionalProperties": false
                },
                "body": {
                  "type": "string",
                  "description": "The body text of the note."
                }
              },
              "additionalProperties": false
            }
          },
          "total_count": {
            "type": "integer",
            "description": "A count of the total number of notes."
          },
          "pages": {
            "type": [
              "object",
              "null"
            ],
            "description": "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.",
            "properties": {
              "type": {
                "type": "string",
                "description": "the type of object `pages`.",
                "enum": [
                  "pages"
                ]
              },
              "page": {
                "type": "integer",
                "description": "The current page"
              },
              "next": {
                "type": [
                  "object",
                  "null"
                ],
                "properties": {
                  "per_page": {
                    "type": "integer",
                    "description": "The number of results to fetch per page."
                  },
                  "starting_after": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The cursor to use in the next request to get the next page of results."
                  }
                },
                "additionalProperties": false
              },
              "per_page": {
                "type": "integer",
                "description": "Number of results per page"
              },
              "total_pages": {
                "type": "integer",
                "description": "Total number of pages"
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [Intercom provider guide](https://deepline.com/docs/providers/intercom/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.