Get a company
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": {}
}
}Companies
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.
GET
/
companies
/
{id}
Get a company
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
Response
OK
A company with its billing address, tags, owner and contacts. Returned by get, create and update.