Get a Engagement By Id

get

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

Retrieves the details of a specific engagement by its id.

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

Supported Apps

Apps supported via API

Salesforce (salesforce)

Supported Request Fields:

engagementId - Required
type - Required
additionalFields

Supported Response Fields:

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

Zoho CRM (zoho-crm)

Supported Request Fields:

engagementId - Required
type - Required

Supported Response Fields:

engagement.info.id
engagement.info.content
engagement.info.subject
engagement.info.direction
engagement.info.owner.id
engagement.info.owner.email
engagement.info.startDateTime
engagement.info.endDateTime
engagement.info.status
engagement.type.type
engagement.type.name
engagement.deals
engagement.customFields

Hubspot (hubspot)

Supported Request Fields:

engagementId - Required
type - Required
additionalFields

Supported Response Fields:

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

Brevo CRM (brevo)

Supported Request Fields:

engagementId - Required
type - Required

Supported Response Fields:

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

Zendesk CRM (zendesk-crm)

Supported Request Fields:

engagementId - Required
type - Required

Supported Response Fields:

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

Sugar CRM (sugar-crm)

Supported Request Fields:

engagementId - Required
type - Required

Supported Response Fields:

engagement.info.id
engagement.info.content
engagement.info.subject
engagement.info.direction
engagement.info.owner.id
engagement.info.startDateTime
engagement.info.endDateTime
engagement.info.status
engagement.info.url
engagement.type.type
engagement.type.name
engagement.accounts
engagement.contacts
engagement.leads
engagement.deals

Close CRM (close-crm)

Supported Request Fields:

engagementId - Required
type - Required

Supported Response Fields:

engagement.info.id
engagement.info.content
engagement.info.subject
engagement.info.direction
engagement.info.owner.id
engagement.info.startDateTime
engagement.info.status
engagement.type.type
engagement.type.name
engagement.accounts
engagement.contacts
engagement.customFields

Pipedrive (pipedrive)

Supported Request Fields:

engagementId - Required

Supported Response Fields:

engagement.info.id
engagement.info.content
engagement.info.subject
engagement.info.direction
engagement.info.status
engagement.type.type
engagement.type.name
engagement.accounts
engagement.contacts

Pipeline CRM (pipelinecrm)

Attio (attio)

Supported Request Fields:

type - Required - one of NOTE, TASK, MEETING
engagementId - Required

Supported Response Fields:

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

Microsoft Dynamics 365 Sales (msd-365-sales)

Supported Request Fields:

type - Required - one of NOTE, TASK, MEETING, CALL, EMAIL
engagementId - Required

Supported Response Fields:

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

Apps supported via Webhook (API Support coming soon)

Salesflare (salesflare)

Responses

Language

Credentials

Loading…

Response

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

application/json