List deals

GET

deals

List deals

curl --request GET \
  --url https://api.example.com/v3/deals

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v3/deals",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v3/deals"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v3/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

{
  "items": [
    {
      "id": 123,
      "contactId": 123,
      "sourcePartnerId": 123,
      "stage": "<string>",
      "creationDate": "2023-11-07T05:31:56Z",
      "totalAmount": 123,
      "properties": {},
      "sourceLeadId": 123,
      "status": "Unknown",
      "partners": [
        {
          "id": 123,
          "dealId": 123,
          "userPartnerOwnerId": 123,
          "userPartnerOwnerName": "<string>",
          "userPartnerFirstName": "<string>",
          "userPartnerLastName": "<string>",
          "userPartnerEmail": "<string>",
          "userPartnerJobTitle": "<string>",
          "userPartnerPhoneNumber": "<string>",
          "userPartnerLinkedInProfileUrl": "<string>",
          "partnerId": 123,
          "partnerTypeId": 123,
          "creationDate": "2023-11-07T05:31:56Z",
          "partnerName": "<string>",
          "partnerTypeName": "<string>"
        }
      ],
      "contractStartDate": "2023-11-07T05:31:56Z",
      "contractEndDate": "2023-11-07T05:31:56Z",
      "ownerUserId": 123,
      "owner": {
        "id": 123,
        "email": "<string>",
        "firstName": "<string>",
        "lastName": "<string>"
      },
      "closeDate": "2023-11-07T05:31:56Z",
      "customerId": 123,
      "currency": "<string>"
    }
  ],
  "paginationSkipCount": 123,
  "totalCount": 123
}

Query Parameters

partner_id

integer<int32>

The ID of the partner to filter the deals on. A deal matches when the partner holds any role on it, including the source role.

close_stage

string

Filter the deals on whether their pipeline stage is closed. Accepted values: open, closedWon, closedLost, closed. The value is matched on the closed marker carried by the stage, never on the stage name.

Example:

"closed"

closed_after

string<date-time>

Filter the deals closed on or after this date (inclusive). A deal that is not closed has no close date and never matches.

closed_before

string<date-time>

Filter the deals closed before this date (exclusive). A deal that is not closed has no close date and never matches.

offset

integer<int32>

The cursor used in pagination. This is the index of the first deal to be returned.

limit

integer<int32>

The maximum number of deals to be returned. The default is 20.

sort_by

string

The property used to sort the deals by. The default is CreationDate.

Example:

"CreationDate"

order_by

string

The sorting direction for the returned deals. Accepted values: ASC, DESC. The default is DESC.

Response

Deals returned

items

object[] | null

Show child attributes

paginationSkipCount

integer<int32>

totalCount

integer<int32>

Gets or sets the total number of items that could be returned by this command (without pagination).

List deals

curl --request GET \
  --url https://api.example.com/v3/deals

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v3/deals",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v3/deals"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v3/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

{
  "items": [
    {
      "id": 123,
      "contactId": 123,
      "sourcePartnerId": 123,
      "stage": "<string>",
      "creationDate": "2023-11-07T05:31:56Z",
      "totalAmount": 123,
      "properties": {},
      "sourceLeadId": 123,
      "status": "Unknown",
      "partners": [
        {
          "id": 123,
          "dealId": 123,
          "userPartnerOwnerId": 123,
          "userPartnerOwnerName": "<string>",
          "userPartnerFirstName": "<string>",
          "userPartnerLastName": "<string>",
          "userPartnerEmail": "<string>",
          "userPartnerJobTitle": "<string>",
          "userPartnerPhoneNumber": "<string>",
          "userPartnerLinkedInProfileUrl": "<string>",
          "partnerId": 123,
          "partnerTypeId": 123,
          "creationDate": "2023-11-07T05:31:56Z",
          "partnerName": "<string>",
          "partnerTypeName": "<string>"
        }
      ],
      "contractStartDate": "2023-11-07T05:31:56Z",
      "contractEndDate": "2023-11-07T05:31:56Z",
      "ownerUserId": 123,
      "owner": {
        "id": 123,
        "email": "<string>",
        "firstName": "<string>",
        "lastName": "<string>"
      },
      "closeDate": "2023-11-07T05:31:56Z",
      "customerId": 123,
      "currency": "<string>"
    }
  ],
  "paginationSkipCount": 123,
  "totalCount": 123
}

API

JS SDK

API reference

Query Parameters

Response