Get all deals
GET {{baseUrl}}/deals?filter_id=<integer>&ids=<string>&owner_id=<integer>&person_id=<integer>&org_id=<integer>&pipeline_id=<integer>&stage_id=<integer>&status=<string>&updated_since=<string>&updated_until=<string>&sort_by=id&sort_direction=asc&include_fields=<string>&custom_fields=<string>&limit=<integer>&cursor=<string>
Returns data about all deals.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filter_id | string | If supplied, only deals matching the specified filter are returned | |
ids | string | Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response. | |
owner_id | string | If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored. | |
person_id | string | If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored. | |
org_id | string | If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored. | |
pipeline_id | string | If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored. | |
stage_id | string | If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored. | |
status | string | Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. Multiple statuses can be included as a comma separated array. If filter_id is provided, this is ignored. | |
updated_since | string | If set, only deals with an update_time later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. | |
updated_until | string | If set, only deals with an update_time earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. | |
sort_by | string | The field to sort by. Supported fields: id, update_time, add_time. | |
sort_direction | string | The sorting direction. Supported values: asc, desc. | |
include_fields | string | Optional comma separated string array of additional fields to include | |
custom_fields | string | Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. | |
limit | string | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. | |
cursor | string | For pagination, the marker (an opaque string value) representing the first item on the next page |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"success":true,"data":[{"id":1,"title":"Deal Title","creator_user_id":1,"owner_id":1,"value":200,"person_id":1,"org_id":1,"stage_id":1,"pipeline_id":1,"currency":"USD","add_time":"2021-01-01T00:00:00Z","update_time":"2021-01-01T00:00:00Z","stage_change_time":"2021-01-01T00:00:00Z","status":"open","is_deleted":false,"probability":90,"lost_reason":"Lost Reason","visible_to":7,"close_time":"2021-01-01T00:00:00Z","won_time":"2021-01-01T00:00:00Z","lost_time":"2021-01-01T00:00:00Z","local_won_date":"2021-01-01","local_lost_date":"2021-01-01","local_close_date":"2021-01-01","expected_close_date":"2021-01-01","label_ids":[1,2,3],"origin":"ManuallyCreated","origin_id":null,"channel":52,"channel_id":"Jun23 Billboards","acv":120,"arr":120,"mrr":10,"custom_fields":{}}],"additional_data":{"next_cursor":"eyJmaWVsZCI6ImlkIiwiZmllbGRWYWx1ZSI6Nywic29ydERpcmVjdGlvbiI6ImFzYyIsImlkIjo3fQ"}}