List Engagements

get

https://api.getknit.dev/v1.0/crm.engagement.list

List engagement in a paginated format with details such as id, content, subject etc.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

type

string

enum

required

Type of Engagement

pageToken

string

originData

boolean

Defaults to false

createdAfter

date-time

Filters engagements which were created after the specified datetime. The datetime must be provided in ISO 8601 UTC format (yyyy-MM-dd'T'HH:mm:ss'Z').

createdBefore

date-time

Filters engagements which were created before the specified datetime. The datetime must be provided in ISO 8601 UTC format (yyyy-MM-dd'T'HH:mm:ss'Z').

updatedAfter

date-time

Filters engagements which were updated after the specified datetime. The datetime must be provided in ISO 8601 UTC format (yyyy-MM-dd'T'HH:mm:ss'Z').

updatedBefore

string

Filters engagements which were updated before the specified datetime. The datetime must be provided in ISO 8601 UTC format (yyyy-MM-dd'T'HH:mm:ss'Z').

accountId

string

Filters engagements by one or more account Ids. Supports multiple values as a comma-separated list. (e.g., accountId=24,18,25).

contactId

string

Filters engagements by one or more contact Ids. Supports multiple values as a comma-separated list. (e.g., contactId=24,18,25).

dealId

string

Filters engagements by one or more deal Ids. Supports multiple values as a comma-separated list. (e.g., dealId=24,18,25).

leadId

string

Filters engagements by one or more lead Ids. Supports multiple values as a comma-separated list. (e.g., leadId=24,18,25).

direction

string

Filters engagements by one or more direction(s). Supports multiple values as a comma-separated list. (e.g., direction=INBOND,OUTBOND).

status

string

Filters engagements by one or more status. Supports multiple values as a comma-separated list. (e.g., status=COMPLETED,CANCELLED).

Responses

Language

Credentials

Loading…

Response

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

application/json

200

400Bad Request