Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.heffl.com/llms.txt

Use this file to discover all available pages before exploring further.

Pagination

List endpoints in API v2 use cursor-based pagination with a consistent shape:
{
  "data": [ ... ],
  "meta": {
    "nextCursor": "cursor_value_or_null",
    "hasMore": true
  }
}

Query parameters

ParameterTypeDefaultDescription
cursorstringnoneCursor from the previous response (meta.nextCursor)
pageSizenumber30Items per page (max 100)
API v2 uses pageSize. Legacy v1 list endpoints use limit instead.

Example

curl "https://api.heffl.com/api/v2/contacts?pageSize=25" \
  -H "x-api-key: YOUR_API_KEY"
Response:
{
  "data": [
    {
      "id": "clt_abc123",
      "number": "CON001",
      "firstName": "Jane",
      "lastName": "Smith",
      "email": "[email protected]"
    }
  ],
  "meta": {
    "nextCursor": null,
    "hasMore": false
  }
}
See Listing & filters for search, sorting, and structured filters.