Unified API Reference
DashboardSignup For Free

Get Engagements Batch

post
https://api.getknit.dev/v1.0/crm.engagement.batch.get

Retrieve a batch of engagements by ID, with optional filtering params.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

📘

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

Salesforce (salesforce)

Supported Request Fields:

  • engagementIds - Required
  • 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:

  • engagementIds - Required
  • 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:

  • engagementIds - Required
  • 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
Microsoft Dynamics 365 Sales (msd-365-sales)

Supported Request Fields:

  • engagementIds - Required
  • 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
📘

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

Note: To ensure optimal performance and reliability, we recommend limiting each request to a maximum of 100 IDs. Requests with a larger number of IDs may experience degraded performance or intermittent errors — if you need to fetch more, please split your list into batches of 100 or fewer.

Body Params
engagementIds
array of strings
required
engagementIds*
string
enum
required

Type of Engagement

string
string
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').

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').

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').

date-time

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
array of strings

Filters engagements by one or more account Ids. Supports multiple values as list of string.

accountId
contactId
array of strings

Filters engagements by one or more contact Ids. Supports multiple values as list of string.

contactId
dealId
array of strings

Filters engagements by one or more deal Ids. Supports multiple values as list of string.

dealId
leadId
array of strings

Filters engagements by one or more lead Ids. Supports multiple values as list of string.

leadId
direction
array of strings

Filters engagements by one or more direction(s). Supports multiple values as list of string.

direction
status
array of strings

Filters engagements by one or more status. Supports multiple values as list of string.

status
Responses

Updated about 2 hours ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 hours ago

Did this page help you?