Get a supplier
curl --request GET \
--url https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/suppliers/{supplierId} \
--header 'x-api-key: <x-api-key>'import requests
url = "https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/suppliers/{supplierId}"
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/{supplierId}', 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/{supplierId}",
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/{supplierId}"
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/{supplierId}")
.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/{supplierId}")
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{
"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,
"metadata": {},
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}
{
"error": {
"kind": "supplier_not_found",
"message": "Supplier not found"
}
}
Suppliers
Get a supplier
Returns a single supplier with full detail including metadata.
GET
/
api
/
v1
/
public
/
vendors
/
{vendorId}
/
identity
/
suppliers
/
{supplierId}
Get a supplier
curl --request GET \
--url https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/suppliers/{supplierId} \
--header 'x-api-key: <x-api-key>'import requests
url = "https://boh.api.fire.rest/api/v1/public/vendors/{vendorId}/identity/suppliers/{supplierId}"
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/{supplierId}', 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/{supplierId}",
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/{supplierId}"
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/{supplierId}")
.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/{supplierId}")
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{
"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,
"metadata": {},
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}
{
"error": {
"kind": "supplier_not_found",
"message": "Supplier not found"
}
}
string
required
BOH API key with
catalog:read scope.string
required
Vendor UUID.
string
required
Supplier UUID.
string
Supplier UUID.
string
Account UUID.
string
Your system’s supplier identifier.
string
Short alphanumeric code.
string
Display name.
string
Contact email.
string
Contact phone.
string
Tax/fiscal identifier.
boolean
false when archived.object
Free-form extra data.
string
ISO 8601 creation timestamp.
string
ISO 8601 last-update timestamp.
{
"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,
"metadata": {},
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}
{
"error": {
"kind": "supplier_not_found",
"message": "Supplier not found"
}
}
⌘I

