Skip to main content
GET
/
deals
/
{id}
Get a deal
curl --request GET \
  --url https://api.heffl.com/api/v1/deals/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "title": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "number": "<string>",
  "price": 123,
  "status": "<string>",
  "priority": "<string>",
  "expectedCloseDate": "2023-11-07T05:31:56Z",
  "clientId": "<string>",
  "clientName": "<string>",
  "pipelineId": 123,
  "stageName": "<string>",
  "source": "<string>",
  "leadId": 123,
  "customFields": "<unknown>"
}

Authorizations

x-api-key
string
header
required

API key for authentication. Get yours at app.heffl.com/settings/developers

Path Parameters

id
string
required

Deal public ID

Response

200 - application/json

OK

id
string
required

Deal ID

title
string
required

Deal title

createdAt
string<date-time>
required

When the deal was created

number
string | null

Auto-generated deal number

price
number | null

Deal price/value

status
string | null

Deal status

priority
string | null

Deal priority

expectedCloseDate
string<date-time> | null

Expected close date

clientId
string | null

Client public ID

clientName
string | null

Client name

pipelineId
number | null

Pipeline ID

stageName
string | null

Current stage name

source
string | null

Deal source name

leadId
number | null

Lead ID

customFields
any | null

Custom field values