activities
activity-types
companies
contacts
countries
currencies
custom-fields
exports
files
imports
lost-reasons
notes
phone-codes
pipelines
products
search
search-filters
stages
timezones
users
webhook-events
webhook-requests
webhooks
Models
Powered by Stoplight
get

/deals.json

Returns a list of deals, they are returned with the most recently created first by default.

Make sure you first read how to work with leads, opportunities, and deals.

The following values are allowed in the include query parameter:

  • company
  • company.phoneNumbers.code
  • contacts
  • currency
  • mainContact
  • owner.avatar
  • stage.pipeline

The following targets are allowed in filter query parameters:

  • companyCount
  • companyId
  • contactEmail
  • contactId
  • createdAt
  • id
  • isQualified
  • isRotting
  • mainContactCount
  • mainContactEmail
  • ownerId
  • projectId
  • state
  • taskId
  • title
  • updatedAt

The following values are allowed in the sort query parameter:

  • closedAt
  • createdAt (default)
  • expectedCloseDate
  • qualifiedAt
  • state
  • title
  • totalValue
  • updatedAt

Request Parameters

5 Query Parameters

Responses

200 OK

Schema
object
deals
array[object]
included
object

Included contains all the side-loaded data of a response. See including related entities.

meta
object

ResponseMeta contains common meta data.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
host