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

# Outreach: List Events

> List Outreach engagement events, such as email opens, clicks, and replies. Includes SDK V2 examples, input constraints, response fields, and Deepline cost.

List Outreach engagement events, such as email opens, clicks, and replies.

> [!NOTE]
>
> Tool ID: `outreach_list_events`

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

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'outreach_list_events',
  {
    "newFilterSyntax": true,
    "page_size": 123,
    "page_after": "cursor_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute outreach_list_events --input '{
  "newFilterSyntax": true,
  "page_size": 123,
  "page_after": "cursor_123"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "data": [
      {
        "attributes": {
          "body": "Example message",
          "createdAt": "2026-01-15T12:00:00Z",
          "eventAt": "2026-01-15T12:00:00Z"
        },
        "id": 123,
        "relationships": {
          "account": {},
          "call": {},
          "mailing": {}
        }
      }
    ]
  }
}
```

Use `deepline describe outreach_list_events --json` for the latest machine-readable contract.

## Input reference

Get a Collection of Events

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.newFilterSyntax` | `boolean` | No | — | Use Outreach array/range filter syntax for literal commas and ranges. |
| `payload.page_size` | `integer` | No | — | Cursor page size sent as page\[size]. Minimum: 1. Maximum: 1000. |
| `payload.page_after` | `string` | No | — | Cursor returned by the previous page. |
| `payload.page_before` | `string` | No | — | Cursor returned by the next page. |
| `payload.page_limit` | `integer` | No | — | Deprecated offset-pagination limit sent as page\[limit]. Prefer page\_size. Minimum: 1. Maximum: 1000. |
| `payload.page_offset` | `integer` | No | — | Deprecated offset-pagination offset sent as page\[offset]. Prefer cursors. Minimum: 0. Maximum: 10000. |
| `payload.count` | `boolean` | No | — | Request Outreach total-count metadata. false is faster for pagination. |
| `payload.sort` | `string` | No | — | Comma-separated sortable fields. prefix a field with - for descending order. |
| `payload.include` | `string` | No | — | Comma-separated related resources to include. |
| `payload.fields` | `object` | No | — | Sparse fieldsets keyed by JSON:API resource type, sent as fields\[resource]. |
| `payload.filters` | `object` | No | — | Endpoint-specific Outreach filters. Relationship attributes use keys such as owner\[id]. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Get a Collection of Events",
    "properties": {
      "newFilterSyntax": {
        "type": "boolean",
        "description": "Use Outreach array/range filter syntax for literal commas and ranges."
      },
      "page_size": {
        "type": "integer",
        "description": "Cursor page size sent as page[size].",
        "minimum": 1,
        "maximum": 1000
      },
      "page_after": {
        "type": "string",
        "description": "Cursor returned by the previous page."
      },
      "page_before": {
        "type": "string",
        "description": "Cursor returned by the next page."
      },
      "page_limit": {
        "type": "integer",
        "description": "Deprecated offset-pagination limit sent as page[limit]. Prefer page_size.",
        "minimum": 1,
        "maximum": 1000
      },
      "page_offset": {
        "type": "integer",
        "description": "Deprecated offset-pagination offset sent as page[offset]. Prefer cursors.",
        "minimum": 0,
        "maximum": 10000
      },
      "count": {
        "type": "boolean",
        "description": "Request Outreach total-count metadata; false is faster for pagination."
      },
      "sort": {
        "type": "string",
        "description": "Comma-separated sortable fields; prefix a field with - for descending order."
      },
      "include": {
        "type": "string",
        "description": "Comma-separated related resources to include."
      },
      "fields": {
        "type": "object",
        "description": "Sparse fieldsets keyed by JSON:API resource type, sent as fields[resource].",
        "properties": {
          "account": {
            "type": "string"
          },
          "accountNote": {
            "type": "string"
          },
          "auditLog": {
            "type": "string"
          },
          "batch": {
            "type": "string"
          },
          "batchItem": {
            "type": "string"
          },
          "call": {
            "type": "string"
          },
          "callDisposition": {
            "type": "string"
          },
          "callPurpose": {
            "type": "string"
          },
          "complianceRequest": {
            "type": "string"
          },
          "contentCategory": {
            "type": "string"
          },
          "contentCategoryMembership": {
            "type": "string"
          },
          "contentCategoryOwnership": {
            "type": "string"
          },
          "customDuty": {
            "type": "string"
          },
          "duty": {
            "type": "string"
          },
          "emailAddress": {
            "type": "string"
          },
          "event": {
            "type": "string"
          },
          "favorite": {
            "type": "string"
          },
          "import": {
            "type": "string"
          },
          "kaiaRecording": {
            "type": "string"
          },
          "kaiaVoiceImport": {
            "type": "string"
          },
          "mailAlias": {
            "type": "string"
          },
          "mailbox": {
            "type": "string"
          },
          "mailing": {
            "type": "string"
          },
          "opportunity": {
            "type": "string"
          },
          "opportunityProspectRole": {
            "type": "string"
          },
          "opportunityStage": {
            "type": "string"
          },
          "orgSetting": {
            "type": "string"
          },
          "persona": {
            "type": "string"
          },
          "phoneNumber": {
            "type": "string"
          },
          "product": {
            "type": "string"
          },
          "profile": {
            "type": "string"
          },
          "prospect": {
            "type": "string"
          },
          "prospectNote": {
            "type": "string"
          },
          "purchase": {
            "type": "string"
          },
          "recipient": {
            "type": "string"
          },
          "role": {
            "type": "string"
          },
          "ruleset": {
            "type": "string"
          },
          "sequence": {
            "type": "string"
          },
          "sequenceState": {
            "type": "string"
          },
          "sequenceStep": {
            "type": "string"
          },
          "sequenceTemplate": {
            "type": "string"
          },
          "snippet": {
            "type": "string"
          },
          "stage": {
            "type": "string"
          },
          "task": {
            "type": "string"
          },
          "taskDisposition": {
            "type": "string"
          },
          "taskPriority": {
            "type": "string"
          },
          "taskPurpose": {
            "type": "string"
          },
          "team": {
            "type": "string"
          },
          "template": {
            "type": "string"
          },
          "user": {
            "type": "string"
          },
          "webhook": {
            "type": "string"
          }
        },
        "additionalProperties": false
      },
      "filters": {
        "type": "object",
        "description": "Endpoint-specific Outreach filters. Relationship attributes use keys such as owner[id].",
        "additionalProperties": false
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.data` | `array` | No | — | — |
| `result.data.data[].attributes` | `object` | No | — | Application events, capturing details around the initiator, recipient, etc. |
| `result.data.data[].attributes.body` | `string \| null` | No | — | The event body (for external events only) |
| `result.data.data[].attributes.createdAt` | `string \| null` | No | — | The date and time the event was created. Format: `date-time`. |
| `result.data.data[].attributes.eventAt` | `string \| null` | No | — | The date and time the event occurred. Format: `date-time`. |
| `result.data.data[].attributes.externalUrl` | `string \| null` | No | — | The external URL associated with this event (for external events only) |
| `result.data.data[].attributes.name` | `string \| null` | No | — | The name of the event that took place (e.g. "mailbox\_created"). Maximum length: 255. |
| `result.data.data[].attributes.payload` | `object \| null` | No | — | The transmitted data for the event (cannot be updated once an event has been created) |
| `result.data.data[].attributes.requestCity` | `string \| null` | No | — | The city where the request that created the event was made. Maximum length: 255. |
| `result.data.data[].attributes.requestDevice` | `string \| null` | No | — | The type of device on which the request that created the event was made. Maximum length: 255. |
| `result.data.data[].attributes.requestHost` | `string \| null` | No | — | Name of the host from which the request was made. Maximum length: 255. |
| `result.data.data[].attributes.requestProxied` | `boolean \| null` | No | — | A boolean value whether the request was proxied. For example, when true the request city refers to the location of the email server and not the prospect. |
| `result.data.data[].attributes.requestRegion` | `string \| null` | No | — | Name of the region from which the request was made. Maximum length: 255. |
| `result.data.data[].id` | `integer` | No | — | — |
| `result.data.data[].relationships` | `object` | No | — | — |
| `result.data.data[].relationships.account` | `object` | No | — | The account associated with this event. You can use only the attribute id to filter events by account (e.g. filter\[account]\[id]=X). |
| `result.data.data[].relationships.account.data` | `object \| null` | No | — | — |
| `result.data.data[].relationships.account.data.id` | `integer` | No | — | — |
| `result.data.data[].relationships.account.data.type` | `"account"` | No | — | Allowed: `account`. |
| `result.data.data[].relationships.account.links` | `object` | No | — | — |
| `result.data.data[].relationships.account.links.related` | `string` | No | — | Format: `uri`. |
| `result.data.data[].relationships.call` | `object` | No | — | The call associated with this event. You can use only the attribute id to filter events by call (e.g. filter\[call]\[id]=X). |
| `result.data.data[].relationships.call.data` | `object \| null` | No | — | — |
| `result.data.data[].relationships.call.data.id` | `integer` | No | — | — |
| `result.data.data[].relationships.call.data.type` | `"call"` | No | — | Allowed: `call`. |
| `result.data.data[].relationships.call.links` | `object` | No | — | — |
| `result.data.data[].relationships.call.links.related` | `string` | No | — | Format: `uri`. |
| `result.data.data[].relationships.mailing` | `object` | No | — | The mailing associated with this event. You can use only the attribute id to filter events by mailing (e.g. filter\[mailing]\[id]=X). |
| `result.data.data[].relationships.mailing.data` | `object \| null` | No | — | — |
| `result.data.data[].relationships.mailing.data.id` | `integer` | No | — | — |
| `result.data.data[].relationships.mailing.data.type` | `"mailing"` | No | — | Allowed: `mailing`. |
| `result.data.data[].relationships.mailing.links` | `object` | No | — | — |
| `result.data.data[].relationships.mailing.links.related` | `string` | No | — | Format: `uri`. |
| `result.data.data[].relationships.note` | `object` | No | — | The note associated with this event. |
| `result.data.data[].relationships.note.data` | `object \| null` | No | — | — |
| `result.data.data[].relationships.note.data.id` | `integer` | No | — | — |
| `result.data.data[].relationships.note.data.type` | `"note"` | No | — | Allowed: `note`. |
| `result.data.data[].relationships.note.links` | `object` | No | — | — |
| `result.data.data[].relationships.note.links.related` | `string` | No | — | Format: `uri`. |
| `result.data.data[].relationships.opportunity` | `object` | No | — | The opportunity associated with this event. You can use only the attribute id to filter events by opportunity (e.g. filter\[opportunity]\[id]=X). |
| `result.data.data[].relationships.opportunity.data` | `object \| null` | No | — | — |
| `result.data.data[].relationships.opportunity.data.id` | `integer` | No | — | — |
| `result.data.data[].relationships.opportunity.data.type` | `"opportunity"` | No | — | Allowed: `opportunity`. |
| `result.data.data[].relationships.opportunity.links` | `object` | No | — | — |
| `result.data.data[].relationships.opportunity.links.related` | `string` | No | — | Format: `uri`. |
| `result.data.data[].relationships.plugin` | `object` | No | — | The plugin associated with this event. |
| `result.data.data[].relationships.plugin.data` | `object \| null` | No | — | — |
| `result.data.data[].relationships.plugin.data.id` | `integer` | No | — | — |
| `result.data.data[].relationships.plugin.data.type` | `"plugin"` | No | — | Allowed: `plugin`. |

The table shows the first 50 fields. Expand the raw schema below for every field.

> [!NOTE]
>
> This output schema is too large for an inline display. Read the complete live contract with `deepline describe outreach_list_events --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

* [Outreach provider guide](https://deepline.com/docs/providers/outreach/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.