Skip to main content
GET
/
companies
List companies
curl --request GET \
  --url https://api.heffl.com/api/v2/companies \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "number": "<string>",
      "openingBalance": 123,
      "showJobAmountToWorker": true,
      "isClientPortalEnabled": true,
      "email": "<string>",
      "phone": "<string>",
      "taxNumber": "<string>",
      "website": "<string>",
      "description": "<string>",
      "stageId": "<string>",
      "stageName": "<string>",
      "ownerUserId": "<string>",
      "crmSourceId": "<string>",
      "sourceName": "<string>",
      "currency": "<string>",
      "internalNotes": "<string>",
      "linkedin": "<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 by name, number, email, or phone

orderBy
enum<string>
default:createdAt

Field to sort results by

Available options:
createdAt,
name,
number
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