External Connectors
List external connectors
Lists every external connector registration, active and revoked: the capability, the HTTPS endpoint Parmana releases it to, the policy that governs it and the parameters forwarded.
GET
/
external-connectors
cURL
curl https://parmana-api-real.vercel.app/external-connectors \
-H "Authorization: Bearer $PARMANA_API_KEY"import { ParmanaClient } from "@parmana/sdk";
const client = new ParmanaClient({
endpoint: "https://parmana-api-real.vercel.app",
apiKey: process.env.PARMANA_API_KEY!,
});
for (const connector of await client.externalConnectors()) {
console.log(connector.capability, connector.status, connector.endpointUrl);
}import os
from parmana import ParmanaClient
client = ParmanaClient(
endpoint="https://parmana-api-real.vercel.app",
api_key=os.environ["PARMANA_API_KEY"],
)
for connector in client.list_external_connectors():
print(connector.capability, connector.status, connector.endpoint_url)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://parmana-sandbox.vercel.app/external-connectors', 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://parmana-sandbox.vercel.app/external-connectors",
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://parmana-sandbox.vercel.app/external-connectors"
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://parmana-sandbox.vercel.app/external-connectors")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://parmana-sandbox.vercel.app/external-connectors")
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{
"connectors": [
{
"registrationId": "1aa68ad8-ab5c-4beb-9ff3-7a6b1fc1ff37",
"capability": "erp:create-invoice",
"endpointUrl": "https://erp.example.com/parmana/release",
"policy": "erp-invoice",
"allowedParameters": [
"amount",
"currency",
"customerId"
],
"timeoutMs": 10000,
"status": "active",
"registeredAt": "2026-09-30T17:25:46.385Z"
}
]
}Authorizations
Caller API key issued by scripts/generate-api-key.ts. Sent as Authorization: Bearer . Verified against a stored SHA-256 hash in constant time by packages/api/src/auth/StaticKeyAuthenticator.ts. Required on every route not listed as exempt in this document's top-level description. See /api-reference/authentication.
Response
The registrations.
Response of GET /external-connectors: every registration, active and revoked.
Show child attributes
Show child attributes
⌘I
cURL
curl https://parmana-api-real.vercel.app/external-connectors \
-H "Authorization: Bearer $PARMANA_API_KEY"import { ParmanaClient } from "@parmana/sdk";
const client = new ParmanaClient({
endpoint: "https://parmana-api-real.vercel.app",
apiKey: process.env.PARMANA_API_KEY!,
});
for (const connector of await client.externalConnectors()) {
console.log(connector.capability, connector.status, connector.endpointUrl);
}import os
from parmana import ParmanaClient
client = ParmanaClient(
endpoint="https://parmana-api-real.vercel.app",
api_key=os.environ["PARMANA_API_KEY"],
)
for connector in client.list_external_connectors():
print(connector.capability, connector.status, connector.endpoint_url)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://parmana-sandbox.vercel.app/external-connectors', 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://parmana-sandbox.vercel.app/external-connectors",
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://parmana-sandbox.vercel.app/external-connectors"
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://parmana-sandbox.vercel.app/external-connectors")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://parmana-sandbox.vercel.app/external-connectors")
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{
"connectors": [
{
"registrationId": "1aa68ad8-ab5c-4beb-9ff3-7a6b1fc1ff37",
"capability": "erp:create-invoice",
"endpointUrl": "https://erp.example.com/parmana/release",
"policy": "erp-invoice",
"allowedParameters": [
"amount",
"currency",
"customerId"
],
"timeoutMs": 10000,
"status": "active",
"registeredAt": "2026-09-30T17:25:46.385Z"
}
]
}