Tool ID:
outreach_list_eventsRun this action
Use the TypeScript SDK for a single call. Putctx.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(
'outreach_list_events',
{
"newFilterSyntax": true,
"page_size": 123,
"page_after": "cursor_123"
},
);
console.log(result.toolResponse.raw);
CLI
deepline tools execute outreach_list_events --input '{
"newFilterSyntax": true,
"page_size": 123,
"page_after": "cursor_123"
}' --json
Example response
The SDK exposes this shape atresult.toolResponse.raw. Values below are representative.
{
"data": {
"data": [
{
"attributes": {
"body": "Example message",
"createdAt": "2026-01-15T12:00:00Z",
"eventAt": "2026-01-15T12:00:00Z"
},
"id": 123,
"relationships": {
"account": {},
"call": {},
"mailing": {}
}
}
]
}
}
deepline tools get 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]. |
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. |
This output schema is too large to embed without slowing the page. Get the complete live contract with
deepline tools get outreach_list_events --json.Deepline cost
- Pricing model:
fixed(per call). - Estimated Deepline credits:
0per pricing unit. - Provider-native pricing may still exist outside Deepline credit billing.