Skip to main content
GET
/
deals
/
{id}
Get a deal
curl --request GET \
  --url https://api.heffl.com/api/v2/deals/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "number": "<string>",
  "title": "<string>",
  "contactEmails": [
    "<string>"
  ],
  "clientId": "<string>",
  "client": {},
  "price": 123,
  "expectedCloseDate": "2023-11-07T05:31:56Z",
  "pipelineId": "<string>",
  "stageId": "<string>",
  "stage": "<string>",
  "leadId": "<string>",
  "leadName": "<string>",
  "crmSourceId": "<string>",
  "source": "<string>",
  "ownerUserId": "<string>",
  "ownerId": "<string>",
  "ownerName": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

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 ID

Response

OK

​
id
string
required

Deal ID

​
number
string
required

Auto-generated deal number

​
title
string
required

Deal title

​
contactEmails
string[]
required

Emails of linked contacts

​
clientId
string | null

Contact or company ID (clt_ prefix)

​
client
object

Linked client record

​
price
number | null

Deal value

​
expectedCloseDate
string<date-time> | null

Expected close date

​
status
enum<string> | null

Deal status

Available options:
ACTIVE,
WON,
LOST
​
priority
enum<string> | null

Deal priority

Available options:
LOW,
MEDIUM,
HIGH
​
pipelineId
string | null

Pipeline ID (dpl_ prefix)

​
stageId
string | null

Pipeline stage ID (dps_ prefix)

​
stage
string | null

Pipeline stage name

​
leadId
string | null

Lead ID

​
leadName
string | null

Lead name

​
crmSourceId
string | null

CRM source ID (src_ prefix)

​
source
string | null

CRM source name

​
ownerUserId
string | null

Owner user ID (usr_ prefix)

​
ownerId
string | null

Owner user ID (usr_ prefix)

​
ownerName
string | null

Owner name

​
createdAt
string<date-time> | null

When the deal was created

​
updatedAt
string<date-time> | null

When the deal was last updated

​
{key}
any

Custom field values as top-level cf_* keys (for example cf_priority). There is no customFields wrapper.