Get the engagement list V2

get

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

Get the basic information of engagements based on specific conditions.

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

string

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

createdTimeTo

string

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

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

Responses

200Successful response

400Bad Request

500Internal Sever Error