Get the engagement list

get

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

Retrieve a paginated list of engagements that match CRM context and filter criteria for a specific user, including basic metadata, ownership, and status suitable for search results and list views.

Query Params

contextType

string

enum

The CRM object's Context type. Supported values: Account | Opportunity | Contact | Lead. Example: contextType=Account

Allowed:

contextId

string

The CRM object's Id in CRM system.

continuation

string

Continuation token for pagination.

limit

integer

required

1 to 100

Defaults to 10

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

engagementTypes

string

enum

Allowed:

from

date-time

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

date-time

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

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Successful response

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error