Listar integrações
RegistosGET /integrations
List external integrations configured for this utility tenant
Returns the integrations registered for the tenant, newest first, with category, provider key, secret configuration reference (never the secret itself), status and last reported health. Results are cursor-paginated (default 20, maximum 100) and the q parameter matches the name case-insensitively; a negative limit returns 400. Requires the business:integrations:read permission.
Parâmetros
limitMaximum resources to return (default 20, maximum 100).
afterOpaque cursor returned by the previous page.
qResource-specific text search.
categoryReturn only integrations of this category: payment, identity, notification, smart_meter, gis, scada, document_store, accounting or erp.
um de
payment,identity,notification,smart_meter,gis,scada,document_store,accounting,erpstatusReturn only integrations in this status: active, suspended or disabled.
um de
active,suspended,disabledhealthReturn only integrations whose last reported health is unknown, healthy, degraded or unavailable.
um de
unknown,healthy,degraded,unavailable
Devolve
200 Tenant-scoped integration registrations
Mostrar atributos
dataMostrar atributos filhos
idtenant_idnamecategoryum de
payment,identity,notification,smart_meter,gis,scada,document_store,accounting,erpprovider_keyconfiguration_referenceOpaque secret/configuration reference; never a secret value.
statusum de
active,suspended,disabledhealthum de
unknown,healthy,degraded,unavailablelast_health_check_at
has_morenext_cursor
Permissões business:integrations:read · Funções: admin, operations, owner
curl -X GET "$BUSINESS_API/integrations" \
-H "Authorization: Bearer sk_test_..."
# Sem comando CLI equivalente; use cURL ou HTTP directo.
const res = await fetch("$BUSINESS_API/integrations", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/integrations",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/integrations", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"data": [
{
"id": "int_2s0jH8wLbKi9jSO5lWaRJWCPxso",
"tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
"name": "Ana Matsinhe",
"category": "payment",
"provider_key": "provider key",
"configuration_reference": "CON-2026-000142",
"status": "active",
"health": "unknown",
"last_health_check_at": "2026-11-19T09:30:00Z"
}
],
"has_more": true,
"next_cursor": "next cursor"
}