Skip to main content
GET
Get a company

Authorizations

x-api-key
string
header
required

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

Path Parameters

id
string
required

Company ID

Response

OK

A company with its billing address, tags, owner and contacts. Returned by get, create and update.

id
string
required

Company ID

name
string
required

Company name

number
string
required

Auto-generated company number

openingBalance
number
required

Opening balance

showJobAmountToWorker
boolean
required

Whether job amounts are visible to field workers

isClientPortalEnabled
boolean
required

Whether the client portal is enabled

paymentTerm
enum<string> | null
required

Default invoice payment term. Null falls back to the team default.

Available options:
DUE_ON_RECEIPT,
NET_7,
NET_15,
NET_30,
NET_45,
NET_60,
END_OF_MONTH,
END_OF_NEXT_MONTH,
CUSTOM
ownerName
string | null
required

Owner's full name

tags
object[]
required

Tags on the company

billingAddress
object | null
required

Billing address

contacts
object[]
required

Contacts under this company, primary first

type
enum<string> | null

Record type (always company for this endpoint)

Available options:
contact,
company
email
string | null

Email address

phone
string | null

Phone number

taxNumber
string | null

Tax number

website
string | null

Website URL

description
string | null

Description

industries
string[]

Industries

employeesCountRange
enum<string> | null

Employee count bucket

Available options:
1-10,
11-50,
51-200,
201-500,
501-1K,
1K-5K,
5K-10K,
over-10K
revenueRange
enum<string> | null

Annual revenue bucket

Available options:
under-1m,
1m-10m,
10m-50m,
50m-100m,
100m-200m,
200m-1b,
over-1b
foundedYear
integer | null

Year the company was founded

linkedin
string | null

LinkedIn URL

twitter
string | null

X / Twitter URL

facebook
string | null

Facebook URL

instagram
string | null

Instagram URL

stageId
string | null

Client stage ID

stageName
string | null

Client stage label

ownerUserId
string | null

Owner user ID

sourceId
string | null

CRM source ID

sourceName
string | null

CRM source name

currency
string | null

Currency code

taxTreatment
enum<string> | null

VAT treatment (GCC)

Available options:
vat_registered,
vat_not_registered,
gcc_vat_registered,
gcc_vat_not_registered,
non_gcc,
dz_vat_registered,
dz_vat_not_registered
profileImage
string | null

Profile image URL

createdAt
string<date-time>

When the company was created

updatedAt
string<date-time>

When the company was last updated

lastActivityAt
string<date-time> | null

When the last activity was logged

lastContactedAt
string<date-time> | null

When the company was last contacted

enrichedAt
string<date-time> | null

When the company was last enriched

{key}
any

Custom field values as top-level cf_* keys (for example cf_industry). There is no customFields wrapper.