GET https://:account.api-us1.com/api/3/deals
- cURL
curl --request GET \
--url https:///:account.api-us1.com/api/3/deals
- Node
var request = require("request");
var options = { method: 'GET',
url: 'https:///:account.api-us1.com/api/3/deals' };
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
- Ruby
require 'uri'
require 'net/http'
url = URI("https:///:account.api-us1.com/api/3/deals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
- JavaScript
var data = JSON.stringify(false);
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https:///:account.api-us1.com/api/3/deals");
xhr.send(data);
- Python
import requests
url = "https:///:account.api-us1.com/api/3/deals"
response = requests.request("GET", url)
print(response.text)
200 OK
QUERY PARAMS
filters[search]
string Search text to use with
search_field parameterfilters[search_field]
string Field to search for
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
filters[owner]
int32 Filter by deal's owner
filters[nextdate_range]
string Filter by deal's tasks due dates
filters[tag]
string Filter by tag names associated with deal's primary contact
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 valuefilters[score_less_than]
string In a format of
<score_id>:<score_value>. Returns deals whose score value is less than given valuefilters[score]
string In a format of
<score_id>:<score_value>. Returns deals whose score value is equal to given valueorders[title]
string Order by deal's title.
orders[value]
string Order by deal's value.
orders[cdate]
string Order by deal's created date.
orders[contact_name]
string Order by deal's primary contact's first name.
orders[contact_orgname]
string Order by deal's primary contact's organization name.
orders[next-action]
string 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.
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, andisDisabledset to1. 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.
Opmerkingen
0 opmerkingen
Artikel is gesloten voor opmerkingen.