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

# Affinity: V2 Notes Note ID Get

> Get a single Note. Affinity V2 Notes Note Id Get reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.

Get a single Note.

<Info>
  Tool ID: `affinity_v2_notes_note_id_get`
</Info>

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

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'affinity_v2_notes_note_id_get',
  {
    "noteId": 123
  },
);

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

### CLI

```bash theme={null}
deepline tools execute affinity_v2_notes_note_id_get --input '{
  "noteId": 123
}' --json
```

## Example response

The static output schema is not detailed enough to generate a reliable example. Use `deepline tools get affinity_v2_notes_note_id_get --json` for the complete live contract.

## Input reference

Get a Note with a given id

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.noteId` | `integer` | Yes | — | The id of the Note Format: `int32`. Minimum: 1. Maximum: 2147483647. |
| `payload.includes` | `array` | No | — | Additional properties to include in the response Items must be unique. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Get a Note with a given id",
    "properties": {
      "noteId": {
        "type": "integer",
        "description": "The id of the Note",
        "minimum": 1,
        "maximum": 2147483647,
        "format": "int32"
      },
      "includes": {
        "type": "array",
        "description": "Additional properties to include in the response",
        "uniqueItems": true,
        "items": {
          "type": "string",
          "enum": [
            "companiesPreview",
            "personsPreview",
            "opportunitiesPreview",
            "repliesCount"
          ]
        }
      }
    },
    "required": [
      "noteId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | — |
| `result.data.id` | `integer` | Yes | — | Format: `int32`. Minimum: 1. Maximum: 2147483647. |
| `result.data.content` | `object` | Yes | — | — |
| `result.data.content.html` | `string \| null` | Yes | — | — |
| `result.data.creator` | `object` | Yes | — | — |
| `result.data.creator.id` | `integer` | Yes | — | Format: `int64`. Minimum: 1. Maximum: 9007199254740991. |
| `result.data.creator.firstName` | `string \| null` | Yes | — | — |
| `result.data.creator.lastName` | `string \| null` | Yes | — | — |
| `result.data.creator.primaryEmailAddress` | `string \| null` | Yes | — | Format: `email`. |
| `result.data.creator.type` | `"internal" \| "collaborator" \| "external"` | Yes | — | Allowed: `internal`, `collaborator`, `external`. |
| `result.data.mentions` | `array` | Yes | — | Maximum items: 100. |
| `result.data.mentions[].id` | `integer` | Yes | — | Format: `int32`. Minimum: 1. Maximum: 2147483647. |
| `result.data.mentions[].type` | `"person"` | Yes | — | — |
| `result.data.mentions[].person` | `object` | Yes | — | — |
| `result.data.mentions[].person.id` | `integer` | Yes | — | Format: `int64`. Minimum: 1. Maximum: 9007199254740991. |
| `result.data.mentions[].person.firstName` | `string \| null` | Yes | — | — |
| `result.data.mentions[].person.lastName` | `string \| null` | Yes | — | — |
| `result.data.mentions[].person.primaryEmailAddress` | `string \| null` | Yes | — | Format: `email`. |
| `result.data.mentions[].person.type` | `"internal" \| "collaborator" \| "external"` | Yes | — | Allowed: `internal`, `collaborator`, `external`. |
| `result.data.createdAt` | `string` | Yes | — | Format: `date-time`. |
| `result.data.updatedAt` | `string \| null` | Yes | — | Format: `date-time`. |
| `result.data.repliesCount` | `integer` | No | — | Format: `int32`. Minimum: 0. Maximum: 2147483647. |
| `result.data.opportunitiesPreview` | `object` | No | — | — |
| `result.data.opportunitiesPreview.data` | `array` | No | — | Maximum items: 100. |
| `result.data.opportunitiesPreview.data[].id` | `integer` | Yes | — | Format: `int64`. Minimum: 1. Maximum: 9007199254740991. |
| `result.data.opportunitiesPreview.data[].name` | `string` | Yes | — | — |
| `result.data.opportunitiesPreview.data[].listId` | `integer` | Yes | — | Format: `int64`. Minimum: 1. Maximum: 9007199254740991. |
| `result.data.opportunitiesPreview.data[].listName` | `string` | Yes | — | — |
| `result.data.opportunitiesPreview.data[].isRestricted` | `boolean` | Yes | — | — |
| `result.data.opportunitiesPreview.data[].isRedacted` | `boolean` | Yes | — | — |
| `result.data.opportunitiesPreview.totalCount` | `integer` | No | — | Format: `int64`. Minimum: 0. Maximum: 9007199254740991. |
| `result.data.personsPreview` | `object` | No | — | — |
| `result.data.personsPreview.data` | `array` | No | — | Maximum items: 100. |
| `result.data.personsPreview.data[].id` | `integer` | Yes | — | Format: `int64`. Minimum: 1. Maximum: 9007199254740991. |
| `result.data.personsPreview.data[].firstName` | `string \| null` | Yes | — | — |
| `result.data.personsPreview.data[].lastName` | `string \| null` | Yes | — | — |
| `result.data.personsPreview.data[].primaryEmailAddress` | `string \| null` | Yes | — | Format: `email`. |
| `result.data.personsPreview.data[].type` | `"internal" \| "collaborator" \| "external"` | Yes | — | Allowed: `internal`, `collaborator`, `external`. |
| `result.data.personsPreview.totalCount` | `integer` | No | — | Format: `int64`. Minimum: 0. Maximum: 9007199254740991. |
| `result.data.companiesPreview` | `object` | No | — | — |
| `result.data.companiesPreview.data` | `array` | No | — | Maximum items: 100. |
| `result.data.companiesPreview.data[].id` | `integer` | Yes | — | Format: `int64`. Minimum: 1. Maximum: 9007199254740991. |
| `result.data.companiesPreview.data[].name` | `string` | Yes | — | — |
| `result.data.companiesPreview.data[].domain` | `string \| null` | Yes | — | Format: `hostname`. |
| `result.data.companiesPreview.totalCount` | `integer` | No | — | Format: `int64`. Minimum: 0. Maximum: 9007199254740991. |
| `result.data.type` | `"entities" \| "interaction" \| "ai-notetaker" \| "user-reply" \| "ai-notetaker-reply"` | Yes | — | — |
| `result.data.interaction` | `object` | No | — | — |
| `result.data.interaction.id` | `integer` | Yes | — | — |
| `result.data.interaction.type` | `"meeting"` | Yes | — | — |
| `result.data.transcriptId` | `integer` | No | — | — |

The table shows the first 50 fields. Use the live contract below for every field.

<Info>
  This output schema is too large to embed without slowing the page. Get the complete live contract with `deepline tools get affinity_v2_notes_note_id_get --json`.
</Info>

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

* [Affinity provider guide](/docs/providers/affinity/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)


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