> ## 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: Inputs, Cost & CLI Example

> Retrieve a note. Intercom Intercom Retrieve Note docs include request fields, response shape, pricing notes, and Deepline CLI examples.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=intercom_retrieve_note:{"note_id":"{{note_id}}"}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

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

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "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 Schema

| Name          | Type     | Required | Default | Description                                               |
| ------------- | -------- | -------- | ------- | --------------------------------------------------------- |
| `result.data` | `object` | Yes      |         | Notes allow you to annotate and comment on your contacts. |
| `result.meta` | `object` | No       |         | Additional response metadata (status, paging).            |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "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>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute intercom_retrieve_note --payload '{
  "note_id": "integer"
}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

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