Get deal details

Return information about your all users.

All your deals data can be returned by GET request to https://app.userengage.com/api/public/deals-by-id/:deal_id/

GET

/deals-by-id/:deal_id/

Data
Type
Description
deal_id
string
Your deal custom ID
curl -X GET -H "Authorization: Token <your_64_char_api_key>" "https://app.userengage.com/api/public/deals-by-id/:deal_id/"

Response

{
    "id": 12218,
    "name": "example deal",
    "value": "1250.00",
    "currency": "USD",
    "custom_id": "<:deal_id>",
    "stage": 36585,
    "pipeline": 6179,
    "assigned_to": 398,
    "restricted_to": null,
    "agent": null,
    "company": 768,
    "person": 20900530,
    "status": 1,
    "scope": 2,
    "created_by": 382,
    "created_at": "2017-09-06T09:53:50.748535Z",
    "updated_at": "2017-09-06T09:53:50.748555Z",
    "activities_status": "no planned",
    "expected_close_date": null,
    "loss_reason": null,
    "loss_reason_description": ""
}
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://app.userengage.com/api/public/deals-by-id/:deal_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://app.userengage.com/api/public/deals-by-id/:deal_id/");
xhr.setRequestHeader("authorization", "Token <your_64_char_api_key>");

xhr.send(data);
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.userengage.com/api/public/deals-by-id/:deal_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://app.userengage.com/api/public/deals-by-id/:deal_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://app.userengage.com/api/public/deals-by-id/:deal_id/"

payload = ""
headers = {'authorization': 'Token <your_64_char_api_key>'}

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)
import http.client

conn = http.client.HTTPSConnection("app.userengage.com")

payload = ""

headers = { 'authorization': "Token <your_64_char_api_key>" }

conn.request("GET", "/api/public/deals-by-id/:deal_id/", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))