Affinity: V2 Chat Messages Get

Get metadata on all Chat Messages.

Tool ID: affinity_v2_chat_messages_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_chat_messages_get',
  {
    "cursor": "cursor_123",
    "limit": 100,
    "filter": "example"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute affinity_v2_chat_messages_get --input '{
  "cursor": "cursor_123",
  "limit": 100,
  "filter": "example"
}' --json

Example response

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

Input reference

Paginate through all chat messages in Affinity. Returns basic information about the chat message interaction and its participants. Will only return chat messages that the current authenticated user has permission to see. You can filter chat messages 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 | |---|---|---|---| | id | int64 | = | id=1\\|id=2\\|id=3 | | sentAt | datetime | >, =, 2025-01-01T01:00:00Z | | createdAt | datetime | >, =, , =, =2025-01-01T01:00:00Z |

Name	Type	Required	Default	Details
`payload.cursor`	`string`	No	—	Cursor for the next or previous page
`payload.limit`	`integer`	No	`100`	Number of items to include in the page Format: `int32`. Minimum: 1. Maximum: 100.
`payload.filter`	`string`	No	—	Filter options

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: `int64`. Minimum: 1. Maximum: 9007199254740991.
`result.data.data[].sentAt`	`string`	Yes	—	Format: `date-time`.
`result.data.data[].loggingType`	`"manual"`	Yes	—	—
`result.data.data[].direction`	`"sent" \| "received"`	Yes	—	Allowed: `sent`, `received`.
`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[].createdAt`	`string`	Yes	—	Format: `date-time`.
`result.data.data[].updatedAt`	`string \| null`	Yes	—	Format: `date-time`.
`result.data.data[].participantsPreview`	`object`	Yes	—	—
`result.data.data[].participantsPreview.data`	`array`	Yes	—	Maximum items: 100.
`result.data.data[].participantsPreview.data[].id`	`integer`	Yes	—	Format: `int64`. Minimum: 1. Maximum: 9007199254740991.
`result.data.data[].participantsPreview.data[].firstName`	`string \| null`	Yes	—	—
`result.data.data[].participantsPreview.data[].lastName`	`string \| null`	Yes	—	—
`result.data.data[].participantsPreview.data[].primaryEmailAddress`	`string \| null`	Yes	—	Format: `email`.
`result.data.data[].participantsPreview.data[].type`	`"internal" \| "collaborator" \| "external"`	Yes	—	Allowed: `internal`, `collaborator`, `external`.
`result.data.data[].participantsPreview.totalCount`	`integer`	Yes	—	Format: `int64`. Minimum: 0. Maximum: 9007199254740991.
`result.data.pagination`	`object`	Yes	—	—
`result.data.pagination.prevUrl`	`string \| null`	No	—	Format: `uri`.
`result.data.pagination.nextUrl`	`string \| null`	No	—	Format: `uri`.
`result.meta`	`object`	No	—	—

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 Chat Messages 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