Vendors
Get a connection's generated client surface by selection — its index at a path, its resource families, one family, one type, or its implementation files
Get a connection’s generated client surface by selection — its index at a path, its resource families, one family, one type, or its implementation files. Requires permission vendors:read.
GET
/
api
/
v3
/
vendor-connection-client-surface
Get a connection's generated client surface by selection: its index at a path, its resource families, one family, one type, or its implementation files.
curl --request GET \
--url https://api.forge.gloo.com/api/v3/vendor-connection-client-surface \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.forge.gloo.com/api/v3/vendor-connection-client-surface"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.forge.gloo.com/api/v3/vendor-connection-client-surface', 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.forge.gloo.com/api/v3/vendor-connection-client-surface",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.forge.gloo.com/api/v3/vendor-connection-client-surface"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.forge.gloo.com/api/v3/vendor-connection-client-surface")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.forge.gloo.com/api/v3/vendor-connection-client-surface")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"kind": "families",
"client": {
"vendorKey": "sage_intacct",
"connectionName": "xml",
"module": "intacct_xml",
"className": "IntacctXmlClient",
"displayName": "Sage Intacct XML",
"classDescription": "The `sage_intacct/xml` connection client.\n\nCredentials are read from the five `GLOO_CONN_SAGE_INTACCT__XML__CRED_*` env vars at construction\ntime (blueprint §2.9) — missing any of them raises `AUTH_FAILED`\nimmediately, before a `transport` is ever touched. `transport` is\nrequired explicitly (no silent default to a real network client): pass\n`HttpxTransport()` for real dispatch, or a `ReplayTransport` in tests.",
"version": "0.17.0",
"sourceDigest": "483ad9bca9cde657edb77a2fe0bdbbca88bf19a74c3530372c4517e365cf0f00",
"requiredPackages": [
"httpx>=0.27",
"typing-extensions>=4.12,<5"
],
"pythonUsage": {
"clientExpression": "IntacctXmlClient(intacct_transport_from_env())",
"imports": [
"from gloo_connection_clients import IntacctXmlClient, intacct_transport_from_env"
]
},
"authoringFallbackPolicy": "raw_allowed"
},
"families": [
{
"authoringTier": "core",
"displayName": "Accounts Payable Aging Report",
"familyId": "accounts-payable-aging-report",
"provenance": {
"module": "intacct_xml",
"resource": "xml"
},
"semanticKind": "report",
"summary": "Sage Intacct XML Accounts Payable Aging Report output represents aged vendor payables for payment review.",
"useWhen": "Choose this for vendor payable aging; use the AR aging report for customer obligations instead."
},
{
"authoringTier": "core",
"displayName": "Accounts Receivable Aging Report",
"familyId": "accounts-receivable-aging-report",
"provenance": {
"module": "intacct_xml",
"resource": "xml"
},
"semanticKind": "report",
"summary": "Sage Intacct XML Accounts Receivable Aging Report output represents aged customer receivables for collection review.",
"useWhen": "Choose this for customer receivable aging; use the AP aging report for vendor obligations instead."
},
{
"authoringTier": "core",
"displayName": "General Ledger Detail Report",
"familyId": "general-ledger-detail-report",
"provenance": {
"module": "intacct_xml",
"resource": "xml"
},
"semanticKind": "report",
"summary": "Sage Intacct XML General Ledger Detail Report output represents ledger detail rows for accounting analysis.",
"useWhen": "Choose this for report-style ledger detail rather than customer or vendor aging."
}
],
"totalMatches": 3,
"truncated": false
},
"meta": {
"requestId": "req_example"
}
}{
"error": {
"code": "bad_request",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}{
"error": {
"code": "internal_error",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}Authorizations
PlatformApiKeyPersonalKey
Response
Get a connection's generated client surface by selection: its index at a path, its resource families, one family, one type, or its implementation files.
⌘I
Get a connection's generated client surface by selection: its index at a path, its resource families, one family, one type, or its implementation files.
curl --request GET \
--url https://api.forge.gloo.com/api/v3/vendor-connection-client-surface \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.forge.gloo.com/api/v3/vendor-connection-client-surface"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.forge.gloo.com/api/v3/vendor-connection-client-surface', 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.forge.gloo.com/api/v3/vendor-connection-client-surface",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.forge.gloo.com/api/v3/vendor-connection-client-surface"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.forge.gloo.com/api/v3/vendor-connection-client-surface")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.forge.gloo.com/api/v3/vendor-connection-client-surface")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"kind": "families",
"client": {
"vendorKey": "sage_intacct",
"connectionName": "xml",
"module": "intacct_xml",
"className": "IntacctXmlClient",
"displayName": "Sage Intacct XML",
"classDescription": "The `sage_intacct/xml` connection client.\n\nCredentials are read from the five `GLOO_CONN_SAGE_INTACCT__XML__CRED_*` env vars at construction\ntime (blueprint §2.9) — missing any of them raises `AUTH_FAILED`\nimmediately, before a `transport` is ever touched. `transport` is\nrequired explicitly (no silent default to a real network client): pass\n`HttpxTransport()` for real dispatch, or a `ReplayTransport` in tests.",
"version": "0.17.0",
"sourceDigest": "483ad9bca9cde657edb77a2fe0bdbbca88bf19a74c3530372c4517e365cf0f00",
"requiredPackages": [
"httpx>=0.27",
"typing-extensions>=4.12,<5"
],
"pythonUsage": {
"clientExpression": "IntacctXmlClient(intacct_transport_from_env())",
"imports": [
"from gloo_connection_clients import IntacctXmlClient, intacct_transport_from_env"
]
},
"authoringFallbackPolicy": "raw_allowed"
},
"families": [
{
"authoringTier": "core",
"displayName": "Accounts Payable Aging Report",
"familyId": "accounts-payable-aging-report",
"provenance": {
"module": "intacct_xml",
"resource": "xml"
},
"semanticKind": "report",
"summary": "Sage Intacct XML Accounts Payable Aging Report output represents aged vendor payables for payment review.",
"useWhen": "Choose this for vendor payable aging; use the AR aging report for customer obligations instead."
},
{
"authoringTier": "core",
"displayName": "Accounts Receivable Aging Report",
"familyId": "accounts-receivable-aging-report",
"provenance": {
"module": "intacct_xml",
"resource": "xml"
},
"semanticKind": "report",
"summary": "Sage Intacct XML Accounts Receivable Aging Report output represents aged customer receivables for collection review.",
"useWhen": "Choose this for customer receivable aging; use the AP aging report for vendor obligations instead."
},
{
"authoringTier": "core",
"displayName": "General Ledger Detail Report",
"familyId": "general-ledger-detail-report",
"provenance": {
"module": "intacct_xml",
"resource": "xml"
},
"semanticKind": "report",
"summary": "Sage Intacct XML General Ledger Detail Report output represents ledger detail rows for accounting analysis.",
"useWhen": "Choose this for report-style ledger detail rather than customer or vendor aging."
}
],
"totalMatches": 3,
"truncated": false
},
"meta": {
"requestId": "req_example"
}
}{
"error": {
"code": "bad_request",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}{
"error": {
"code": "internal_error",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}
