Get deals by pipeline
Return information about deals in a chosen pipeline.
All your deals data in a chosen pipeline can be returned by GET
request to https://<your_app_subdomain>.user.com/api/public/deals/?pipeline=pipeline_id
GET
/deals/?pipeline=:pipeline_id
Attribute
Type
Description
pipeline_id
integer
Pipeline ID
curl -X GET -H "Authorization: Token <your_64_char_api_key>" "https://<your_app_subdomain>.user.com/api/public/deals/?pipeline=:pipeline_id"
Response
{
"count": 3,
"next": null,
"previous": null,
"results": [
{
"id": 3300,
"name": "Deal 1",
"value": "525.00",
"currency": "USD",
"custom_id": null,
"stage": 25898,
"pipeline": 4338,
"assigned_to": null,
"restricted_to": null,
"agent": 5567,
"company": null,
"person": 22266722,
"status": "1",
"scope": "2",
"created_by": 5567,
"created_at": "2017-06-27T14:51:04.331287Z",
"updated_at": "2017-07-04T16:54:47.907574Z",
"attributes": [
{
"value": "attr value",
"name_std": "deal_attr",
"name": "deal attr",
"description": "attribute description",
"id": 22
},
{
"value": "attr value",
"name_std": "deal_attr_2",
"name": "deal attr 2",
"description": " attribute description",
"id": 23
}
],
"tags": [
{
"id": 31,
"name": "My tag",
}
],
"activities_status": "3",
"activities_status_updated_at": "2017-07-04T16:54:47.907238Z",
"expected_close_date": null
},
{
"id": 3299,
"name": "Deal 2",
"value": "1000.00",
"currency": "USD",
"custom_id": null,
"stage": 25903,
"pipeline": 4338,
"assigned_to": null,
"restricted_to": null,
"agent": 5567,
"company": null,
"person": 22132488,
"status": "1",
"scope": "2",
"created_by": 5567,
"created_at": "2017-06-27T14:50:21.944576Z",
"updated_at": "2017-06-27T14:50:21.944596Z",
"attributes": [
{
"value": "attr value",
"name_std": "deal_attr",
"name": "deal attr",
"description": "attribute description",
"id": 22
},
{
"value": "attr value",
"name_std": "deal_attr_2",
"name": "deal attr 2",
"description": " attribute description",
"id": 23
}
],
"tags": [
{
"id": 31,
"name": "My tag",
}
],
"activities_status": "0",
"activities_status_updated_at": "2017-06-27T14:50:21.944174Z",
"expected_close_date": null
}
]
}
var settings = {
"async": true,
"crossDomain": true,
"url": "https://<your_app_subdomain>.user.com/api/public/deals/?pipeline=:pipeline_id",
"method": "GET",
"headers": {
"authorization": "Token <your_64_char_api_key>"
}
}
$.ajax(settings).done(function (response) {
console.log(response);
});
var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://<your_app_subdomain>.user.com/api/public/deals/?pipeline=:pipeline_id");
xhr.setRequestHeader("authorization", "Token <your_64_char_api_key>");
xhr.send(data);
var request = require("request");
var options = { method: 'GET',
url: 'https://<your_app_subdomain>.user.com/api/public/deals/',
qs: { pipeline: ':pipeline_id' },
headers: { authorization: 'Token <your_64_char_api_key>' } };
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://<your_app_subdomain>.user.com/api/public/deals/?pipeline=:pipeline_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => "",
CURLOPT_HTTPHEADER => array(
"authorization: Token <your_64_char_api_key>"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
import requests
url = "https://<your_app_subdomain>.user.com/api/public/deals/"
payload = ""
querystring = {"pipeline":":pipeline_id"}
headers = {'authorization': 'Token <your_64_char_api_key>'}
response = requests.request("GET", url, data=payload, headers=headers, params=querystring)
print(response.text)
import http.client
conn = http.client.HTTPSConnection("<your_app_subdomain>.user.com")
payload = ""
headers = { 'authorization': "Token <your_64_char_api_key>" }
conn.request("GET", "/api/public/deals/?pipeline=:pipeline_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))