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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

pageToken

string

originData

boolean

Defaults to false

createdAfter

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

createdBefore

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

updatedAfter

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

updatedBefore

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

stageId

string

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

pipelineId

string

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

status

string

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

ownerId

string

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

createdById

string

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

accountId

string

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

contactId

string

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

amountGreaterThan

number

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

amountLessThan

number

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

Responses

Language

Credentials

Loading…

Response

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

application/json

200

400Bad Request