Affinity: V2 Emails Get

List emails logged in Affinity with their subject, participants and timestamps, but not the message body.

Tool ID: affinity_v2_emails_get

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'affinity_v2_emails_get',
  {
    "cursor": "cursor_123",
    "limit": 100,
    "filter": "example"
  },
);

console.log(result.toolResponse.raw);

CLI

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

Example response

The static output schema lacks the details for a reliable example. Use deepline describe affinity_v2_emails_get --json for the complete live contract.

Input reference

Paginate through all emails in Affinity. Returns basic information about the email interaction and its participants. Will only return emails or subject lines that the current authenticated user has permission to see. Email bodies (the message content) are not available through the API. Only metadata such as the subject, participants, and timestamps is returned. If the authenticated user does not have permission to see an email’s subject, the subject field is obfuscated and returned as ******** rather than the actual subject line. You can filter emails 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 | | See the live schema below for the complete notes.

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`	`"automated"`	Yes	—	—
`result.data.data[].direction`	`"sent" \| "received"`	Yes	—	Allowed: `sent`, `received`.
`result.data.data[].subject`	`string \| null`	Yes	—	—
`result.data.data[].createdAt`	`string`	Yes	—	Format: `date-time`.
`result.data.data[].updatedAt`	`string \| null`	Yes	—	Format: `date-time`.
`result.data.data[].from`	`object`	Yes	—	—
`result.data.data[].from.emailAddress`	`string \| null`	Yes	—	Format: `email`.
`result.data.data[].from.person`	`record`	Yes	—	—
`result.data.data[].toParticipantsPreview`	`object`	Yes	—	—
`result.data.data[].toParticipantsPreview.data`	`array`	Yes	—	Maximum items: 100.
`result.data.data[].toParticipantsPreview.data[].emailAddress`	`string \| null`	Yes	—	Format: `email`.
`result.data.data[].toParticipantsPreview.data[].person`	`record`	Yes	—	—
`result.data.data[].toParticipantsPreview.totalCount`	`integer`	Yes	—	Format: `int64`. Minimum: 0. Maximum: 9007199254740991.
`result.data.data[].ccParticipantsPreview`	`object`	Yes	—	—
`result.data.data[].ccParticipantsPreview.data`	`array`	Yes	—	Maximum items: 100.
`result.data.data[].ccParticipantsPreview.data[].emailAddress`	`string \| null`	Yes	—	Format: `email`.
`result.data.data[].ccParticipantsPreview.data[].person`	`record`	Yes	—	—
`result.data.data[].ccParticipantsPreview.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.

​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