List suppliers
curl --request GET \
--url https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/suppliers \
--header 'x-api-key: <x-api-key>'import requests
url = "https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/suppliers"
headers = {"x-api-key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
fetch('https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/suppliers', 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://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/suppliers",
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: <x-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://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/suppliers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<x-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://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/suppliers")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/suppliers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "sup_01j5k...",
"account_id": "acc_01j5k...",
"external_supplier_id": "SUP-001",
"code": "BEST-FOODS",
"name": "Best Foods Co.",
"email": "orders@bestfoods.com",
"phone": "+1-555-000-0001",
"tax_id": "12-3456789",
"is_active": true,
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}
],
"total": 1,
"limit": 50,
"offset": 0
}
Suppliers
List suppliers
Returns all suppliers for a vendor. Suppliers are referenced in goods receipts and purchase orders.
GET
/
api
/
v1
/
public
/
vendors
/
{vendorId}
/
identity
/
suppliers
List suppliers
curl --request GET \
--url https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/suppliers \
--header 'x-api-key: <x-api-key>'import requests
url = "https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/suppliers"
headers = {"x-api-key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
fetch('https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/suppliers', 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://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/suppliers",
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: <x-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://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/suppliers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<x-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://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/suppliers")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/suppliers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "sup_01j5k...",
"account_id": "acc_01j5k...",
"external_supplier_id": "SUP-001",
"code": "BEST-FOODS",
"name": "Best Foods Co.",
"email": "orders@bestfoods.com",
"phone": "+1-555-000-0001",
"tax_id": "12-3456789",
"is_active": true,
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}
],
"total": 1,
"limit": 50,
"offset": 0
}
string
required
BOH API key with
catalog:read scope.string
required
Vendor UUID.
number
Results per page (1–200, default 50).
number
Pagination offset (default 0).
boolean
Include archived suppliers. Default
false.object[]
Array of supplier objects:
id, account_id, external_supplier_id, code, name, email, phone, tax_id, is_active, created_at, updated_at.{
"items": [
{
"id": "sup_01j5k...",
"account_id": "acc_01j5k...",
"external_supplier_id": "SUP-001",
"code": "BEST-FOODS",
"name": "Best Foods Co.",
"email": "orders@bestfoods.com",
"phone": "+1-555-000-0001",
"tax_id": "12-3456789",
"is_active": true,
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}
],
"total": 1,
"limit": 50,
"offset": 0
}
⌘I