> ## 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: Retrieve Note

> Get an Intercom note by its ID. Includes SDK V2 and CLI requests, input constraints, response fields, and Deepline credit cost.

Get an Intercom note by its ID.

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

## 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_retrieve_note',
  {
    "note_id": 123
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute intercom_retrieve_note --input '{
  "note_id": 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",
    "id": "id_123",
    "created_at": 123
  }
}
```

Use `deepline describe intercom_retrieve_note --json` for the latest machine-readable contract.

## Input reference

You can fetch the details of a single note.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.note_id` | `integer` | Yes | — | The unique identifier of a given note |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "You can fetch the details of a single note.",
    "properties": {
      "note_id": {
        "type": "integer",
        "description": "The unique identifier of a given note"
      }
    },
    "required": [
      "note_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Notes allow you to annotate and comment on your contacts. |
| `result.data.type` | `string` | No | — | String representing the object's type. Always has the value `note`. |
| `result.data.id` | `string` | No | — | The id of the note. |
| `result.data.created_at` | `integer` | No | — | The time the note was created. Format: `timestamp`. |
| `result.data.contact` | `object \| null` | No | — | Represents the contact that the note was created about. |
| `result.data.contact.type` | `string` | No | — | String representing the object's type. Always has the value `contact`. |
| `result.data.contact.id` | `string` | No | — | The id of the contact. |
| `result.data.author` | `object \| null` | No | — | Admins are teammate accounts that have access to a workspace. |
| `result.data.author.type` | `string` | No | — | String representing the object's type. Always has the value `admin`. |
| `result.data.author.id` | `string` | No | — | The id representing the admin. |
| `result.data.author.name` | `string` | No | — | The name of the admin. |
| `result.data.author.email` | `string` | No | — | The email of the admin. |
| `result.data.author.job_title` | `string` | No | — | The job title of the admin. |
| `result.data.author.away_mode_enabled` | `boolean` | No | — | Identifies if this admin is currently set in away mode. |
| `result.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.author.away_status_reason_id` | `integer \| null` | No | — | The unique identifier of the away status reason |
| `result.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.author.team_ids` | `array` | No | — | This object represents the avatar associated with the admin. |
| `result.data.author.avatar` | `string \| null` | No | — | Image for the associated team or teammate Format: `uri`. |
| `result.data.author.team_priority_level` | `object \| null` | No | — | Admin priority levels for teams |
| `result.data.author.team_priority_level.primary_team_ids` | `array \| null` | No | — | The primary team ids for the team |
| `result.data.author.team_priority_level.secondary_team_ids` | `array \| null` | No | — | The secondary team ids for the team |
| `result.data.body` | `string` | No | — | The body text of the note. |
| `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": "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
      },
      "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.