API Reference
DashboardSignup For Free

Get a Deal By Id

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

Retrieves the details of a specific deal by its id.

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

📘

For schema of deal object refer - Deal Data Model

Supported Apps

Apps supported via API

Salesforce (salesforce)

Supported Request Fields:

  • dealId - Required
  • additionalFields

Supported Response Fields:

  • deal.info.id
  • deal.info.name
  • deal.info.description
  • deal.info.amount
  • deal.info.currency
  • deal.info.owner.id
  • deal.info.owner.email
  • deal.info.createdBy.id
  • deal.info.createdBy.email
  • deal.info.status
  • deal.info.createdAt
  • deal.info.lastActivityAt
  • deal.stage.stageId
  • deal.stage.stageName
  • deal.accounts
  • deal.contacts
  • deal.customFields
Hubspot (hubspot)

Supported Request Fields:

  • dealId - Required
  • additionalFields

Supported Response Fields:

  • deal.info.id
  • deal.info.name
  • deal.info.description
  • deal.info.amount
  • deal.info.currency
  • deal.info.owner.id
  • deal.info.owner.email
  • deal.info.createdBy.id
  • deal.info.createdBy.email
  • deal.info.status
  • deal.info.createdAt
  • deal.info.lastActivityAt
  • deal.stage.stageId
  • deal.stage.stageName
  • deal.stage.pipelineId
  • deal.stage.pipelineName
  • deal.accounts
  • deal.contacts
  • deal.customFields
Zoho CRM (zoho-crm)

Supported Request Fields:

  • dealId - Required

Supported Response Fields:

  • deal.info.id
  • deal.info.name
  • deal.info.description
  • deal.info.amount
  • deal.info.owner.id
  • deal.info.owner.email
  • deal.info.createdBy.id
  • deal.info.createdBy.email
  • deal.info.status
  • deal.info.createdAt
  • deal.info.lastActivityAt
  • deal.stage.stageName
  • deal.accounts
  • deal.customFields
Freshworks (freshworks)

Supported Request Fields:

  • dealId - Required

Supported Response Fields:

  • deal.info.id
  • deal.info.name
  • deal.info.amount
  • deal.info.owner.id
  • deal.info.createdBy.id
  • deal.info.status
  • deal.info.createdAt
  • deal.info.lastActivityAt
  • deal.stage.stageId
  • deal.stage.pipelineId
  • deal.accounts
  • deal.contacts
  • deal.customFields
Brevo CRM (brevo)

Supported Request Fields:

  • dealId - Required

Supported Response Fields:

  • deal.info.id
  • deal.info.name
  • deal.info.description
  • deal.info.amount
  • deal.info.owner.id
  • deal.info.owner.email
  • deal.info.createdBy.id
  • deal.info.createdBy.email
  • deal.info.status
  • deal.info.createdAt
  • deal.info.lastActivityAt
  • deal.stage.stageId
  • deal.stage.stageName
  • deal.stage.pipelineId
  • deal.stage.pipelineName
  • deal.accounts
  • deal.contacts
Zendesk CRM (zendesk-crm)

Supported Request Fields:

  • dealId - Required

Supported Response Fields:

  • deal.info.id
  • deal.info.name
  • deal.info.amount
  • deal.info.currency
  • deal.info.owner.id
  • deal.info.createdBy.id
  • deal.info.status
  • deal.info.createdAt
  • deal.info.lastActivityAt
  • deal.stage.stageId
  • deal.stage.stageName
  • deal.stage.pipelineId
  • deal.contacts
  • deal.customFields
Sugar CRM (sugar-crm)

Supported Request Fields:

  • dealId - Required

Supported Response Fields:

  • deal.info.id
  • deal.info.name
  • deal.info.description
  • deal.info.amount
  • deal.info.currency
  • deal.info.owner.id
  • deal.info.createdBy.id
  • deal.info.status
  • deal.info.createdAt
  • deal.stage.stageId
  • deal.stage.stageName
  • deal.accounts
Close CRM (close-crm)

Supported Request Fields:

  • dealId - Required

Supported Response Fields:

  • deal.info.id
  • deal.info.name
  • deal.info.description
  • deal.info.amount
  • deal.info.currency
  • deal.info.owner.id
  • deal.info.createdBy.id
  • deal.info.status
  • deal.info.createdAt
  • deal.info.lastActivityAt
  • deal.stage.stageId
  • deal.stage.stageName
  • deal.stage.pipelineId
  • deal.stage.pipelineName
  • deal.accounts
  • deal.contacts
  • deal.customFields
Pipedrive (pipedrive)

Supported Request Fields:

  • dealId - Required

Supported Response Fields:

  • deal.info.id
  • deal.info.name
  • deal.info.amount
  • deal.info.currency
  • deal.info.owner.id
  • deal.info.owner.email
  • deal.info.createdBy.id
  • deal.info.createdBy.email
  • deal.info.status
  • deal.info.createdAt
  • deal.info.lastActivityAt
  • deal.stage.stageId
  • deal.stage.pipelineId
  • deal.contacts
Affinity (affinity)

Supported Request Fields:

  • dealId - Required

Supported Response Fields:

  • deal.info.id
  • deal.info.name
  • deal.accounts
  • deal.contacts
LeadSquared (leadsquared)

Supported Request Fields:

  • dealId - Required

Supported Response Fields:

  • deal.info.id
  • deal.info.name
  • deal.info.amount
  • deal.info.owner.id
  • deal.info.status
  • deal.info.createdAt
  • deal.info.lastActivityAt
  • deal.stage.stageName
  • deal.customFields
Pipeline CRM (pipelinecrm)
Attio (attio)

Supported Request Fields:

  • dealId - Required
  • additionalFields

Supported Response Fields:

  • deal.info.id
  • deal.info.name
  • deal.info.amount
  • deal.info.currency
  • deal.info.owner.id
  • deal.info.owner.email
  • deal.info.createdBy.id
  • deal.info.createdBy.email
  • deal.info.status
  • deal.info.createdAt
  • deal.stage.stageId
  • deal.stage.stageName
  • deal.accounts
  • deal.contacts
Microsoft Dynamics 365 Sales (msd-365-sales)

Supported Request Fields:

  • dealId - Required
  • additionalFields

Supported Response Fields:

  • deal.info.id
  • deal.info.name
  • deal.info.description
  • deal.info.amount
  • deal.info.currency
  • deal.info.owner.id
  • deal.info.owner.email
  • deal.info.createdBy.id
  • deal.info.createdBy.email
  • deal.info.status
  • deal.info.createdAt
  • deal.stage.stageId
  • deal.stage.stageName
  • deal.accounts
  • deal.contacts

Apps supported via Webhook (API Support coming soon)

Salesflare (salesflare)
Query Params
string
required
string

Enter a comma-separated string of additional properties to fetch from the CRM. The additional properties would be returned in the additionalFields key in the response.

Responses

Updated 27 days 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 27 days ago

Did this page help you?