Unified API Reference
DashboardSignup For Free

List Deals

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

List deals in a paginated format with details such as id, name, amount etc.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
✨ อัปเดตล่าสุด: reference/list deals - Kapook Update 2025Loading…

📘

For schema of contact object refer - Deal Data Model

This API may not return all fields defined in the response schema; for additional details, use the Get Deal by Id API.

Supported Apps

Apps supported via API

Salesforce (salesforce)

Supported Request Fields:

  • createdAfter
  • createdBefore
  • updatedAfter
  • updatedBefore
  • stageId
  • accountId
  • contactId
  • ownerId
  • createdById
  • amountGreaterThan
  • amountLessThan
  • pageToken
  • originData

Supported Response Fields:

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

Supported Request Fields:

  • createdAfter
  • createdBefore
  • updatedAfter
  • updatedBefore
  • stageId
  • pipelineId
  • accountId
  • contactId
  • ownerId
  • createdById
  • amountGreaterThan
  • amountLessThan
  • pageSize
  • pageToken
  • originData

Supported Response Fields:

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

Supported Request Fields:

  • createdAfter
  • createdBefore
  • updatedAfter
  • updatedBefore
  • ownerId
  • createdById
  • accountId
  • contactId
  • stageId
  • amountGreaterThan
  • amountLessThan
  • pageToken
  • originData

Supported Response Fields:

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

Supported Request Fields:

  • createdAfter
  • createdBefore
  • updatedAfter
  • updatedBefore
  • stageId
  • pipelineId
  • accountId
  • ownerId
  • createdById
  • pageToken
  • originData

Supported Response Fields:

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

Supported Request Fields:

  • createdAfter
  • updatedAfter
  • ownerId
  • accountId
  • contactId
  • pageToken
  • originData

Supported Response Fields:

  • deals.info.id
  • deals.info.name
  • deals.info.description
  • deals.info.amount
  • deals.info.owner.id
  • deals.info.owner.email
  • deals.info.createdBy.id
  • deals.info.createdBy.email
  • deals.info.status
  • deals.info.createdAt
  • deals.info.lastActivityAt
  • deals.accounts
  • deals.contacts
  • nextPageToken
Zendesk CRM (zendesk-crm)

Supported Request Fields:

  • createdAfter
  • createdBefore
  • updatedAfter
  • updatedBefore
  • ownerId
  • createdById
  • contactId
  • stageId
  • amountGreaterThan
  • amountLessThan
  • pageToken
  • originData

Supported Response Fields:

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

Supported Request Fields:

  • createdAfter
  • createdBefore
  • updatedAfter
  • updatedBefore
  • amountGreaterThan
  • amountLessThan
  • ownerId
  • createdById
  • accountId
  • stageId
  • status
  • pageToken
  • originData

Supported Response Fields:

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

Supported Request Fields:

  • createdAfter
  • createdBefore
  • updatedAfter
  • updatedBefore
  • stageId
  • pipelineId
  • status
  • accountId
  • contactId
  • ownerId
  • createdById
  • amountGreaterThan
  • amountLessThan
  • pageToken
  • originData

Supported Response Fields:

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

Supported Request Fields:

  • updatedAfter
  • updatedBefore
  • ownerId
  • accountId
  • contactId
  • pipelineId
  • stageId
  • status
  • pageToken
  • originData

Supported Response Fields:

  • deals.info.id
  • deals.info.name
  • deals.info.amount
  • deals.info.currency
  • deals.info.owner.id
  • deals.info.createdBy.id
  • deals.info.status
  • deals.info.createdAt
  • deals.info.lastActivityAt
  • deals.stage.stageId
  • deals.stage.stageName
  • deals.stage.pipelineId
  • deals.stage.pipelineName
  • nextPageToken
Affinity (affinity)

Supported Request Fields:

  • pageToken
  • originData

Supported Response Fields:

  • deals.info.id
  • deals.info.name
  • deals.accounts
  • deals.contacts
  • nextPageToken
LeadSquared (leadsquared)

Supported Request Fields:

  • createdAfter
  • createdBefore
  • updatedAfter
  • updatedBefore
  • ownerId
  • status
  • pageToken
  • originData

Supported Response Fields:

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

Supported Request Fields:

  • createdAfter
  • createdBefore
  • createdById
  • ownerId
  • accountId
  • contactId
  • stageId
  • status
  • pageToken
  • originData

Supported Response Fields:

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

Supported Request Fields:

  • createdAfter
  • createdBefore
  • updatedAfter
  • updatedBefore
  • amountGreaterThan
  • amountLessThan
  • createdById
  • ownerId
  • accountId
  • contactId
  • status
  • pageToken
  • originData
  • enrichStageFromCache - default's to true - set it to false if you don't want the stage data enriched from the cache that was created during the latest sync run.

Supported Response Fields:

  • deals.info.id
  • deals.info.name
  • deals.info.description
  • deals.info.amount
  • deals.info.currency
  • deals.info.owner.id
  • deals.info.owner.email
  • deals.info.createdBy.id
  • deals.info.createdBy.email
  • deals.info.status
  • deals.info.createdAt
  • deal.stage.stageId
  • deal.stage.stageName
  • deal.stage.pipelineId
  • deal.stage.pipelineName
  • deals.accounts
  • deals.contacts
  • nextPageToken
Twenty (twenty)

Supported Request Fields:

  • createdAfter
  • createdBefore
  • updatedAfter
  • updatedBefore
  • amountGreaterThan
  • amountLessThan
  • createdById
  • ownerId
  • accountId
  • contactId
  • stageId
  • pageToken
  • originData

Supported Response Fields:

  • deals.info.id
  • deals.info.name
  • deals.info.amount
  • deals.info.currency
  • deals.info.owner.id
  • deals.info.owner.email
  • deals.info.createdBy.id
  • deals.info.createdBy.email
  • deals.info.createdAt
  • deals.stage.stageId
  • deals.stage.stageName
  • deals.accounts
  • deals.contacts
  • nextPageToken
  • originData

Apps supported via Webhook (API Support coming soon)

Salesflare (salesflare)
📘

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

Query Params
string
boolean
Defaults to false
date-time

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

string

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

string

Filters deals by one or more stage ids. Supports multiple values as a comma-separated list. (e.g., stageId=24,18,25).

string

Filters deals by one or more pipeline ids. Supports multiple values as a comma-separated list. (e.g., pipelineId=24,18,25).

string

Filters deals by one or more status's. Supports multiple values as a comma-separated list. (e.g., status=WON,LOST).

string

Filters deals by one or more owner ids. Supports multiple values as a comma-separated list. (e.g., ownerId=24,18,25).

string

Filters deals by one or more creator ids. Supports multiple values as a comma-separated list. (e.g., createdById=24,18,25).

string

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

string

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

number

Filter deals which have the amount greater than the specified value.

number

Filter deals which have the amount less than the specified value.

Responses

Updated about 1 month ago

Did this page help you?
Language
Credentials
✨ อัปเดตล่าสุด: reference/list deals - Kapook Update 2025Loading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?