In order to make requests to the Deals related API endpoints, the user should belong to a user group that has the Deals permission turned on.

Deals parameters available values

For following parameters:

Use following values:

Parameter value	Meaning
all	All three fields: title, contact, and org
title	Deal's title
contact	Deal's primary contact's first name and last name. If `search` parameter has more than one word, first word is used for matching first name of contacts and rest of the words are used for matching last name of contacts.
org	Deal's primary contact's organization name

For following parameters:

Use following values:

For following parameters:

Use following values:

Parameter value	Meaning
upcoming	Deals with tasks that are due within 24 hours.
scheduled	Deals with tasks that are due in more than 24 hours
overdue	Deals with tasks that are past due dates.
no-task	Deals without any task.

For following parameters:

Use following values:

Parameter value	Meaning
greater than 0	Deals with primary contacts that have the tag with given id
-1	Deals with primary contacts that have any tag
-2	Deals with primary contacts that have no tag