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

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
For schema of Engagement object refer - Engagement Data Model
This API may not return all fields defined in the response schema; for additional details, use the Get Engagement by Id API.

Supported Apps

Apps supported via API

Salesforce (salesforce)

Supported Request Fields:

type - Required
createdAfter
createdBefore
updatedAfter
updatedBefore
accountId
contactId
dealId
leadId
direction
status
type
pageToken
originData

Supported Response Fields:

engagements.info.id
engagements.info.content
engagements.info.subject
engagements.info.direction
engagements.info.owner.id
engagements.info.owner.email
engagements.info.startDateTime
engagements.info.endDateTime
engagements.info.status
engagements.type.id
engagements.type.type
engagements.type.name
engagements.accounts
engagements.contacts
engagements.leads
engagements.deals
engagements.customFields
nextPageToken

Zoho CRM (zoho-crm)

Supported Request Fields:

type - Required
createdAfter
createdBefore
updatedAfter
updatedBefore
direction
contactId
leadId
accountId
dealId
pageToken
originData

Supported Response Fields:

engagements.info.id
engagements.info.content
engagements.info.subject
engagements.info.direction
engagements.info.owner.id
engagements.info.owner.email
engagements.info.startDateTime
engagements.info.endDateTime
engagements.info.status
engagements.type.type
engagements.type.name
engagements.deals
nextPageToken

Hubspot (hubspot)

Supported Request Fields:

type - Required
createdAfter
createdBefore
updatedAfter
updatedBefore
accountId
contactId
dealId
direction
status
pageSize
pageToken
originData

Supported Response Fields:

engagements.info.id
engagements.info.content
engagements.info.subject
engagements.info.direction
engagements.info.owner.id
engagements.info.owner.email
engagements.info.startDateTime
engagements.info.endDateTime
engagements.info.status
engagements.info.url
engagements.type.id
engagements.type.type
engagements.type.name
engagements.accounts
engagements.contacts
engagements.deals
engagements.customFields
nextPageToken

Brevo CRM (brevo)

Supported Request Fields:

contactId
accountId
dealId
status
pageToken
type - Required
originData

Supported Response Fields:

engagements.info.id
engagements.info.content
engagements.info.subject
engagements.info.direction
engagements.info.owner.id
engagements.info.owner.email
engagements.info.startDateTime
engagements.info.status
engagements.type.id
engagements.type.type
engagements.type.name
engagements.accounts
engagements.contacts
engagements.deals
nextPageToken

Zendesk CRM (zendesk-crm)

Supported Request Fields:

type - Required
createdAfter
createdBefore
updatedAfter
updatedBefore
accountId
contactId
leadId
dealId
pageToken
originData

Supported Response Fields:

engagements.info.id
engagements.info.content
engagements.info.direction
engagements.info.owner.id
engagements.info.owner.email
engagements.info.startDateTime
engagements.info.endDateTime
engagements.info.url
engagements.type.type
engagements.type.name
engagements.contacts
engagements.leads
engagements.deals
engagements.customFields
nextPageToken

Sugar CRM (sugar-crm)

Supported Request Fields:

type - Required
createdAfter
createdBefore
updatedAfter
updatedBefore
direction
status
pageToken
originData

Supported Response Fields:

engagements.info.id
engagements.info.content
engagements.info.subject
engagements.info.direction
engagements.info.owner.id
engagements.info.startDateTime
engagements.info.endDateTime
engagements.info.status
engagements.info.url
engagements.type.type
engagements.type.name
nextPageToken

Close CRM (close-crm)

Supported Request Fields:

type - Required
createdAfter
createdBefore
updatedAfter
updatedBefore
accountId
contactId
direction
pageToken
originData

Supported Response Fields:

engagements.info.id
engagements.info.content
engagements.info.subject
engagements.info.direction
engagements.info.owner.id
engagements.info.startDateTime
engagements.type.type
engagements.type.name
engagements.accounts
engagements.contacts
engagements.customFields
nextPageToken

Pipedrive (pipedrive)

Supported Request Fields:

updatedAfter
updatedBefore
dealId
leadId
contactId
accountId
pageToken
originData

Supported Response Fields:

engagements.info.id
engagements.info.content
engagements.info.subject
engagements.info.direction
engagements.info.status
engagements.type.type
engagements.type.name
engagements.accounts
engagements.contacts
nextPageToken

Pipeline CRM (pipelinecrm)

Attio (attio)

Supported Request Fields:

type - Required - one of NOTE, TASK, MEETING
accountId
contactId
dealId
status (only supported for TASK, supported values COMPLETED)
pageToken
originData

Supported Response Fields:

engagements.info.id
engagements.info.content
engagements.info.subject
engagements.info.owner.id
engagements.info.owner.email
engagements.info.startDateTime - only supported for type MEETING
engagements.info.endDateTime - only supported for type MEETING
engagements.info.status - only supported for type TASK - one of COMPLETED or NOT_SPECIFIED
engagements.type.type
engagements.type.name
engagements.accounts
engagements.contacts
engagements.deals
nextPageToken

Microsoft Dynamics 365 Sales (msd-365-sales)

Supported Request Fields:

type - Required - one of NOTE, TASK, MEETING, CALL, EMAIL
createdAfter
createdBefore
updatedAfter
updatedBefore
status - one of IN_PROGRESS, COMPLETED, CANCELLED, NOT_STARTED
direction - one of INBOUND, OUTBOUND
pageToken
originData

Supported Response Fields:

engagements.info.id
engagements.info.content
engagements.info.subject
engagements.info.direction
engagements.info.owner.id
engagements.info.owner.email
engagements.info.startDateTime
engagements.info.endDateTime
engagements.info.status
engagements.type.type
engagements.type.name
nextPageToken

Apps supported via Webhook (API Support coming soon)

Salesflare (salesflare)

📘
To see the list of supported filters for an app, refer - CRM List Engagements Filter Support Matrix

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