List quotations
curl --request GET \
--url https://api.heffl.com/api/v2/quotations \
--header 'x-api-key: <api-key>'import requests
url = "https://api.heffl.com/api/v2/quotations"
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/quotations', 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/quotations",
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/quotations"
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/quotations")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heffl.com/api/v2/quotations")
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{
"data": [
{
"id": "<string>",
"number": "<string>",
"date": "2023-11-07T05:31:56Z",
"status": "DRAFT",
"currency": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"subject": "<string>",
"expiryDate": "2023-11-07T05:31:56Z",
"conversionRate": 123,
"isInclusiveTax": true,
"clientId": "<string>",
"contactId": "<string>",
"dealId": "<string>",
"salesPersonId": "<string>",
"templateId": "<string>",
"contentHtml": "<string>",
"internalNotes": "<string>",
"totalAmount": 123,
"subtotalAmount": 123,
"totalTaxAmount": 123,
"totalDiscountAmount": 123,
"tagIds": [
"<string>"
],
"lineItems": [
{
"name": "<string>",
"quantity": 123,
"price": 123,
"productId": "<string>",
"description": "<string>",
"tax": 123,
"taxRateId": "<string>",
"discount": 123,
"discountType": "fixed",
"viewType": "LINE_ITEM",
"scope": "<string>"
}
],
"markedAcceptedOn": "2023-11-07T05:31:56Z",
"markedRejectedOn": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"meta": {
"hasMore": true,
"nextCursor": "<string>"
}
}{
"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": {}
}
}Quotations
List quotations
Returns a paginated list of quotations. Supports cursor pagination, full-text search, structured filters (status, client, sales person, tags, dates), and sorting. Results respect the API key user’s ownership permissions. See the Listing & filters guide for filter syntax.
GET
/
quotations
List quotations
curl --request GET \
--url https://api.heffl.com/api/v2/quotations \
--header 'x-api-key: <api-key>'import requests
url = "https://api.heffl.com/api/v2/quotations"
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/quotations', 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/quotations",
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/quotations"
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/quotations")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heffl.com/api/v2/quotations")
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{
"data": [
{
"id": "<string>",
"number": "<string>",
"date": "2023-11-07T05:31:56Z",
"status": "DRAFT",
"currency": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"subject": "<string>",
"expiryDate": "2023-11-07T05:31:56Z",
"conversionRate": 123,
"isInclusiveTax": true,
"clientId": "<string>",
"contactId": "<string>",
"dealId": "<string>",
"salesPersonId": "<string>",
"templateId": "<string>",
"contentHtml": "<string>",
"internalNotes": "<string>",
"totalAmount": 123,
"subtotalAmount": 123,
"totalTaxAmount": 123,
"totalDiscountAmount": 123,
"tagIds": [
"<string>"
],
"lineItems": [
{
"name": "<string>",
"quantity": 123,
"price": 123,
"productId": "<string>",
"description": "<string>",
"tax": 123,
"taxRateId": "<string>",
"discount": 123,
"discountType": "fixed",
"viewType": "LINE_ITEM",
"scope": "<string>"
}
],
"markedAcceptedOn": "2023-11-07T05:31:56Z",
"markedRejectedOn": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"meta": {
"hasMore": true,
"nextCursor": "<string>"
}
}{
"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
Query Parameters
Cursor for pagination. Pass the previous response meta.nextCursor value to fetch the next page.
Number of items to return per page (max 100)
Required range:
1 <= x <= 100Search by number, subject, client name, or line item text
Field to sort results by
Available options:
createdAt, date, number, expiryDate Sort direction
Available options:
asc, desc Structured filters (status, clientId, salesPersonId, tagId, productId, templateId, dealId, dates). Option values use prefixed string IDs. See the Listing & filters guide.