Deals

Get a deal

Returns a single deal by its public ID.

get/deals/{id}

Request

  • Base URL: https://api.heffl.com/api/v1
  • URL: https://api.heffl.com/api/v1/deals/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Deal public ID

Response

OK

idstring required

Deal public ID

numberstring nullable

Auto-generated deal number

titlestring required

Deal title

pricenumber nullable

Deal price/value

statusstring nullable

Deal status

prioritystring nullable

Deal priority

expectedCloseDatestring date-time nullable

Expected close date

clientIdstring nullable

Client public ID

pipelineIdstring nullable

Pipeline public ID

stageIdstring nullable

Pipeline stage public ID

sourceIdstring nullable

Deal source public ID

leadIdstring nullable

Lead public ID

createdAtstring date-time required

When the deal was created

customFieldsobject nullable

Custom field values

Changes

No recorded changes to this operation across all 1 revision of this API.