Affinity: V2 Companies Company ID Notes Get

Get Notes for a Company.

Tool ID: affinity_v2_companies_company_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.

import { Deepline } from 'deepline';

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

console.log(result.toolResponse.raw);

CLI

deepline tools execute affinity_v2_companies_company_id_notes_get --input '{
  "companyId": 123
}' --json

Example response

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

Input reference

Returns relevant notes for a given company which includes directly attached notes and notes attached to persons on this company. 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.companyId`	`integer`	Yes	—	Company’s 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

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

Getting Started

GTM is code

Features

Deepline SDK beta

Integrations

API Reference

Affinity: V2 Companies Company ID Notes Get

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation