Get the engagement list V2

get

https://api.seismic.com/engagement/v2/engagements

Retrieve a paginated list of engagements that match CRM context, user, and status filters, returning enriched engagement summaries for analytics, navigation, and conversational experiences.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

crmContextType

string

The CRM object's Context type. Supported values: Account. Example: contextType=Account

crmContextId

string

The CRM object's Id in CRM system.

userId

string

The Id of the user who can access the engagements

userPermission

string

enum

The permission of the user who can access the engagements.

Allowed:

queryByContact

string

The contact email of name

engagementTypes

string

Engagement Display Types. Support values: DSR, EmailBlast, Email, Link, Meeting. Separate multiple type values with commas. Example: engagementTypes=Email,Link

engagementStatuses

string

Engagement Status. Support values: Sent, Scheduled, AwaitingApproval, Draft, Canceled, Sending, Processing, PartiallySent, Failed, Occurred, Created. Separate multiple type values with commas. Example: engagementStatuses=Sent,Scheduled

createdTimeFrom

date-time

Filter engagements that created datetime greater than or equals 'from'. UTC Format example:2024-01-19T07:25:05.00Z.

createdTimeTo

date-time

Filter engagements that created datetime less than or equals 'to'. UTC Format example:2024-01-19T07:25:05.00Z.

continuation

string

Continuation token for pagination.

limit

integer

1 to 100

Defaults to 10

The query results' page size. Default is 10. Range from 1 to 100.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Successful response

400Bad Request

500Internal Sever Error