List all deals

get https://{youraccountname}.api-us1.com/api/3/deals

Retrieve all existing deals

To list all deals, the following permissions are required.

Deal permission: the user should have permission to manage deals.
Pipeline-specific permission: the user should have permission to manage the pipeline that the deals belong to. If the user does not have the permission to manage the pipeline, limited deal data are returned with only id, title, and isDisabled set to 1. If the response contains both permitted pipeline deals and non-permitted pipeline deals, full deal data are returned for deals belonging to permitted pipelines and limited data for deals belonging to non-permitted pipelines.

{
  "deals": [
    {
      "owner": "1",
      "contact": "39",
      "organization": "20",
      "group": "1",
      "stage": "2",
      "title": "Able Hyena",
      "description": "Article do skill hope.",
      "percent": "0",
      "cdate": "2019-09-06T11:29:48-05:00",
      "mdate": "2019-09-06T11:29:48-05:00",
      "nextdate": null,
      "nexttaskid": null,
      "value": "1872151",
      "currency": "usd",
      "winProbability": 44,
      "winProbabilityMdate": "2019-10-05T12:27:22-05:00",
      "status": "0",
      "activitycount": "1",
      "nextdealid": "46",
      "edate": "2019-11-22 14:15:37",
      "links": {
      "dealActivities": "/api/3/deals/46/dealActivities",
      "contact":/api/3/deals/46/contact",
      "contactDeals": "/api/3/deals/46/contactDeals",
      "group": "/api/3/deals/46/group",
      "nextTask": "/api/3/deals/46/nextTask",
      "notes": "/api/3/deals/46/notes",
      "account": "/api/3/deals/46/account",
      "customerAccount": "/api/3/deals/46/customerAccount",
      "organization": "/api/3/deals/46/organization",
      "owner": "/api/3/deals/46/owner",
      "scoreValues": "/api/3/deals/46/scoreValues",
      "stage": "/api/3/deals/46/stage",
      "tasks": "api/3/deals/46/tasks",
      "dealCustomFieldData": "/api/3/deals/46/dealCustomFieldData"
		},
    "id": "46",
    "isDisabled": false,
    "account": "20",
    "customerAccount": "20"
		},
    {
      "activitycount": "62",
      "cdate": "2017-01-20T09:28:02-06:00",
      "contact": "44",
      "currency": "usd",
      "edate": "0000-00-00 00:00:00",
      "group": "2",
      "hash": "d6ca7d0b",
      "id": "1",
      "links": {
        "dealActivities": "/api/3/deals/1/dealActivities",
        "contact": "/api/3/deals/1/contact",
        "contactDeals": "/api/3/deals/1/contactDeals",
        "group": "/api/3/deals/1/group",
        "nextTask": "/api/3/deals/1/nextTask",
        "notes": "/api/3/deals/1/notes",
        "organization": "/api/3/deals/1/organization",
        "owner": "/api/3/deals/1/owner",
        "scoreValues": "/api/3/deals/1/scoreValues",
        "stage": "/api/3/deals/1/stage",
        "tasks": "/api/3/deals/1/tasks"
      },
      "mdate": "2017-02-06T12:21:12-06:00",
      "nextTask": "2",
      "nextdate": "2017-02-06T12:00:00-06:00",
      "nextdealid": "1",
      "nexttaskid": "2",
      "organization": null,
      "owner": "1",
      "percent": "0",
      "stage": "3",
      "status": "1",
      "title": "Test Deal",
      "description": "A deal that will make a big difference",
      "value": "10000"
    },
    {
        "id": "2",
        "isDisabled": 1,
        "title": "Demo Requested"
    }
  ],
  "meta": {
    "currencies": {
      "USD": {
        "currency": "USD",
        "total": "3",
        "value": "30000"
      }
    },
    "total": 3
  }
}

Query Params

filters[search]

string

Search text to use with search_field parameter.

filters[search_field]

string

Field to search for. See available values.

filters[title]

string

Filter by deal's title

filters[stage]

int32

Filter by deal's stage

filters[group]

int32

Filter by deal's pipeline

filters[status]

int32

Filter by deal's status. See available values

filters[owner]

int32

Filter by deal's owner

filters[nextdate_range]

string

Filter by deal's tasks due dates. See available values

filters[tag]

string

Filter by tag names associated with deal's primary contact. See available values.

filters[tasktype]

string

Filter by deals that have tasks with given type

filters[created_before]

date

Returns deals that are created less than given date

filters[created_after]

date

Returns deals that are created greater than or equal to given date

filters[updated_before]

date

Returns deals that are updated less than given date

filters[updated_after]

date

Returns deals that are updated greater than or equal to given date

filters[organization]

int32

Filter by deal's primary contact's organization's id

filters[minimum_value]

int32

In USD with dollar portion. Returns deals whose values are greater than or equal to given value

filters[maximum_value]

int32

In USD with dollar portion. Returns deals whose values are less than or equal to given value

filters[score_greater_than]

string

In a format of <score_id>:<score_value>. Returns deals whose score value is greater than given value

filters[score_less_than]

string

In a format of <score_id>:<score_value>. Returns deals whose score value is less than given value

filters[score]

string

In a format of <score_id>:<score_value>. Returns deals whose score value is equal to given value

orders[title]

string

Defaults to ASC

Order by deal's title.

orders[value]

string

Defaults to ASC

Order by deal's value.

orders[cdate]

string

Defaults to ASC

Order by deal's created date.

orders[contact_name]

string

Defaults to ASC

Order by deal's primary contact's first name.

orders[contact_orgname]

string

Defaults to ASC

Order by deal's primary contact's organization name.

orders[next-action]

string

Defaults to ASC

Order by deal's next task's due date first. Then append deals with no next task. Lastly append deals with overdue tasks. If dates are the same, order by deal's id.

Responses

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://youraccountname.api-us1.com/api/3/deals?orders[title]=ASC&orders[value]=ASC&orders[cdate]=ASC&orders[contact_name]=ASC&orders[contact_orgname]=ASC&orders[next-action]=ASC' \
3
     --header 'accept: application/json'

Choose an example:

application/json

200200

400400