Skip to main content
GET
/
deals
List deals
curl --request GET \
  --url https://api.heffl.com/api/v1/deals \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "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>"
    }
  ],
  "meta": {
    "count": 123,
    "total": 123,
    "pageNo": 123,
    "pageSize": 123
  }
}

Authorizations

x-api-key
string
header
required

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

Query Parameters

pageNo
number
default:1

Page number (starts from 1)

Required range: x >= 1
pageSize
number
default:20

Number of items per page (max 100)

Required range: 1 <= x <= 100

Search by deal title

pipelineId
number

Filter by pipeline ID

stageId
number

Filter by stage ID

status
enum<string>

Filter by deal status (ACTIVE, WON, LOST)

Available options:
ACTIVE,
WON,
LOST

Response

200 - application/json

OK

items
object[]
required
meta
object
required