v1

latestOpenAPI 3.0.22026-07-24800528.1 KB

Deals

Retrieve a deal

Retrieves the details of an existing deal. You need only supply the unique deal key that was returned upon deal creation.

get/v2/deals/{deal_key}

Path parameters

deal_keystring required

Unique identifier of deal. Can be external_key, if one configured for deal.

Response

Retrieves the details of an existing deal. You need only supply the unique deal key that was returned upon deal creation.

messagestring required

statusinteger required

Example response

{
  "data": {
    "created_at": 1574181282399,
    "key": "co_a80cb515fe",
    "updated_at": 1574181282399,
    "account_name": "Digital Agency Acme",
    "amount": 25000,
    "close_date": "2020-03-01",
    "contact_first_name": "John",
    "contact_last_name": "Smith",
    "customer_key": "cus_a80cb515fe",
    "external_key": "deal_1234",
    "fields": [
      {
        "field_key": "field_fjkdlrh9i32nfew",
        "name": "Company Address"
      }
    ],
    "group_key": "grup_UHrMpyoNbTBRuc",
    "lost_reason": "Not the right fit",
    "partner_key": "bertramgilfoyle",
    "source": "partner",
    "stage": "Working",
    "team": {
      "created_at": 1574181282399,
      "key": "co_a80cb515fe",
      "updated_at": 1574181282399,
      "name": "Tushar"
    },
    "team_member": {
      "created_at": 1574181282399,
      "key": "co_a80cb515fe",
      "updated_at": 1574181282399,
      "email": "tushten@partnerstack.com",
      "first_name": "Tushar",
      "last_name": "Sutherland",
      "personal_stack_key": "stck_1234567890"
    }
  }
}