Sign in
crm
deal

List all deals

get/crm/{connection_id}/deal

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

company_idstring

The company ID to filter by (reference to CrmCompany)

contact_idstring

The contact ID to filter by (reference to CrmContact)

user_idstring

The user/employee ID to filter by (reference to HrisEmployee)

pipeline_idstring

The pipeline ID to filter by

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time
updated_atstring date-time
namestring
amountnumber
currencystring
closed_atstring date-time
closing_atstring date-time
sourcestring
probabilitynumber
tagsstring[]
lost_reasonstring
won_reasonstring
user_idstring
contact_idsstring[]
company_idsstring[]
descriptionstring
rawobject

Changes

Changed in 1 of the 34 revisions of this API.442

  • 3bea28547cc7442See the full diff
    • ▲

      removed the enum value pipeline from the property items/ of the query request parameter fields

      request-parameter-property-enum-value-removed

    • ▲

      removed the enum value pipeline_id from the property items/ of the query request parameter fields

      request-parameter-property-enum-value-removed

    • ▲

      removed the enum value stage from the property items/ of the query request parameter fields

      request-parameter-property-enum-value-removed

    • ▲

      removed the enum value stage_id from the property items/ of the query request parameter fields

      request-parameter-property-enum-value-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ○

      added the enum value description to the property items/ of the query request parameter fields

      request-parameter-property-enum-value-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 18 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog