Skip to main content
GET
/
deals
List deals
curl --request GET \
  --url https://api.heffl.com/api/v2/deals \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "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"
    }
  ],
  "meta": {
    "hasMore": true,
    "nextCursor": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

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

Query Parameters

​
cursor
string

Cursor for pagination. Pass the previous response meta.nextCursor value to fetch the next page.

​
pageSize
integer
default:30

Number of items to return per page (max 100)

Required range: 1 <= x <= 100
​
search
string

Search by deal title, number, or client name

​
orderBy
enum<string>
default:createdAt

Field to sort results by

Available options:
createdAt,
position,
expectedCloseDate,
price
​
orderDir
enum<string>
default:desc

Sort direction

Available options:
asc,
desc
​
filters
object

Structured filters. Each key is a filter field with operator and values. Option fields use string IDs; date fields use ISO 8601 date-time strings. See the Listing & filters guide.

Response

OK

​
data
object[]
required
​
meta
object
required