User.com REST API Docs

# Get deal

You can return details about a specific deal.

GET /deals/:id/

Attributes Type Required Description
id string yes A unique identifier for the deal which is given by User.com automatically.

# Request

  • CURL
  • JavaScript
  • PHP
  • Python 
 curl -X GET -H
 "Authorization: Token <your_64_char_api_key> " "https://<your_app_subdomain>.user.com/api/public/deals/:id/"

# Response

{
    "id": 12218,
    "name": "example deal",
    "value": "1250.00",
    "currency": "USD",
    "custom_id": null,
    "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",
    "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": "no planned",
    "expected_close_date": null,
    "loss_reason": null,
    "loss_reason_description": ""
}

← Get deals by pipeline →