Qodex.ai

Get deals in a pipeline

GET {{baseUrl}}/pipelines/:id/deals?filter_id=<integer>&user_id=<integer>&everyone=<number>&stage_id=<integer>&start=0&limit=<integer>&get_summary=<number>&totals_convert_currency=<string>

Lists deals in a specific pipeline across all its stages. If no parameters are provided open deals owned by the authorized user will be returned.

Request Params

KeyDatatypeRequiredDescription
filter_idstringIf supplied, only deals matching the given filter will be returned
user_idstringIf supplied, filter_id will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned.
everyonestringIf supplied, filter_id and user_id will not be considered – instead, deals owned by everyone will be returned
stage_idstringIf supplied, only deals within the given stage will be returned
startnumberPagination start
limitstringItems shown per page
get_summarystringWhether to include a summary of the pipeline in the additional_data or not
totals_convert_currencystringThe 3-letter currency code of any of the supported currencies. When supplied, per_stages_converted is returned inside deals_summary inside additional_data which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to default_currency in which case users default currency is used. Only works when get_summary parameter flag is enabled.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;success&quot;:true,&quot;data&quot;:[{&quot;id&quot;:1,&quot;creator_user_id&quot;:123,&quot;user_id&quot;:456,&quot;person_id&quot;:1,&quot;org_id&quot;:2,&quot;stage_id&quot;:2,&quot;title&quot;:&quot;Deal One&quot;,&quot;value&quot;:5000,&quot;currency&quot;:&quot;EUR&quot;,&quot;add_time&quot;:&quot;2019-05-29 04:21:51&quot;,&quot;update_time&quot;:&quot;2019-05-29 04:21:51&quot;,&quot;stage_change_time&quot;:&quot;2019-11-28 15:41:22&quot;,&quot;active&quot;:true,&quot;deleted&quot;:false,&quot;status&quot;:&quot;open&quot;,&quot;probability&quot;:null,&quot;next_activity_date&quot;:&quot;2019-11-29&quot;,&quot;next_activity_time&quot;:&quot;11:30:00&quot;,&quot;next_activity_id&quot;:128,&quot;last_activity_id&quot;:null,&quot;last_activity_date&quot;:null,&quot;lost_reason&quot;:null,&quot;visible_to&quot;:&quot;1&quot;,&quot;close_time&quot;:null,&quot;pipeline_id&quot;:1,&quot;won_time&quot;:&quot;2019-11-27 11:40:36&quot;,&quot;first_won_time&quot;:&quot;2019-11-27 11:40:36&quot;,&quot;lost_time&quot;:&quot;2019-11-27 11:40:36&quot;,&quot;products_count&quot;:0,&quot;files_count&quot;:0,&quot;notes_count&quot;:2,&quot;followers_count&quot;:0,&quot;email_messages_count&quot;:4,&quot;activities_count&quot;:1,&quot;done_activities_count&quot;:0,&quot;undone_activities_count&quot;:1,&quot;participants_count&quot;:1,&quot;expected_close_date&quot;:&quot;2019-06-29&quot;,&quot;last_incoming_mail_time&quot;:&quot;2019-05-29 18:21:42&quot;,&quot;last_outgoing_mail_time&quot;:&quot;2019-05-30 03:45:35&quot;,&quot;label&quot;:&quot;11&quot;,&quot;stage_order_nr&quot;:2,&quot;person_name&quot;:&quot;Person&quot;,&quot;org_name&quot;:&quot;Organization&quot;,&quot;next_activity_subject&quot;:&quot;Call&quot;,&quot;next_activity_type&quot;:&quot;call&quot;,&quot;next_activity_duration&quot;:&quot;00:30:00&quot;,&quot;next_activity_note&quot;:&quot;Note content&quot;,&quot;formatted_value&quot;:&quot;€5,000&quot;,&quot;weighted_value&quot;:5000,&quot;formatted_weighted_value&quot;:&quot;€5,000&quot;,&quot;weighted_value_currency&quot;:&quot;EUR&quot;,&quot;rotten_time&quot;:null,&quot;owner_name&quot;:&quot;Creator&quot;,&quot;cc_email&quot;:&quot;company+deal1@pipedrivemail.com&quot;,&quot;org_hidden&quot;:false,&quot;person_hidden&quot;:false}],&quot;additional_data&quot;:{&quot;pagination&quot;:{&quot;start&quot;:0,&quot;limit&quot;:100,&quot;more_items_in_collection&quot;:false}}}