> ## 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 Persons Person ID Notes Get > Get Notes for a Person. Affinity V2 Persons Person Id Notes Get reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline. Get Notes for a Person. Tool ID: `affinity_v2_persons_person_id_notes_get` ## 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_persons_person_id_notes_get', { "personId": 123 }, ); console.log(result.toolResponse.raw); ``` ### CLI ```bash theme={null} deepline tools execute affinity_v2_persons_person_id_notes_get --input '{ "personId": 123 }' --json ``` ## Example response The static output schema is not detailed enough to generate a reliable example. Use `deepline tools get affinity_v2_persons_person_id_notes_get --json` for the complete live contract. ## Input reference Returns notes for a given person id which includes directly attached notes, notes on meetings this person attended, and notes where this person is mentioned. You can filter notes using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties. | **Property Name** | **Type** | **Allowed Operators** | **Examples** | |---|---|---|---| | `creator.id` | `int32` | `=` | `creator.id=1` | | `createdAt` | `datetime` | `>`, ` =`, ` `, ` =`, ` =2025-02-03T10:48:24Z` | | Name | Type | Required | Default | Details | | -------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------- | | `payload.personId` | `integer` | Yes | — | Persons ID Format: `int64`. Minimum: 1. Maximum: 9007199254740991. | | `payload.filter` | `string` | No | — | Filter options | | `payload.cursor` | `string` | No | — | Cursor for the next or previous page | | `payload.limit` | `integer` | No | `20` | Number of items to include in the page Format: `int32`. Minimum: 0. Maximum: 100. | | `payload.totalCount` | `boolean` | No | `false` | Include total count of the collection in the pagination response |
Show raw input schema ### Input JSON Schema ```json theme={null} { "type": "object", "description": "Returns notes for a given person id which includes directly attached notes, notes on meetings this person attended, and notes where this person is mentioned. You can filter notes using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties. | **Property Name** | **Type** | **Allowed Operators** | **Examples** | |---|---|---|---| | `creator.id` | `int32` | `=` | `creator.id=1` | | `createdAt` | `datetime` | `>`, ` =`, ` `, ` =`, ` =2025-02-03T10:48:24Z` |", "properties": { "personId": { "type": "integer", "description": "Persons ID", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "filter": { "type": "string", "description": "Filter options" }, "cursor": { "type": "string", "description": "Cursor for the next or previous page" }, "limit": { "type": "integer", "description": "Number of items to include in the page", "default": 20, "minimum": 0, "maximum": 100, "format": "int32" }, "totalCount": { "type": "boolean", "description": "Include total count of the collection in the pagination response", "default": false } }, "required": [ "personId" ], "additionalProperties": false } ```
## Output reference | Name | Type | Required | Default | Details | | -------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -------- | ------- | ------------------------------------------------------- | | `result.data` | `object` | Yes | — | — | | `result.data.data` | `array` | Yes | — | Maximum items: 100. | | `result.data.data[].id` | `integer` | Yes | — | Format: `int32`. Minimum: 1. Maximum: 2147483647. | | `result.data.data[].content` | `object` | Yes | — | — | | `result.data.data[].content.html` | `string \| null` | Yes | — | — | | `result.data.data[].creator` | `object` | Yes | — | — | | `result.data.data[].creator.id` | `integer` | Yes | — | Format: `int64`. Minimum: 1. Maximum: 9007199254740991. | | `result.data.data[].creator.firstName` | `string \| null` | Yes | — | — | | `result.data.data[].creator.lastName` | `string \| null` | Yes | — | — | | `result.data.data[].creator.primaryEmailAddress` | `string \| null` | Yes | — | Format: `email`. | | `result.data.data[].creator.type` | `"internal" \| "collaborator" \| "external"` | Yes | — | Allowed: `internal`, `collaborator`, `external`. | | `result.data.data[].mentions` | `array` | Yes | — | Maximum items: 100. | | `result.data.data[].mentions[].id` | `integer` | Yes | — | Format: `int32`. Minimum: 1. Maximum: 2147483647. | | `result.data.data[].mentions[].type` | `"person"` | Yes | — | — | | `result.data.data[].mentions[].person` | `object` | Yes | — | — | | `result.data.data[].mentions[].person.id` | `integer` | Yes | — | Format: `int64`. Minimum: 1. Maximum: 9007199254740991. | | `result.data.data[].mentions[].person.firstName` | `string \| null` | Yes | — | — | | `result.data.data[].mentions[].person.lastName` | `string \| null` | Yes | — | — | | `result.data.data[].mentions[].person.primaryEmailAddress` | `string \| null` | Yes | — | Format: `email`. | | `result.data.data[].mentions[].person.type` | `"internal" \| "collaborator" \| "external"` | Yes | — | Allowed: `internal`, `collaborator`, `external`. | | `result.data.data[].createdAt` | `string` | Yes | — | Format: `date-time`. | | `result.data.data[].updatedAt` | `string \| null` | Yes | — | Format: `date-time`. | | `result.data.data[].repliesCount` | `integer` | No | — | Format: `int32`. Minimum: 0. Maximum: 2147483647. | | `result.data.data[].opportunitiesPreview` | `object` | No | — | — | | `result.data.data[].opportunitiesPreview.data` | `array` | No | — | Maximum items: 100. | | `result.data.data[].opportunitiesPreview.data[].id` | `integer` | Yes | — | Format: `int64`. Minimum: 1. Maximum: 9007199254740991. | | `result.data.data[].opportunitiesPreview.data[].name` | `string` | Yes | — | — | | `result.data.data[].opportunitiesPreview.data[].listId` | `integer` | Yes | — | Format: `int64`. Minimum: 1. Maximum: 9007199254740991. | | `result.data.data[].opportunitiesPreview.data[].listName` | `string` | Yes | — | — | | `result.data.data[].opportunitiesPreview.data[].isRestricted` | `boolean` | Yes | — | — | | `result.data.data[].opportunitiesPreview.data[].isRedacted` | `boolean` | Yes | — | — | | `result.data.data[].opportunitiesPreview.totalCount` | `integer` | No | — | Format: `int64`. Minimum: 0. Maximum: 9007199254740991. | | `result.data.data[].personsPreview` | `object` | No | — | — | | `result.data.data[].personsPreview.data` | `array` | No | — | Maximum items: 100. | | `result.data.data[].personsPreview.data[].id` | `integer` | Yes | — | Format: `int64`. Minimum: 1. Maximum: 9007199254740991. | | `result.data.data[].personsPreview.data[].firstName` | `string \| null` | Yes | — | — | | `result.data.data[].personsPreview.data[].lastName` | `string \| null` | Yes | — | — | | `result.data.data[].personsPreview.data[].primaryEmailAddress` | `string \| null` | Yes | — | Format: `email`. | | `result.data.data[].personsPreview.data[].type` | `"internal" \| "collaborator" \| "external"` | Yes | — | Allowed: `internal`, `collaborator`, `external`. | | `result.data.data[].personsPreview.totalCount` | `integer` | No | — | Format: `int64`. Minimum: 0. Maximum: 9007199254740991. | | `result.data.data[].companiesPreview` | `object` | No | — | — | | `result.data.data[].companiesPreview.data` | `array` | No | — | Maximum items: 100. | | `result.data.data[].companiesPreview.data[].id` | `integer` | Yes | — | Format: `int64`. Minimum: 1. Maximum: 9007199254740991. | | `result.data.data[].companiesPreview.data[].name` | `string` | Yes | — | — | | `result.data.data[].companiesPreview.data[].domain` | `string \| null` | Yes | — | Format: `hostname`. | | `result.data.data[].companiesPreview.totalCount` | `integer` | No | — | Format: `int64`. Minimum: 0. Maximum: 9007199254740991. | | `result.data.data[].type` | `"entities" \| "interaction" \| "ai-notetaker" \| "user-reply" \| "ai-notetaker-reply"` | Yes | — | — | | `result.data.data[].interaction` | `object` | No | — | — | | `result.data.data[].interaction.id` | `integer` | Yes | — | — | | `result.data.data[].interaction.type` | `"meeting"` | Yes | — | — | The table shows the first 50 fields. Use the live contract below for every field. This output schema is too large to embed without slowing the page. Get the complete live contract with `deepline tools get affinity_v2_persons_person_id_notes_get --json`. ## 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)