> ## 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 Chat Messages Get > Get metadata on all Chat Messages. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost. 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. ```ts theme={null} 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 ```bash theme={null} 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 |
Show raw input schema ### Input JSON Schema ```json theme={null} { "type": "object", "description": "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` |", "properties": { "cursor": { "type": "string", "description": "Cursor for the next or previous page" }, "limit": { "type": "integer", "description": "Number of items to include in the page", "default": 100, "minimum": 1, "maximum": 100, "format": "int32" }, "filter": { "type": "string", "description": "Filter options" } }, "required": [], "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: `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 | — | — |
Show raw output schema ### Output JSON Schema ```json theme={null} { "type": "object", "properties": { "data": { "type": "object", "properties": { "data": { "type": "array", "maxItems": 100, "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "sentAt": { "type": "string", "format": "date-time" }, "loggingType": { "type": "string", "const": "manual" }, "direction": { "type": "string", "enum": [ "sent", "received" ] }, "creator": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "firstName": { "type": [ "string", "null" ] }, "lastName": { "type": [ "string", "null" ] }, "primaryEmailAddress": { "type": [ "string", "null" ], "format": "email" }, "type": { "type": "string", "enum": [ "internal", "collaborator", "external" ] } }, "required": [ "firstName", "id", "lastName", "primaryEmailAddress", "type" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": [ "string", "null" ], "format": "date-time" }, "participantsPreview": { "type": "object", "properties": { "data": { "type": "array", "maxItems": 100, "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "maximum": 9007199254740991, "format": "int64" }, "firstName": { "type": [ "string", "null" ] }, "lastName": { "type": [ "string", "null" ] }, "primaryEmailAddress": { "type": [ "string", "null" ], "format": "email" }, "type": { "type": "string", "enum": [ "internal", "collaborator", "external" ] } }, "required": [ "firstName", "id", "lastName", "primaryEmailAddress", "type" ], "additionalProperties": false } }, "totalCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "format": "int64" } }, "required": [ "data", "totalCount" ], "additionalProperties": false } }, "required": [ "id", "sentAt", "loggingType", "direction", "creator", "createdAt", "updatedAt", "participantsPreview" ], "additionalProperties": false } }, "pagination": { "type": "object", "properties": { "prevUrl": { "type": [ "string", "null" ], "format": "uri" }, "nextUrl": { "type": [ "string", "null" ], "format": "uri" } }, "additionalProperties": false } }, "required": [ "data", "pagination" ], "additionalProperties": false }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data" ], "additionalProperties": false } ```
## 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)