curl --request GET \
--url https://api.heffl.com/api/v2/companies/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.heffl.com/api/v2/companies/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.heffl.com/api/v2/companies/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.heffl.com/api/v2/companies/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.heffl.com/api/v2/companies/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.heffl.com/api/v2/companies/{id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heffl.com/api/v2/companies/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"number": "<string>",
"openingBalance": 123,
"showJobAmountToWorker": true,
"isClientPortalEnabled": true,
"paymentTerm": "DUE_ON_RECEIPT",
"ownerName": "<string>",
"tags": [
{
"id": "<string>",
"name": "<string>"
}
],
"billingAddress": {
"address": "<string>",
"city": "<string>",
"landmark": "<string>",
"postalCode": "<string>",
"state": "<string>",
"stateCode": "<string>",
"country": "<string>",
"countryCode": "<string>",
"latitude": 123,
"longitude": 123,
"googleMapsLink": "<string>",
"googleMapsPlaceId": "<string>"
},
"contacts": [
{
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"jobTitle": "<string>",
"isPrimary": true
}
],
"type": "contact",
"email": "<string>",
"phone": "<string>",
"taxNumber": "<string>",
"website": "<string>",
"description": "<string>",
"industries": [
"<string>"
],
"employeesCountRange": "1-10",
"revenueRange": "under-1m",
"foundedYear": 123,
"linkedin": "<string>",
"twitter": "<string>",
"facebook": "<string>",
"instagram": "<string>",
"stageId": "<string>",
"stageName": "<string>",
"ownerUserId": "<string>",
"sourceId": "<string>",
"sourceName": "<string>",
"currency": "<string>",
"taxTreatment": "vat_registered",
"profileImage": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"lastActivityAt": "2023-11-07T05:31:56Z",
"lastContactedAt": "2023-11-07T05:31:56Z",
"enrichedAt": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Get a company
Retrieves a single company by its ID (clt_ prefix) with its billing address, tags, owner and contacts. Custom field values are returned as top-level cf_* keys.
curl --request GET \
--url https://api.heffl.com/api/v2/companies/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.heffl.com/api/v2/companies/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.heffl.com/api/v2/companies/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.heffl.com/api/v2/companies/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.heffl.com/api/v2/companies/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.heffl.com/api/v2/companies/{id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heffl.com/api/v2/companies/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"number": "<string>",
"openingBalance": 123,
"showJobAmountToWorker": true,
"isClientPortalEnabled": true,
"paymentTerm": "DUE_ON_RECEIPT",
"ownerName": "<string>",
"tags": [
{
"id": "<string>",
"name": "<string>"
}
],
"billingAddress": {
"address": "<string>",
"city": "<string>",
"landmark": "<string>",
"postalCode": "<string>",
"state": "<string>",
"stateCode": "<string>",
"country": "<string>",
"countryCode": "<string>",
"latitude": 123,
"longitude": 123,
"googleMapsLink": "<string>",
"googleMapsPlaceId": "<string>"
},
"contacts": [
{
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"jobTitle": "<string>",
"isPrimary": true
}
],
"type": "contact",
"email": "<string>",
"phone": "<string>",
"taxNumber": "<string>",
"website": "<string>",
"description": "<string>",
"industries": [
"<string>"
],
"employeesCountRange": "1-10",
"revenueRange": "under-1m",
"foundedYear": 123,
"linkedin": "<string>",
"twitter": "<string>",
"facebook": "<string>",
"instagram": "<string>",
"stageId": "<string>",
"stageName": "<string>",
"ownerUserId": "<string>",
"sourceId": "<string>",
"sourceName": "<string>",
"currency": "<string>",
"taxTreatment": "vat_registered",
"profileImage": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"lastActivityAt": "2023-11-07T05:31:56Z",
"lastContactedAt": "2023-11-07T05:31:56Z",
"enrichedAt": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Authorizations
API key for authentication. Get yours at app.heffl.com/settings/developers
Path Parameters
Company ID
Response
OK
A company with its billing address, tags, owner and contacts. Returned by get, create and update.
Company ID
Company name
Auto-generated company number
Opening balance
Whether job amounts are visible to field workers
Whether the client portal is enabled
Default invoice payment term. Null falls back to the team default.
DUE_ON_RECEIPT, NET_7, NET_15, NET_30, NET_45, NET_60, END_OF_MONTH, END_OF_NEXT_MONTH, CUSTOM Owner's full name
Tags on the company
Show child attributes
Show child attributes
Billing address
Show child attributes
Show child attributes
Contacts under this company, primary first
Show child attributes
Show child attributes
Record type (always company for this endpoint)
contact, company Email address
Phone number
Tax number
Website URL
Description
Industries
Employee count bucket
1-10, 11-50, 51-200, 201-500, 501-1K, 1K-5K, 5K-10K, over-10K Annual revenue bucket
under-1m, 1m-10m, 10m-50m, 50m-100m, 100m-200m, 200m-1b, over-1b Year the company was founded
LinkedIn URL
X / Twitter URL
Facebook URL
Instagram URL
Client stage ID
Client stage label
Owner user ID
CRM source ID
CRM source name
Currency code
VAT treatment (GCC)
vat_registered, vat_not_registered, gcc_vat_registered, gcc_vat_not_registered, non_gcc, dz_vat_registered, dz_vat_not_registered Profile image URL
When the company was created
When the company was last updated
When the last activity was logged
When the company was last contacted
When the company was last enriched
Custom field values as top-level cf_* keys (for example cf_industry). There is no customFields wrapper.